Header Header

gxproperty.h File Reference


Detailed Description

Property handling interface

The GX is the base system for the majority of the Adaptive Recognition products. It is a collection of loadable modules and library functions and gives an ease to program interface to the hardware devices.

This file contains the descriptions of classes and functions of the property handling module.

Go to the source code of this file.

Enumerations

enum  GX_PROPERTYTYPES {
  GX_PROPERTY_INVALID = 0,
  GX_PROPERTY_NOVALUE = 1,
  GX_PROPERTY_DIRECT = 2,
  GX_PROPERTY_INHERIT = 3,
  GX_PROPERTY_DEFAULT = 4
}
 Enumerations for property types. More...

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.


Enumeration Type Documentation

Enumerations for property types.

Enumerator:
GX_PROPERTY_INVALID  The item is not found in the property tree.

GX_PROPERTY_NOVALUE  Property without value.

GX_PROPERTY_DIRECT  Property with direct value.

GX_PROPERTY_INHERIT  Property with inherited value.

GX_PROPERTY_DEFAULT  Property value in the default group.


Generated  for GX
(c) Adaptive Recognition