Header Header

Property handling


Detailed Description

Functions for property handling.


Functions

static int gx_getproperty (gxHANDLE handle, const wchar_t *name, wchar_t *string, int maxlen)
 Gets the value of the specified property (Unicode version).
static int gx_getpropertya (gxHANDLE handle, const char *name, char *string, int maxlen)
 Gets the value of the specified property (ASCII version).
static int gx_getpropertyint (gxHANDLE handle, const wchar_t *name, int *ivalue)
 Gets the integer value of the specified property (Unicode version).
static int gx_getpropertyinta (gxHANDLE handle, const char *name, int *ivalue)
 Gets the integer value of the specified property (ASCII version).
static int gx_getpropertyfloat (gxHANDLE handle, const wchar_t *name, double *fvalue)
 Gets the floating-point value of the specified property (Unicode version).
static int gx_getpropertyfloata (gxHANDLE handle, const char *name, double *fvalue)
 Gets the floating-point value of the specified property (ASCII version).
static int gx_setproperty (gxHANDLE handle, const wchar_t *name, const wchar_t *string)
 Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).
static int gx_setpropertya (gxHANDLE handle, const char *name, const char *string)
 Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).
static int gx_setpropertyint (gxHANDLE handle, const wchar_t *name, int ivalue)
 Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).
static int gx_setpropertyinta (gxHANDLE handle, const char *name, int ivalue)
 Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).
static int gx_setpropertyfloat (gxHANDLE handle, const wchar_t *name, double fvalue)
 Creates a property with the specified name in the property tree and assigns the specified value to it (Unicode version).
static int gx_setpropertyfloata (gxHANDLE handle, const char *name, double fvalue)
 Creates a property with the specified name in the property tree and assigns the specified value to it (ASCII version).
static int gx_getpropertytype (gxHANDLE handle, const wchar_t *name, int *type)
 Gets the type of the specified property (Unicode version).
static int gx_getpropertytypea (gxHANDLE handle, const char *name, int *type)
 Gets the type of the specified property (ASCII version).
static int gx_rmproperties (gxHANDLE handle, const wchar_t *name)
 Removes a property and its subproperties from the specified place in the property tree (Unicode version).
static int gx_rmpropertiesa (gxHANDLE handle, const char *name)
 Removes a property and its subproperties from the specified place in the property tree (ASCII version).
static int gx_getproperties (gxHANDLE handle, const wchar_t *name, wchar_t *string, int maxlen)
 Gets the subproperties of a specified property from the property tree (Unicode version).
static int gx_getpropertiesa (gxHANDLE handle, const char *name, char *string, int maxlen)
 Gets the subproperties of a specified property from the property tree (ASCII version).
static int gx_getallproperties (gxHANDLE handle, const wchar_t *name, wchar_t *string, int maxlen)
 Gets the subproperties and parents of a specified property from the property tree and from the /default subtree (Unicode version).
static int gx_getallpropertiesa (gxHANDLE handle, const char *name, char *string, int maxlen)
 Gets the subproperties and parents of a specified property from the property tree and from the /default subtree (ASCII version).
static int gx_setpropertyparent (gxHANDLE handle, const wchar_t *name, const wchar_t *string)
 Changes the parent of a specified property (Unicode version).
static int gx_setpropertyparenta (gxHANDLE handle, const char *name, const char *string)
 Changes the parent of a specified property (ASCII version).
static int gx_getpropertyparent (gxHANDLE handle, const wchar_t *name, wchar_t *string, int maxlen)
 Gets the parent of a specified property (Unicode version).
static int gx_getpropertyparenta (gxHANDLE handle, const char *name, char *string, int maxlen)
 Gets the parent of a specified property (ASCII version).
static int gx_loadproperties (gxHANDLE handle, const wchar_t *name)
 Loads properties from a specified file (Unicode version).
static int gx_loadpropertiesa (gxHANDLE handle, const char *name)
 Loads properties from a specified file (ASCII version).
static int gx_saveproperties (gxHANDLE handle, const wchar_t *name, int unicode)
 Saves properties into a specified file (Unicode version).
static int gx_savepropertiesa (gxHANDLE handle, const char *name, int unicode)
 Saves properties into a specified file (ASCII version).
static int gx_flushproperties (gxHANDLE handle)
 Forces writing of all buffered data.
static int gx_getmoduleproperty (gxHANDLE handle, const wchar_t *name, wchar_t *string, int maxlen)
 Gets a property of the specified module (Unicode version).
static int gx_getmodulepropertya (gxHANDLE handle, const char *name, char *string, int maxlen)
 Gets a property of the specified module (ASCII version).
static int gx_getmodulepropertyint (gxHANDLE handle, const wchar_t *name, int *ivalue)
 Gets an integer property of the specified module (Unicode version).
static int gx_getmodulepropertyinta (gxHANDLE handle, const char *name, int *ivalue)
 Gets an integer property of the specified module (ASCII version).
static int gx_getmodulepropertyfloat (gxHANDLE handle, const wchar_t *name, double *fvalue)
 Gets a floating-point property of the specified module (Unicode version).
static int gx_getmodulepropertyfloata (gxHANDLE handle, const char *name, double *fvalue)
 Gets a floating-point property of the specified module (ASCII version).
static int gx_getmodulepropertyversion (gxHANDLE handle, const wchar_t *name, unsigned int *version)
 Gets a version property of the specified module (Unicode version).
static int gx_getmodulepropertyversiona (gxHANDLE handle, const char *name, unsigned int *version)
 Gets a version property of the specified module (ASCII version).
static int gx_setmoduleproperty (gxHANDLE handle, const wchar_t *name, const wchar_t *string)
 Sets a property of the specified module (Unicode version).
static int gx_setmodulepropertya (gxHANDLE handle, const char *name, const char *string)
 Sets a property of the specified module (ASCII version).
static int gx_setmodulepropertyint (gxHANDLE handle, const wchar_t *name, int ivalue)
 Sets an integer property of the specified module (Unicode version).
static int gx_setmodulepropertyinta (gxHANDLE handle, const char *name, int ivalue)
 Sets an integer property of the specified module (ASCII version).
static int gx_setmodulepropertyfloat (gxHANDLE handle, const wchar_t *name, double fvalue)
 Sets a floating-point property of the specified module (Unicode version).
static int gx_setmodulepropertyfloata (gxHANDLE handle, const char *name, double fvalue)
 Sets a floating-point property of the specified module (ASCII version).
static int gx_mpstarttransaction (gxHANDLE handle)
 It starts the property transaction.
static int gx_mpcommit (gxHANDLE handle)
 It ends the property transaction and updates your changes to module.
static int gx_savemoduleproperties (gxHANDLE handle, const wchar_t *name, int level)
 Saves properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
static int gx_savemodulepropertiesa (gxHANDLE handle, const char *name, int level)
 Saves properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).


Function Documentation

static int gx_getproperty ( gxHANDLE  handle,
const wchar_t *  name,
wchar_t *  string,
int  maxlen 
) [static]

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:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_getpropertyfloat(), and gx_getpropertyint().

static int gx_getpropertya ( gxHANDLE  handle,
const char *  name,
char *  string,
int  maxlen 
) [static]

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:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_getpropertyfloata(), and gx_getpropertyinta().

static int gx_getpropertyint ( gxHANDLE  handle,
const wchar_t *  name,
int *  ivalue 
) [static]

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:
handle Handle of an opened property module.
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 error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_getproperty().

static int gx_getpropertyinta ( gxHANDLE  handle,
const char *  name,
int *  ivalue 
) [static]

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:
handle Handle of an opened property module.
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 error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_getpropertya().

static int gx_getpropertyfloat ( gxHANDLE  handle,
const wchar_t *  name,
double *  fvalue 
) [static]

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:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_getproperty().

static int gx_getpropertyfloata ( gxHANDLE  handle,
const char *  name,
double *  fvalue 
) [static]

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:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_getpropertya().

static int gx_setproperty ( gxHANDLE  handle,
const wchar_t *  name,
const wchar_t *  string 
) [static]

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:
handle Handle of an opened property module.
name Name of the property and place in the property tree.
string Value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_setpropertyfloat(), and gx_setpropertyint().

static int gx_setpropertya ( gxHANDLE  handle,
const char *  name,
const char *  string 
) [static]

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:
handle Handle of an opened property module.
name Name of the property and place in the property tree.
string Value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_setpropertyfloata(), and gx_setpropertyinta().

static int gx_setpropertyint ( gxHANDLE  handle,
const wchar_t *  name,
int  ivalue 
) [static]

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 in the tree.
Parameters:
handle Handle of an opened property module.
name Name of the property and place in the property tree.
ivalue Integer value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_setproperty().

static int gx_setpropertyinta ( gxHANDLE  handle,
const char *  name,
int  ivalue 
) [static]

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:
handle Handle of an opened property module.
name Name of the property and place in the property tree.
ivalue Integer value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_setpropertya().

static int gx_setpropertyfloat ( gxHANDLE  handle,
const wchar_t *  name,
double  fvalue 
) [static]

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:
handle Handle of an opened property module.
name Name of the property and place in the property tree.
fvalue Floating-point value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_setproperty().

static int gx_setpropertyfloata ( gxHANDLE  handle,
const char *  name,
double  fvalue 
) [static]

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:
handle Handle of an opened property module.
name Name of the property and place in the property tree.
fvalue Floating-point value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_setpropertya().

static int gx_getpropertytype ( gxHANDLE  handle,
const wchar_t *  name,
int *  type 
) [static]

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

Parameters:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_getpropertytypea ( gxHANDLE  handle,
const char *  name,
int *  type 
) [static]

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

Parameters:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_rmproperties ( gxHANDLE  handle,
const wchar_t *  name 
) [static]

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

Parameters:
handle Handle of an opened property module.
name Name of the property and place in the property tree.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_rmpropertiesa ( gxHANDLE  handle,
const char *  name 
) [static]

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

Parameters:
handle Handle of an opened property module.
name Name of the property and place in the property tree.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_getproperties ( gxHANDLE  handle,
const wchar_t *  name,
wchar_t *  string,
int  maxlen 
) [static]

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

Note:
The names are separated with LF.
Parameters:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_getpropertiesa ( gxHANDLE  handle,
const char *  name,
char *  string,
int  maxlen 
) [static]

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

Note:
The names are separated with LF.
Parameters:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_getallproperties ( gxHANDLE  handle,
const wchar_t *  name,
wchar_t *  string,
int  maxlen 
) [static]

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:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_getallpropertiesa ( gxHANDLE  handle,
const char *  name,
char *  string,
int  maxlen 
) [static]

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:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_setpropertyparent ( gxHANDLE  handle,
const wchar_t *  name,
const wchar_t *  string 
) [static]

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

Parameters:
handle Handle of an opened property module.
name Name of the property and place in the property tree.
string Parent of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_setpropertyparenta ( gxHANDLE  handle,
const char *  name,
const char *  string 
) [static]

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

Parameters:
handle Handle of an opened property module.
name Name of the property and place in the property tree.
string Parent of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_getpropertyparent ( gxHANDLE  handle,
const wchar_t *  name,
wchar_t *  string,
int  maxlen 
) [static]

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

Parameters:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_getpropertyparenta ( gxHANDLE  handle,
const char *  name,
char *  string,
int  maxlen 
) [static]

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

Parameters:
handle Handle of an opened property module.
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:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_loadproperties ( gxHANDLE  handle,
const wchar_t *  name 
) [static]

Loads properties from a specified file (Unicode version).

Parameters:
handle Handle of an opened property module.
name Name of the property file.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_loadpropertiesa ( gxHANDLE  handle,
const char *  name 
) [static]

Loads properties from a specified file (ASCII version).

Parameters:
handle Handle of an opened property module.
name Name of the property file.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_saveproperties ( gxHANDLE  handle,
const wchar_t *  name,
int  unicode 
) [static]

Saves properties into a specified file (Unicode version).

Parameters:
handle Handle of an opened property module.
name Name of the property file.
unicode If it is true, the file will be unicode.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_savepropertiesa ( gxHANDLE  handle,
const char *  name,
int  unicode 
) [static]

Saves properties into a specified file (ASCII version).

Parameters:
handle Handle of an opened property module.
name Name of the property file.
unicode If it is true, the file will be unicode.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_flushproperties ( gxHANDLE  handle  )  [static]

Forces writing of all buffered data.

Parameters:
handle Handle of an opened property module.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_getmoduleproperty ( gxHANDLE  handle,
const wchar_t *  name,
wchar_t *  string,
int  maxlen 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
string Pointer to a memory area where to store the value.
maxlen Size of the memory area in characters (not bytes).
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_getmodulepropertyfloat(), gx_getmodulepropertyint(), and gx_getmodulepropertyversion().

static int gx_getmodulepropertya ( gxHANDLE  handle,
const char *  name,
char *  string,
int  maxlen 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
string Pointer to a memory area where to store the value.
maxlen Size of the memory area in characters (or bytes).
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_getmodulepropertyfloata(), gx_getmodulepropertyinta(), and gx_getmodulepropertyversiona().

static int gx_getmodulepropertyint ( gxHANDLE  handle,
const wchar_t *  name,
int *  ivalue 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
ivalue Pointer to an integer where to store the value.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_getmoduleproperty().

static int gx_getmodulepropertyinta ( gxHANDLE  handle,
const char *  name,
int *  ivalue 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
ivalue Pointer to an integer where to store the value.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_getmodulepropertya().

static int gx_getmodulepropertyfloat ( gxHANDLE  handle,
const wchar_t *  name,
double *  fvalue 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
fvalue Pointer to a floating-point where to store the value.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_getmoduleproperty().

static int gx_getmodulepropertyfloata ( gxHANDLE  handle,
const char *  name,
double *  fvalue 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
fvalue Pointer to a floating-point where to store the value.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_getmodulepropertya().

static int gx_getmodulepropertyversion ( gxHANDLE  handle,
const wchar_t *  name,
unsigned int *  version 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
version Pointer to an integer where to store the version.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_getmoduleproperty().

static int gx_getmodulepropertyversiona ( gxHANDLE  handle,
const char *  name,
unsigned int *  version 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
version Pointer to an integer where to store the version.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_getmodulepropertya().

static int gx_setmoduleproperty ( gxHANDLE  handle,
const wchar_t *  name,
const wchar_t *  string 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
string Value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_setmodulepropertyfloat(), and gx_setmodulepropertyint().

static int gx_setmodulepropertya ( gxHANDLE  handle,
const char *  name,
const char *  string 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
string Value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_setmodulepropertyfloata(), and gx_setmodulepropertyinta().

static int gx_setmodulepropertyint ( gxHANDLE  handle,
const wchar_t *  name,
int  ivalue 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
ivalue Integer value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_setmoduleproperty().

static int gx_setmodulepropertyinta ( gxHANDLE  handle,
const char *  name,
int  ivalue 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
ivalue Integer value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_setmodulepropertya().

static int gx_setmodulepropertyfloat ( gxHANDLE  handle,
const wchar_t *  name,
double  fvalue 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle handle of the module.
name Name of the property.
fvalue Floating-point value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_setmoduleproperty().

static int gx_setmodulepropertyfloata ( gxHANDLE  handle,
const char *  name,
double  fvalue 
) [static]

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

Module properties can be found at the description of the specified module. These settings are unique for each module handle and are not stored on the mass storage device.
Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Name of the property.
fvalue Floating-point value of the property.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_setmodulepropertya().

static int gx_mpstarttransaction ( gxHANDLE  handle  )  [static]

It starts the property transaction.

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

Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_mpcommit ( gxHANDLE  handle  )  [static]

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

Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_savemoduleproperties ( gxHANDLE  handle,
const wchar_t *  name,
int  level 
) [static]

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

Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Place of property in the property tree.
level Higher numbers give more details (0 = basic properties, 100 = all properties).
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_savemodulepropertiesa ( gxHANDLE  handle,
const char *  name,
int  level 
) [static]

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

Warning:
Not supported by each module!
Parameters:
handle Handle of the module.
name Place of property in the property tree.
level Higher numbers give more details (0 = basic properties, 100 = all properties).
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().


Generated  for GX
(c) Adaptive Recognition