Header Header

gxProperty Class Reference

Inheritance diagram for gxProperty:

gxHandle gxHANDLE gxPropertyFile

List of all members.

Detailed Description

Base class for the GX property functions.


Public Member Functions

 gxProperty () throw (gxError)
 Class initialization.
 gxProperty (int groupcode) throw (gxError)
 Class initialization with property group.
 gxProperty (const wchar_t *modname) throw (gxError)
 Class initialization with the name of the module (Unicode version).
 gxProperty (const char *modname) throw (gxError)
 Class initialization with the name of the module (ASCII version).
 gxProperty (gxInStr modname) throw (gxError)
 Class initialization with the name of the module (Unicode version).
 gxProperty (gxInAStr modname) throw (gxError)
 Class initialization with the name of the module (ASCII version).
bool Load (const wchar_t *name) throw (gxError)
 Loads properties from a specified file (Unicode version).
bool Load (const char *name) throw (gxError)
 Loads properties from a specified file (ASCII version).
bool Load (gxInStr name) throw (gxError)
 Loads properties from a specified file (Unicode version).
bool Load (gxInAStr name) throw (gxError)
 Loads properties from a specified file (ASCII version).
bool Save (const wchar_t *name, bool unicode=false) throw (gxError)
 Saves properties into a specified file (Unicode version).
bool Save (const char *name, bool unicode=false) throw (gxError)
 Saves properties into a specified file (ASCII version).
bool Save (gxInStr name, bool unicode) throw (gxError)
 Saves properties into a specified file (Unicode version).
bool Save (gxInStr name) throw (gxError)
 Saves properties into a specified file in ASCII format.
bool Save (gxInAStr name, bool unicode) throw (gxError)
 Saves properties into a specified file in ASCII format.
bool Save (gxInAStr name) throw (gxError)
 Saves properties into a specified file in ASCII format.
bool Flush (void) throw (gxError)
 Forces a write of all buffered data.
bool GetProperty (const wchar_t *name, wchar_t *string, int maxlen) throw (gxError)
 Gets the value of the specified property (Unicode version).
std::wstring GetProperty (const wchar_t *name) throw (gxError)
 Gets the value of the specified property (Unicode version).
bool GetProperty (const char *name, char *string, int maxlen) throw (gxError)
 Gets the value of the specified property (ASCII version).
std::string GetProperty (const char *name) throw (gxError)
 Gets the value of the specified property (ASCII version).
gxOutStr GetProperty (gxInStr name) throw (gxError)
 Gets the value of the specified property (Unicode version).
gxOutAStr GetProperty (gxInAStr name) throw (gxError)
 Gets the value of the specified property (ASCII version).
bool GetProperty (const wchar_t *name, int *ivalue) throw (gxError)
 Gets the integer value of the specified property (Unicode version).
bool GetProperty (const char *name, int *ivalue) throw (gxError)
 Gets the integer value of the specified property (ASCII version).
int GetPropertyInt (gxInStr name) throw (gxError)
 Gets the integer value of the specified property (Unicode version).
int GetPropertyInt (gxInAStr name) throw (gxError)
 Gets the integer value of the specified property (ASCII version).
bool GetProperty (const wchar_t *name, double *fvalue) throw (gxError)
 Gets the floating-point value of the specified property (Unicode version).
bool GetProperty (const char *name, double *fvalue) throw (gxError)
 Gets the floating-point value of the specified property (ASCII version).
double GetPropertyFloat (gxInStr name) throw (gxError)
 Gets the floating-point value of the specified property (Unicode version).
double GetPropertyFloat (gxInAStr name) throw (gxError)
 Gets the floating-point value of the specified property (ASCII version).
bool SetProperty (const wchar_t *name, const wchar_t *string) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).
bool SetProperty (const char *name, const char *string) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).
bool ClearProperty (const wchar_t *name) throw (gxError)
 Removes the value of the property in the property tree (Unicode version).
bool ClearProperty (const char *name) throw (gxError)
 Removes the value of the property in the property tree (ASCII version).
bool SetProperty (gxInStr name, gxInStr str) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).
bool SetProperty (gxInStr name) throw (gxError)
 Creates a property with the specified name in the property tree with no value (Unicode version).
bool ClearProperty (gxInStr name) throw (gxError)
 Removes the value of the property in the property tree (Unicode version).
bool SetProperty (gxInAStr name, gxInAStr str) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).
bool SetProperty (gxInAStr name) throw (gxError)
 Creates a property with the specified name in the property tree with no value (ASCII version).
bool ClearProperty (gxInAStr name) throw (gxError)
 Removes the value of the property in the property tree (ASCII version).
bool SetProperty (const wchar_t *name, int ivalue) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).
bool SetProperty (const char *name, int ivalue) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).
bool SetProperty (gxInStr name, int ivalue) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).
bool SetProperty (gxInAStr name, int ivalue) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).
bool SetProperty (const wchar_t *name, double fvalue) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).
bool SetProperty (const char *name, double fvalue) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).
bool SetProperty (gxInStr name, double fvalue) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).
bool SetProperty (gxInAStr name, double fvalue) throw (gxError)
 Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).
bool GetPropertyType (const wchar_t *name, int *type) throw (gxError)
 Gets the type of a specified property (Unicode version).
bool GetPropertyType (const char *name, int *type) throw (gxError)
 Gets the type of a specified property (ASCII version).
int GetPropertyType (const wchar_t *name) throw (gxError)
 Gets the type of a specified property (Unicode version).
int GetPropertyType (const char *name) throw (gxError)
 Gets the type of a specified property (ASCII version).
int GetPropertyType (gxInStr name) throw (gxError)
 Gets the type of a specified property (Unicode version).
int GetPropertyType (gxInAStr name) throw (gxError)
 Gets the type of a specified property (ASCII version).
bool RmProperties (const wchar_t *name) throw (gxError)
 Removes a property and its subproperties from the specified place in the property tree (Unicode version).
bool RmProperties (const char *name) throw (gxError)
 Removes a property and its subproperties from the specified place in the property tree (ASCII version).
bool RmProperties (gxInStr name) throw (gxError)
 Removes a property and its subproperties from the specified place in the property tree (Unicode version).
bool RmProperties (gxInAStr name) throw (gxError)
 Removes a property and its subproperties from the specified place in the property tree (ASCII version).
bool GetProperties (const wchar_t *name, wchar_t *string, int maxlen) throw (gxError)
 Gets the subproperties of a specified property from the property tree (Unicode version).
bool GetProperties (const char *name, char *string, int maxlen) throw (gxError)
 Gets the subproperties of a specified property from the property tree (ASCII version).
std::vector< std::wstring > GetProperties (const wchar_t *name) throw (gxError)
 Gets the subproperties of a specified property from the property tree.
std::vector< std::string > GetProperties (const char *name) throw (gxError)
 Gets the subproperties of a specified property from the property tree.
gxOutStrArray GetProperties (gxInStr name) throw (gxError)
 Gets the subproperties of a specified property from the property tree.
gxOutAStrArray GetProperties (gxInAStr name) throw (gxError)
 Gets the subproperties of a specified property from the property tree.
bool GetAllProperties (const wchar_t *name, wchar_t *string, int maxlen) throw (gxError)
 Gets the subproperties and parents of a specified property from the property tree and from the /default subtree (Unicode version).
bool GetAllProperties (const char *name, char *string, int maxlen) throw (gxError)
 Gets the subproperties and parents of a specified property from the property tree and from the /default subtree (ASCII version).
std::vector< std::wstring > GetAllProperties (const wchar_t *name) throw (gxError)
 Gets the subproperties and parents of a specified property from the property tree and from the /default subtree (Unicode version).
std::vector< std::string > GetAllProperties (const char *name) throw (gxError)
 Gets the subproperties and parents of a specified property from the property tree and from the /default subtree (ASCII version).
gxOutStrArray GetAllProperties (gxInStr name) throw (gxError)
 Gets the subproperties and parents of a specified property from the property tree and from the /default subtree.
gxOutAStrArray GetAllProperties (gxInAStr name) throw (gxError)
 Gets the subproperties and parents of a specified property from the property tree and from the /default subtree.
bool SetPropertyParent (const wchar_t *name, const wchar_t *string) throw (gxError)
 Changes the parent of a specified property (Unicode version).
bool SetPropertyParent (const char *name, const char *string) throw (gxError)
 Changes the parent of a specified property (ASCII version).
bool SetPropertyParent (gxInStr name, gxInStr str) throw (gxError)
 Changes the parent of a specified property (Unicode version).
bool SetPropertyParent (gxInAStr name, gxInAStr str) throw (gxError)
 Changes the parent of a specified property (ASCII version).
bool GetPropertyParent (const wchar_t *name, wchar_t *string, int maxlen) throw (gxError)
 Gets the parent of a specified property (Unicode version).
std::wstring GetPropertyParent (const wchar_t *name) throw (gxError)
 Gets the parent of a specified property (Unicode version).
bool GetPropertyParent (const char *name, char *string, int maxlen) throw (gxError)
 Gets the parent of a specified property (ASCII version).
std::string GetPropertyParent (const char *name) throw (gxError)
 Gets the parent of a specified property (ASCII version).
gxOutStr GetPropertyParent (gxInStr name) throw (gxError)
 Gets the parent of a specified property (Unicode version).
gxOutAStr GetPropertyParent (gxInAStr name) throw (gxError)
 Gets the parent of a specified property (ASCII version).
bool ClearPropertyParent (const wchar_t *name) throw (gxError)
 Removes the parent link of a specified property (Unicode version).
bool ClearPropertyParent (const char *name) throw (gxError)
 Removes the parent link of a specified property (ASCII version).
bool ClearPropertyParent (gxInStr name) throw (gxError)
 Removes the parent link of a specified property (Unicode version).
bool ClearPropertyParent (gxInAStr name) throw (gxError)
 Removes the parent link of a specified property (ASCII version).
bool GetModuleProperty (const wchar_t *name, wchar_t *string, int maxlen) throw (gxError)
 Gets a property of the specified module (Unicode version).
std::wstring GetModuleProperty (const wchar_t *name) throw (gxError)
 Gets a property of the specified module (Unicode version).
bool GetModuleProperty (const char *name, char *string, int maxlen) throw (gxError)
 Gets a property of the specified module (ASCII version).
std::string GetModuleProperty (const char *name) throw (gxError)
 Gets a property of the specified module (Unicode version).
gxOutStr GetModuleProperty (gxInStr name) throw (gxError)
 Gets a property of the specified module (Unicode version).
gxOutAStr GetModuleProperty (gxInAStr name) throw (gxError)
 Gets a property of the specified module (ASCII version).
bool GetModuleProperty (const wchar_t *name, int *ivalue) throw (gxError)
 Gets an integer property of the specified module (Unicode version).
int GetModulePropertyInt (const wchar_t *name) throw (gxError)
 Gets an integer property of the specified module (Unicode version).
bool GetModuleProperty (const char *name, int *ivalue) throw (gxError)
 Gets an integer property of the specified module (ASCII version).
int GetModulePropertyInt (const char *name) throw (gxError)
 Gets an integer property of the specified module (ASCII version).
int GetModulePropertyInt (gxInStr name) throw (gxError)
 Gets an integer property of the specified module (Unicode version).
int GetModulePropertyInt (gxInAStr name) throw (gxError)
 Gets an integer property of the specified module (ASCII version).
bool GetModuleProperty (const wchar_t *name, double *fvalue) throw (gxError)
 Gets a floating-point property of the specified module (Unicode version).
double GetModulePropertyFloat (const wchar_t *name) throw (gxError)
 Gets a floating-point property of the specified module (Unicode version).
bool GetModuleProperty (const char *name, double *fvalue) throw (gxError)
 Gets a floating-point property of the specified module (ASCII version).
double GetModulePropertyFloat (const char *name) throw (gxError)
 Gets a floating-point property of the specified module (ASCII version).
double GetModulePropertyFloat (gxInStr name) throw (gxError)
 Gets a floating-point property of the specified module (Unicode version).
double GetModulePropertyFloat (gxInAStr name) throw (gxError)
 Gets a floating-point property of the specified module (ASCII version).
bool SetModuleProperty (const wchar_t *name, const wchar_t *string) throw (gxError)
 Sets a property of the specified module (Unicode version).
bool SetModuleProperty (const char *name, const char *string) throw (gxError)
 Sets a property of the specified module (ASCII version).
bool SetModuleProperty (gxInStr name, gxInStr str) throw (gxError)
 Sets a property of the specified module (Unicode version).
bool SetModuleProperty (gxInAStr name, gxInAStr str) throw (gxError)
 Sets a property of the specified module (ASCII version).
bool SetModuleProperty (const wchar_t *name, int ivalue) throw (gxError)
 Sets an integer property of the specified module (Unicode version).
bool SetModuleProperty (const char *name, int ivalue) throw (gxError)
 Sets an integer property of the specified module (ASCII version).
bool SetModuleProperty (gxInStr name, int ivalue) throw (gxError)
 Sets an integer property of the specified module (Unicode version).
bool SetModuleProperty (gxInAStr name, int ivalue) throw (gxError)
 Sets an integer property of the specified module (ASCII version).
bool SetModuleProperty (const wchar_t *name, double fvalue) throw (gxError)
 Sets a floating-point property of the specified module (Unicode version).
bool SetModuleProperty (const char *name, double fvalue) throw (gxError)
 Sets a floating-point property of the specified module (ASCII version).
bool SetModuleProperty (gxInStr name, double fvalue) throw (gxError)
 Sets a floating-point property of the specified module (Unicode version).
bool SetModuleProperty (gxInAStr name, double fvalue) throw (gxError)
 Sets a floating-point property of the specified module (ASCII version).
void Dispose (void)
 It disposes the class.
bool Open (const wchar_t *modulename, const wchar_t *groupname=(const wchar_t *) 0) throw (gxError)
 Opens a GX system compatible module (Unicode version).
bool Open (const char *modulename, const char *groupname=(const char *) 0) throw (gxError)
 Opens a GX system compatible module (ASCII version).
bool Open (gxInStr modulename, gxInStr groupname) throw (gxError)
 Opens a GX system compatible module (Unicode version).
bool Open (gxInStr modulename) throw (gxError)
 Opens a GX system compatible module with the default properties (Unicode version).
bool Open (gxInAStr modulename, gxInAStr groupname) throw (gxError)
 Opens a GX system compatible module (ASCII version).
bool Open (gxInAStr modulename) throw (gxError)
 Opens a GX system compatible module with the default properties (ASCII version).
bool Close (void) throw (gxError)
 Closes a previously opened module.
bool IsValid (void) const
 Checks if the handle of the module is valid.
bool GetInfo (const gxMODULEINFO **moduleinfo) throw (gxError)
 Gives information about an opened module.
bool Call (int callcode, void *params)
 Calls a process of the module with its parameters.
int GetPropertyInt (const wchar_t *name) throw (gxError)
 Gets an integer property of the specified module (Unicode version).
int GetPropertyInt (const char *name) throw (gxError)
 Gets an integer property of the specified module (ASCII version).
double GetPropertyFloat (const wchar_t *name) throw (gxError)
 Gets a floating-point property of the specified module (Unicode version).
double GetPropertyFloat (const char *name) throw (gxError)
 Gets a floating-point property of the specified module (ASCII version).
bool GetPropertyVersion (const wchar_t *name, unsigned int *version) throw (gxError)
 Gets a version property of the specified module (Unicode version).
unsigned int GetPropertyVersion (const wchar_t *name) throw (gxError)
 Gets a version property of the specified module (Unicode version).
unsigned int GetPropertyVersion (gxInStr name) throw (gxError)
 Gets a version property of the specified module (Unicode version).
bool GetPropertyVersion (const char *name, unsigned int *version) throw (gxError)
 Gets a version property of the specified module (ASCII version).
unsigned int GetPropertyVersion (const char *name) throw (gxError)
 Gets a version property of the specified module (ASCII version).
unsigned int GetPropertyVersion (gxInAStr name) throw (gxError)
 Gets a version property of the specified module (ASCII version).
bool SaveProperties (const wchar_t *name, int level=0) throw (gxError)
 Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool SaveProperties (const char *name, int level=0) throw (gxError)
 Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool SaveProperties (gxInStr name, int level) throw (gxError)
 Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool SaveProperties (gxInStr name) throw (gxError)
 Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool SaveProperties (gxInAStr name, int level=0) throw (gxError)
 Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool MPStartTransaction (void)
 It starts the property transaction.
bool MPCommit (void)
 It ends the property transaction and updates your changes to module.

Public Attributes

gxu32 handle
 Handle of the module.

Constructor & Destructor Documentation

gxProperty (  )  throw (gxError) [inline]

Class initialization.

References gx_openmodule().

gxProperty ( int  groupcode  )  throw (gxError) [inline]

Class initialization with property group.

Note:
Do not use this directly. We recommend, to use the gxPropertyFile class instead.
Parameters:
groupcode The code of the call-group.

gxProperty ( const wchar_t *  modname  )  throw (gxError) [inline]

Class initialization with the name of the module (Unicode version).

Parameters:
modname Name of the module.

References gx_openmodule().

gxProperty ( const char *  modname  )  throw (gxError) [inline]

Class initialization with the name of the module (ASCII version).

Parameters:
modname Name of the module.

References gx_openmodulea().

gxProperty ( gxInStr  modname  )  throw (gxError) [inline]

Class initialization with the name of the module (Unicode version).

Parameters:
modname Name of the module.

References gx_openmodule().

gxProperty ( gxInAStr  modname  )  throw (gxError) [inline]

Class initialization with the name of the module (ASCII version).

Parameters:
modname Name of the module.

References gx_openmodulea().

Member Function Documentation

bool Load ( const wchar_t *  name  )  throw (gxError) [inline]

Loads properties from a specified file (Unicode version).

Parameters:
name Name of the property file.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_loadproperties().

bool Load ( const char *  name  )  throw (gxError) [inline]

Loads properties from a specified file (ASCII version).

Parameters:
name Name of the property file.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_loadproperties().

bool Load ( gxInStr  name  )  throw (gxError) [inline]

Loads properties from a specified file (Unicode version).

Parameters:
name Name of the property file.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_loadproperties().

bool Load ( gxInAStr  name  )  throw (gxError) [inline]

Loads properties from a specified file (ASCII version).

Parameters:
name Name of the property file.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_loadpropertiesa().

bool Save ( const wchar_t *  name,
bool  unicode = false 
) throw (gxError) [inline]

Saves properties into a specified file (Unicode version).

Parameters:
name Name of the property file.
unicode If it is true, the file will be unicode.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_saveproperties().

bool Save ( const char *  name,
bool  unicode = false 
) throw (gxError) [inline]

Saves properties into a specified file (ASCII version).

Parameters:
name Name of the property file.
unicode If it is true, the file will be unicode.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_saveproperties().

bool Save ( gxInStr  name,
bool  unicode 
) throw (gxError) [inline]

Saves properties into a specified file (Unicode version).

Parameters:
name Name of the property file.
unicode If it is true, the file will be unicode.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_saveproperties().

bool Save ( gxInStr  name  )  throw (gxError) [inline]

Saves properties into a specified file in ASCII format.

Parameters:
name Name of the property file.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_saveproperties().

bool Save ( gxInAStr  name,
bool  unicode 
) throw (gxError) [inline]

Saves properties into a specified file in ASCII format.

Parameters:
name Name of the property file.
unicode If it is true, the file will be unicode.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_saveproperties().

bool Save ( gxInAStr  name  )  throw (gxError) [inline]

Saves properties into a specified file in ASCII format.

Parameters:
name Name of the property file.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_savepropertiesa().

bool Flush ( void   )  throw (gxError) [inline]

Forces a write of all buffered data.

Returns:
An exception is thrown or false is returned if an error occurs.

References gx_flushproperties().

bool GetProperty ( const wchar_t *  name,
wchar_t *  string,
int  maxlen 
) throw (gxError) [inline]

Gets the value of the specified property (Unicode version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
string Pointer to a memory area where to store the value.
maxlen Size of the memory area in characters (not bytes).
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getproperty().

std::wstring GetProperty ( const wchar_t *  name  )  throw (gxError) [inline]

Gets the value of the specified property (Unicode version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
Returns:
Value of the property. An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getproperty().

bool GetProperty ( const char *  name,
char *  string,
int  maxlen 
) throw (gxError) [inline]

Gets the value of the specified property (ASCII version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
string Pointer to a memory area where to store the value.
maxlen Size of the memory area in characters (or bytes).
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getproperty().

std::string GetProperty ( const char *  name  )  throw (gxError) [inline]

Gets the value of the specified property (ASCII version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
Returns:
Value of the property. An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getproperty().

gxOutStr GetProperty ( gxInStr  name  )  throw (gxError) [inline]

Gets the value of the specified property (Unicode version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
Returns:
The value of the property. An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getproperty().

gxOutAStr GetProperty ( gxInAStr  name  )  throw (gxError) [inline]

Gets the value of the specified property (ASCII version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
Returns:
The value of the property. An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getpropertya().

bool GetProperty ( const wchar_t *  name,
int *  ivalue 
) throw (gxError) [inline]

Gets the integer value of the specified property (Unicode version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
ivalue Pointer to a memory area where to store the integer value.
Returns:
On success: non-zero ( see gx_geterror() )

Reimplemented from gxHandle.

References gx_getpropertyint().

bool GetProperty ( const char *  name,
int *  ivalue 
) throw (gxError) [inline]

Gets the integer value of the specified property (ASCII version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
ivalue Pointer to a memory area where to store the integer value.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getpropertyinta().

int GetPropertyInt ( gxInStr  name  )  throw (gxError) [inline]

Gets the integer value of the specified property (Unicode version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
Returns:
The integer value of the property. An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getpropertyint().

int GetPropertyInt ( gxInAStr  name  )  throw (gxError) [inline]

Gets the integer value of the specified property (ASCII version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
Returns:
The integer value of the property. An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getpropertyinta().

bool GetProperty ( const wchar_t *  name,
double *  fvalue 
) throw (gxError) [inline]

Gets the floating-point value of the specified property (Unicode version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
fvalue Pointer to a memory area where to store the floating-point value.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getpropertyfloat().

bool GetProperty ( const char *  name,
double *  fvalue 
) throw (gxError) [inline]

Gets the floating-point value of the specified property (ASCII version).

If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.

Parameters:
name Name of the property and place in the property tree.
fvalue Pointer to a memory area where to store the floating-point value.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getpropertyfloata().

double GetPropertyFloat ( gxInStr  name  )  throw (gxError) [inline]

Gets the floating-point value of the specified property (Unicode version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
Returns:
The floating-point value of the property. An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getpropertyfloat().

double GetPropertyFloat ( gxInAStr  name  )  throw (gxError) [inline]

Gets the floating-point value of the specified property (ASCII version).

Note:
If there is no such property in the property tree, it tries to return the value from the inherited path or the /default path of the tree.
Parameters:
name Name of the property and place in the property tree.
Returns:
The floating-point value of the property. An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_getpropertyfloata().

bool SetProperty ( const wchar_t *  name,
const wchar_t *  string 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).

Note:
If the property exists it changes the value.
Parameters:
name Name of the property and place in the property tree.
string Value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_setproperty().

bool SetProperty ( const char *  name,
const char *  string 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).

Note:
If the property exists it changes the value.
Parameters:
name Name of the property and place in the property tree.
string Value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_setpropertya().

bool ClearProperty ( const wchar_t *  name  )  throw (gxError) [inline]

Removes the value of the property in the property tree (Unicode version).

Note:
If the property does not exist it creates a new with no value.
Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setproperty().

bool ClearProperty ( const char *  name  )  throw (gxError) [inline]

Removes the value of the property in the property tree (ASCII version).

Note:
If the property does not exist it creates a new with no value.
Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setpropertya().

bool SetProperty ( gxInStr  name,
gxInStr  str 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).

Note:
If the property exists it changes the value.
Parameters:
name Name of the property and place in the property tree.
str Value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_setproperty().

bool SetProperty ( gxInStr  name  )  throw (gxError) [inline]

Creates a property with the specified name in the property tree with no value (Unicode version).

Note:
If the property exists it removes the value.
Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setproperty().

bool ClearProperty ( gxInStr  name  )  throw (gxError) [inline]

Removes the value of the property in the property tree (Unicode version).

Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setproperty().

bool SetProperty ( gxInAStr  name,
gxInAStr  str 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).

Note:
If the property exists it changes the value.
Parameters:
name Name of the property and place in the property tree.
str Value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_setpropertya().

bool SetProperty ( gxInAStr  name  )  throw (gxError) [inline]

Creates a property with the specified name in the property tree with no value (ASCII version).

Note:
If the property exists it removes the value.
Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setpropertya().

bool ClearProperty ( gxInAStr  name  )  throw (gxError) [inline]

Removes the value of the property in the property tree (ASCII version).

Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setpropertya().

bool SetProperty ( const wchar_t *  name,
int  ivalue 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).

Note:
If the property exists it changes the value. The integer value is converted to string and then written to the tree.
Parameters:
name Name of the property and place in the property tree.
ivalue Integer value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_setpropertyint().

bool SetProperty ( const char *  name,
int  ivalue 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).

Note:
If the property exists it changes the value. The integer value is converted to string and then written to the tree.
Parameters:
name Name of the property and place in the property tree.
ivalue Integer value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_setpropertyinta().

bool SetProperty ( gxInStr  name,
int  ivalue 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).

Note:
If the property exists it changes the value. The integer value is converted to string and then written to the tree.
Parameters:
name Name of the property and place in the property tree.
ivalue Integer value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_setpropertyint().

bool SetProperty ( gxInAStr  name,
int  ivalue 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).

Note:
If the property exists it changes the value. The integer value is converted to string and then written to the tree.
Parameters:
name Name of the property and place in the property tree.
ivalue Integer value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_setpropertyinta().

bool SetProperty ( const wchar_t *  name,
double  fvalue 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).

Note:
If the property exists it changes the value. The floating-point value is converted to string and then written to the tree.
Parameters:
name Name of the property and place in the property tree.
fvalue Floating-point value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_setpropertyfloat().

bool SetProperty ( const char *  name,
double  fvalue 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).

Note:
If the property exists it changes the value. The floating-point value is converted to string and then written to the tree.
Parameters:
name Name of the property and place in the property tree.
fvalue Floating-point value of the property.
Returns:
On success: non-zero ( see gx_geterror() )

Reimplemented from gxHandle.

References gx_setproperty().

bool SetProperty ( gxInStr  name,
double  fvalue 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).

Note:
If the property exists it changes the value. The floating-point value is converted to string and then written to the tree.
Parameters:
name Name of the property and place in the property tree.
fvalue Floating-point value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_setpropertyfloat().

bool SetProperty ( gxInAStr  name,
double  fvalue 
) throw (gxError) [inline]

Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).

Note:
If the property exists it changes the value. The floating-point value is converted to string and then written to the tree.
Parameters:
name Name of the property and place in the property tree.
fvalue Floating-point value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

Reimplemented from gxHandle.

References gx_setpropertyfloata().

bool GetPropertyType ( const wchar_t *  name,
int *  type 
) throw (gxError) [inline]

Gets the type of a specified property (Unicode version).

Parameters:
name Name of the property and place in the property tree.
type Pointer to a memory area where to store the property type (see GX_PROPERTYTYPES).
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getpropertytype().

bool GetPropertyType ( const char *  name,
int *  type 
) throw (gxError) [inline]

Gets the type of a specified property (ASCII version).

Parameters:
name Name of the property and place in the property tree.
type Pointer to a memory area where to store the property type (see GX_PROPERTYTYPES).
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getpropertytypea().

int GetPropertyType ( const wchar_t *  name  )  throw (gxError) [inline]

Gets the type of a specified property (Unicode version).

Parameters:
name Name of the property and place in the property tree.
Returns:
Type of the property. An exception is thrown or false is returned if an error occurs.

References gx_getpropertytype().

int GetPropertyType ( const char *  name  )  throw (gxError) [inline]

Gets the type of a specified property (ASCII version).

Parameters:
name Name of the property and place in the property tree.
Returns:
Type of the property. An exception is thrown or false is returned if an error occurs.

References gx_getpropertytypea().

int GetPropertyType ( gxInStr  name  )  throw (gxError) [inline]

Gets the type of a specified property (Unicode version).

Parameters:
name Name of the property and place in the property tree.
Returns:
Type of the property. An exception is thrown or false is returned if an error occurs.

References gx_getpropertytype().

int GetPropertyType ( gxInAStr  name  )  throw (gxError) [inline]

Gets the type of a specified property (ASCII version).

Parameters:
name Name of the property and place in the property tree.
Returns:
Type of the property. An exception is thrown or false is returned if an error occurs.

References gx_getpropertytype().

bool RmProperties ( const wchar_t *  name  )  throw (gxError) [inline]

Removes a property and its subproperties from the specified place in the property tree (Unicode version).

Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_rmproperties().

bool RmProperties ( const char *  name  )  throw (gxError) [inline]

Removes a property and its subproperties from the specified place in the property tree (ASCII version).

Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_rmpropertiesa().

bool RmProperties ( gxInStr  name  )  throw (gxError) [inline]

Removes a property and its subproperties from the specified place in the property tree (Unicode version).

Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_rmproperties().

bool RmProperties ( gxInAStr  name  )  throw (gxError) [inline]

Removes a property and its subproperties from the specified place in the property tree (ASCII version).

Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_rmpropertiesa().

bool GetProperties ( const wchar_t *  name,
wchar_t *  string,
int  maxlen 
) throw (gxError) [inline]

Gets the subproperties of a specified property from the property tree (Unicode version).

Note:
The names are separated with LF.
Parameters:
name Name of the property and place in the property tree.
string Pointer to a memory area where to store the names.
maxlen Size of the memory area in characters (not bytes).
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getproperties().

bool GetProperties ( const char *  name,
char *  string,
int  maxlen 
) throw (gxError) [inline]

Gets the subproperties of a specified property from the property tree (ASCII version).

Note:
The names are separated with LF.
Parameters:
name Name of the property and place in the property tree.
string Pointer to a memory area where to store the names.
maxlen Size of the memory area in characters (or bytes).
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getpropertiesa().

std::vector<std::wstring> GetProperties ( const wchar_t *  name  )  throw (gxError) [inline]

Gets the subproperties of a specified property from the property tree.

Parameters:
name Name of the property and place in the property tree.
Returns:
The array of names. An exception is thrown or false is returned if an error occurs.

References gx_getproperties().

std::vector<std::string> GetProperties ( const char *  name  )  throw (gxError) [inline]

Gets the subproperties of a specified property from the property tree.

Parameters:
name Name of the property and place in the property tree.
Returns:
The array of names. An exception is thrown or false is returned if an error occurs.

References gx_getpropertiesa().

gxOutStrArray GetProperties ( gxInStr  name  )  throw (gxError) [inline]

Gets the subproperties of a specified property from the property tree.

Parameters:
name Name of the property and place in the property tree.
Returns:
The array of names. An exception is thrown or false is returned if an error occurs.

References gx_getproperties().

gxOutAStrArray GetProperties ( gxInAStr  name  )  throw (gxError) [inline]

Gets the subproperties of a specified property from the property tree.

Parameters:
name Name of the property and place in the property tree.
Returns:
The array of names. An exception is thrown or false is returned if an error occurs.

References gx_getpropertiesa().

bool GetAllProperties ( const wchar_t *  name,
wchar_t *  string,
int  maxlen 
) throw (gxError) [inline]

Gets the subproperties and parents of a specified property from the property tree and from the /default subtree (Unicode version).

Note:
The names are separated with LF.
Parameters:
name Name of the property and place in the property tree.
string Pointer to a memory area where to store the names.
maxlen Size of the memory area in characters (not bytes).
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getallproperties().

bool GetAllProperties ( const char *  name,
char *  string,
int  maxlen 
) throw (gxError) [inline]

Gets the subproperties and parents of a specified property from the property tree and from the /default subtree (ASCII version).

Note:
The names are separated with LF.
Parameters:
name Name of the property and place in the property tree.
string Pointer to a memory area where to store the names.
maxlen Size of the memory area in characters (or bytes).
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getallproperties().

std::vector<std::wstring> GetAllProperties ( const wchar_t *  name  )  throw (gxError) [inline]

Gets the subproperties and parents of a specified property from the property tree and from the /default subtree (Unicode version).

Parameters:
name Name of the property and place in the property tree.
Returns:
The array of names. An exception is thrown or false is returned if an error occurs.

References gx_getallproperties().

std::vector<std::string> GetAllProperties ( const char *  name  )  throw (gxError) [inline]

Gets the subproperties and parents of a specified property from the property tree and from the /default subtree (ASCII version).

Parameters:
name Name of the property and place in the property tree.
Returns:
The array of names. An exception is thrown or false is returned if an error occurs.

References gx_getallpropertiesa().

gxOutStrArray GetAllProperties ( gxInStr  name  )  throw (gxError) [inline]

Gets the subproperties and parents of a specified property from the property tree and from the /default subtree.

Parameters:
name Name of the property and place in the property tree.
Returns:
The array of names. An exception is thrown or false is returned if an error occurs.

References gx_getallproperties().

gxOutAStrArray GetAllProperties ( gxInAStr  name  )  throw (gxError) [inline]

Gets the subproperties and parents of a specified property from the property tree and from the /default subtree.

Parameters:
name Name of the property and place in the property tree.
Returns:
The array of names. An exception is thrown or false is returned if an error occurs.

References gx_getallproperties().

bool SetPropertyParent ( const wchar_t *  name,
const wchar_t *  string 
) throw (gxError) [inline]

Changes the parent of a specified property (Unicode version).

Parameters:
name Name of the property and place in the property tree.
string Parent of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setpropertyparent().

bool SetPropertyParent ( const char *  name,
const char *  string 
) throw (gxError) [inline]

Changes the parent of a specified property (ASCII version).

Parameters:
name Name of the property and place in the property tree.
string Parent of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setpropertyparent().

bool SetPropertyParent ( gxInStr  name,
gxInStr  str 
) throw (gxError) [inline]

Changes the parent of a specified property (Unicode version).

Parameters:
name Name of the property and place in the property tree.
str Parent of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setpropertyparent().

bool SetPropertyParent ( gxInAStr  name,
gxInAStr  str 
) throw (gxError) [inline]

Changes the parent of a specified property (ASCII version).

Parameters:
name Name of the property and place in the property tree.
str Parent of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setpropertyparenta().

bool GetPropertyParent ( const wchar_t *  name,
wchar_t *  string,
int  maxlen 
) throw (gxError) [inline]

Gets the parent of a specified property (Unicode version).

Parameters:
name Name of the property and place in the property tree.
string Pointer to a memory area where to store the parent of the property.
maxlen Size of the memory area in characters (not bytes).
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getpropertyparent().

std::wstring GetPropertyParent ( const wchar_t *  name  )  throw (gxError) [inline]

Gets the parent of a specified property (Unicode version).

Parameters:
name Name of the property and place in the property tree.
Returns:
Parent of the property. An exception is thrown or false is returned if an error occurs.

References gx_getpropertyparent().

bool GetPropertyParent ( const char *  name,
char *  string,
int  maxlen 
) throw (gxError) [inline]

Gets the parent of a specified property (ASCII version).

Parameters:
name Name of the property and place in the property tree.
string Pointer to a memory area where to store the parent of the property.
maxlen Size of the memory area in characters (not bytes).
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getpropertyparenta().

std::string GetPropertyParent ( const char *  name  )  throw (gxError) [inline]

Gets the parent of a specified property (ASCII version).

Parameters:
name Name of the property and place in the property tree.
Returns:
Parent of the property. An exception is thrown or false is returned if an error occurs.

References gx_getpropertyparent().

gxOutStr GetPropertyParent ( gxInStr  name  )  throw (gxError) [inline]

Gets the parent of a specified property (Unicode version).

Parameters:
name Name of the property and place in the property tree.
Returns:
Parent of the property. An exception is thrown or false is returned if an error occurs.

References gx_getpropertyparent().

gxOutAStr GetPropertyParent ( gxInAStr  name  )  throw (gxError) [inline]

Gets the parent of a specified property (ASCII version).

Parameters:
name Name of the property and place in the property tree.
Returns:
Parent of the property. An exception is thrown or false is returned if an error occurs.

References gx_getpropertyparent().

bool ClearPropertyParent ( const wchar_t *  name  )  throw (gxError) [inline]

Removes the parent link of a specified property (Unicode version).

Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setpropertyparent().

bool ClearPropertyParent ( const char *  name  )  throw (gxError) [inline]

Removes the parent link of a specified property (ASCII version).

Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setpropertyparent().

bool ClearPropertyParent ( gxInStr  name  )  throw (gxError) [inline]

Removes the parent link of a specified property (Unicode version).

Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setpropertyparent().

bool ClearPropertyParent ( gxInAStr  name  )  throw (gxError) [inline]

Removes the parent link of a specified property (ASCII version).

Parameters:
name Name of the property and place in the property tree.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setpropertyparenta().

bool GetModuleProperty ( const wchar_t *  name,
wchar_t *  string,
int  maxlen 
) throw (gxError) [inline]

Gets a property of the specified module (Unicode version).

Parameters:
name Name of the property.
string Pointer to a memory area where to store the value.
maxlen Size of memory area in characters (not bytes).
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getmoduleproperty().

std::wstring GetModuleProperty ( const wchar_t *  name  )  throw (gxError) [inline]

Gets a property of the specified module (Unicode version).

Parameters:
name Name of the property.
Returns:
Value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmoduleproperty().

bool GetModuleProperty ( const char *  name,
char *  string,
int  maxlen 
) throw (gxError) [inline]

Gets a property of the specified module (ASCII version).

Parameters:
name Name of the property.
string Pointer to a memory area where to store the value.
maxlen Size of memory area in characters (not bytes).
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getmoduleproperty().

std::string GetModuleProperty ( const char *  name  )  throw (gxError) [inline]

Gets a property of the specified module (Unicode version).

Parameters:
name Name of the property.
Returns:
Value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmoduleproperty().

gxOutStr GetModuleProperty ( gxInStr  name  )  throw (gxError) [inline]

Gets a property of the specified module (Unicode version).

Parameters:
name Name of the property.
Returns:
Value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmoduleproperty().

gxOutAStr GetModuleProperty ( gxInAStr  name  )  throw (gxError) [inline]

Gets a property of the specified module (ASCII version).

Parameters:
name Name of the property.
Returns:
Value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertya().

bool GetModuleProperty ( const wchar_t *  name,
int *  ivalue 
) throw (gxError) [inline]

Gets an integer property of the specified module (Unicode version).

Parameters:
name Name of the property.
ivalue Pointer to an integer to store the value.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyint().

int GetModulePropertyInt ( const wchar_t *  name  )  throw (gxError) [inline]

Gets an integer property of the specified module (Unicode version).

Parameters:
name Name of the property.
Returns:
Integer value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyint().

bool GetModuleProperty ( const char *  name,
int *  ivalue 
) throw (gxError) [inline]

Gets an integer property of the specified module (ASCII version).

Parameters:
name Name of the property.
ivalue Pointer to an integer to store the value.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyinta().

int GetModulePropertyInt ( const char *  name  )  throw (gxError) [inline]

Gets an integer property of the specified module (ASCII version).

Parameters:
name Name of the property.
Returns:
Integer value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyinta().

int GetModulePropertyInt ( gxInStr  name  )  throw (gxError) [inline]

Gets an integer property of the specified module (Unicode version).

Parameters:
name Name of the property.
Returns:
Integer value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyint().

int GetModulePropertyInt ( gxInAStr  name  )  throw (gxError) [inline]

Gets an integer property of the specified module (ASCII version).

Parameters:
name Name of the property.
Returns:
Integer value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyinta().

bool GetModuleProperty ( const wchar_t *  name,
double *  fvalue 
) throw (gxError) [inline]

Gets a floating-point property of the specified module (Unicode version).

Parameters:
name Name of the property.
fvalue Pointer to a floating-point to store the value.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyfloat().

double GetModulePropertyFloat ( const wchar_t *  name  )  throw (gxError) [inline]

Gets a floating-point property of the specified module (Unicode version).

Parameters:
name Name of the property.
Returns:
Floating-point value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyfloat().

bool GetModuleProperty ( const char *  name,
double *  fvalue 
) throw (gxError) [inline]

Gets a floating-point property of the specified module (ASCII version).

Parameters:
name Name of the property.
fvalue Pointer to a floating-point to store the value.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyfloata().

double GetModulePropertyFloat ( const char *  name  )  throw (gxError) [inline]

Gets a floating-point property of the specified module (ASCII version).

Parameters:
name Name of the property.
Returns:
Floating-point value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyfloata().

double GetModulePropertyFloat ( gxInStr  name  )  throw (gxError) [inline]

Gets a floating-point property of the specified module (Unicode version).

Parameters:
name Name of the property.
Returns:
Floating-point value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyfloat().

double GetModulePropertyFloat ( gxInAStr  name  )  throw (gxError) [inline]

Gets a floating-point property of the specified module (ASCII version).

Parameters:
name Name of the property.
Returns:
Floating-point value of the property. An exception is thrown or false is returned if an error occurs.

References gx_getmodulepropertyfloata().

bool SetModuleProperty ( const wchar_t *  name,
const wchar_t *  string 
) throw (gxError) [inline]

Sets a property of the specified module (Unicode version).

Parameters:
name Name of the property.
string Value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmoduleproperty().

bool SetModuleProperty ( const char *  name,
const char *  string 
) throw (gxError) [inline]

Sets a property of the specified module (ASCII version).

Parameters:
name Name of the property.
string Value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmoduleproperty().

bool SetModuleProperty ( gxInStr  name,
gxInStr  str 
) throw (gxError) [inline]

Sets a property of the specified module (Unicode version).

Parameters:
name Name of the property.
str Value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmoduleproperty().

bool SetModuleProperty ( gxInAStr  name,
gxInAStr  str 
) throw (gxError) [inline]

Sets a property of the specified module (ASCII version).

Parameters:
name Name of the property.
str Value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmoduleproperty().

bool SetModuleProperty ( const wchar_t *  name,
int  ivalue 
) throw (gxError) [inline]

Sets an integer property of the specified module (Unicode version).

Parameters:
name Name of the property.
ivalue Integer value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmodulepropertyint().

bool SetModuleProperty ( const char *  name,
int  ivalue 
) throw (gxError) [inline]

Sets an integer property of the specified module (ASCII version).

Parameters:
name Name of the property.
ivalue Integer value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmodulepropertyinta().

bool SetModuleProperty ( gxInStr  name,
int  ivalue 
) throw (gxError) [inline]

Sets an integer property of the specified module (Unicode version).

Parameters:
name Name of the property.
ivalue Integer value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmodulepropertyint().

bool SetModuleProperty ( gxInAStr  name,
int  ivalue 
) throw (gxError) [inline]

Sets an integer property of the specified module (ASCII version).

Parameters:
name Name of the property.
ivalue Integer value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmodulepropertyinta().

bool SetModuleProperty ( const wchar_t *  name,
double  fvalue 
) throw (gxError) [inline]

Sets a floating-point property of the specified module (Unicode version).

Parameters:
name Name of the property.
fvalue Floating-point value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmodulepropertyfloat().

bool SetModuleProperty ( const char *  name,
double  fvalue 
) throw (gxError) [inline]

Sets a floating-point property of the specified module (ASCII version).

Parameters:
name Name of the property.
fvalue Floating-point value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmodulepropertyfloata().

bool SetModuleProperty ( gxInStr  name,
double  fvalue 
) throw (gxError) [inline]

Sets a floating-point property of the specified module (Unicode version).

Parameters:
name Name of the property.
fvalue Floating-point value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmodulepropertyfloat().

bool SetModuleProperty ( gxInAStr  name,
double  fvalue 
) throw (gxError) [inline]

Sets a floating-point property of the specified module (ASCII version).

Parameters:
name Name of the property.
fvalue Floating-point value of the property.
Returns:
An exception is thrown or false is returned if an error occurs.

References gx_setmodulepropertyfloata().

void Dispose ( void   )  [inline, inherited]

It disposes the class.

no base class.

Reimplemented in gxImage, gxLog, and gxTrafo.

Referenced by gxTrafo::Dispose(), gxLog::Dispose(), and gxImage::Dispose().

bool Open ( const wchar_t *  modulename,
const wchar_t *  groupname = (const wchar_t *)0 
) throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:
modulename Name of the module.
groupname Property place in the property tree.
Returns:
An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open ( const char *  modulename,
const char *  groupname = (const char *)0 
) throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:
modulename Name of the module.
groupname Property place in the property tree.
Returns:
An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open ( gxInStr  modulename,
gxInStr  groupname 
) throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:
modulename Name of the module.
groupname Property place in the property tree.
Returns:
An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open ( gxInStr  modulename  )  throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (Unicode version).

Parameters:
modulename Name of the module.
Returns:
An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodule().

bool Open ( gxInAStr  modulename,
gxInAStr  groupname 
) throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:
modulename Name of the module.
groupname Property place in the property tree.
Returns:
An exception is thrown or false is returned in case of error.

References gx_openmodulea().

bool Open ( gxInAStr  modulename  )  throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (ASCII version).

Parameters:
modulename Name of the module.
Returns:
An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodulea().

bool Close ( void   )  throw (gxError) [inline, inherited]

Closes a previously opened module.

It decreases the reference counter of the handle. The function closes the module if required (in case when the reference counter becames zero).

Returns:
An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_unrefhandle(), and gxHandle::IsValid().

Referenced by gxHandle::operator=().

bool IsValid ( void   )  const [inline, inherited]

Checks if the handle of the module is valid.

Returns:
In case of existing handle the return value is true.

Reimplemented in gxImage, gxTrafo, gxGZip, and gxZip.

Referenced by gxHandle::Close(), gxHandle::gxHandle(), gxImage::gxImage(), gxTrafo::gxTrafo(), gxZip::IsValid(), gxGZip::IsValid(), gxTrafo::IsValid(), and gxImage::IsValid().

bool GetInfo ( const gxMODULEINFO **  moduleinfo  )  throw (gxError) [inline, inherited]

Gives information about an opened module.

Parameters:
moduleinfo Pointer to an information structure pointer where the system returns the data of the specified module.
Returns:
An exception is thrown or false is returned in case of error.

References gx_getmoduleinfo().

bool Call ( int  callcode,
void *  params 
) [inline, inherited]

Calls a process of the module with its parameters.

The functions and parameters usable inside the modules can be found in the documentation of the modules. The headers given with the modules contain inline functions, which make easier to access the functions of the module.

Parameters:
callcode Call code for the function (GX_CALL_xxx call codes).
params Parameters to give for the function (GX_PARM_xxx structures).
Returns:
Module defined, usually success is true.

References gx_call().

int GetPropertyInt ( const wchar_t *  name  )  throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:
name Name of the property.
Returns:
The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyint().

int GetPropertyInt ( const char *  name  )  throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:
name Name of the property.
Returns:
The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyinta().

double GetPropertyFloat ( const wchar_t *  name  )  throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:
name Name of the property.
Returns:
The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloat().

double GetPropertyFloat ( const char *  name  )  throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:
name Name of the property.
Returns:
The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloata().

bool GetPropertyVersion ( const wchar_t *  name,
unsigned int *  version 
) throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:
name Name of the property.
version Pointer to an integer where to store the version.
Returns:
An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion ( const wchar_t *  name  )  throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:
name Name of the property.
Returns:
The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion ( gxInStr  name  )  throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:
name Name of the property.
Returns:
The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

bool GetPropertyVersion ( const char *  name,
unsigned int *  version 
) throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:
name Name of the property.
version Pointer to an integer where to store the version.
Returns:
An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion ( const char *  name  )  throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:
name Name of the property.
Returns:
The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion ( gxInAStr  name  )  throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:
name Name of the property.
Returns:
The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

bool SaveProperties ( const wchar_t *  name,
int  level = 0 
) throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:
name Place of property in the tree.
level Higher numbers give more details (0 = basic properties, 100 = all properties).
Returns:
An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties ( const char *  name,
int  level = 0 
) throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:
name Place of property in the tree.
level Higher numbers give more details (0 = basic properties, 100 = all properties).
Returns:
An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties ( gxInStr  name,
int  level 
) throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:
name Place of property in the tree.
level Higher numbers give more details (0 = basic properties, 100 = all properties).
Returns:
An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties ( gxInStr  name  )  throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:
name Place of property in the tree.
Returns:
An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties ( gxInAStr  name,
int  level = 0 
) throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:
name Place of property in the tree.
level Higher numbers give more details (0 = basic properties, 100 = all properties).
Returns:
An exception is thrown or false is returned in case of error.

References gx_savemodulepropertiesa().

bool MPStartTransaction ( void   )  [inline, inherited]

It starts the property transaction.

The module accepts but doesn't update properties (setmoduleproperty). You must use 'gx_mpcommit' to update these properties.

Warning:
Not supported by each module!
Returns:
An exception is thrown or false is returned in case of error.

References gx_mpstarttransaction().

bool MPCommit ( void   )  [inline, inherited]

It ends the property transaction and updates your changes to module.

Warning:
Not supported by each module!
Returns:
An exception is thrown or false is returned in case of error.

References gx_mpcommit().

Member Data Documentation

gxu32 handle [inherited]

Handle of the module.

If it is zero, it is invalid.

See also:
gx_isvalidhandle()

Referenced by gx_closehandle(), gx_direct(), gx_isvalidhandle(), gxHandle::gxHandle(), gxImageHandler::gxImageHandler(), gxTrafoHandler::gxTrafoHandler(), and gxHandle::operator=().

Generated  for GX
(c) ARH Inc.