Header Header

Module handling


Detailed Description

Functions for module handling.


Functions

static int gx_openmodule (gxHANDLE *handle, const wchar_t *modulename, const wchar_t *groupname)
 Opens a GX system compatible module (Unicode version).
static int gx_openmodulea (gxHANDLE *handle, const char *modulename, const char *groupname)
 Opens a GX system compatible module (ASCII version).
static int gx_closehandle (gxHANDLE *handle)
 Closes a previously opened module.
static int gx_getmoduleinfo (gxHANDLE handle, const gxMODULEINFO **moduleinfo)
 Gives information about an opened module.


Function Documentation

static int gx_openmodule ( gxHANDLE handle,
const wchar_t *  modulename,
const wchar_t *  groupname 
) [static]

Opens a GX system compatible module (Unicode version).

The modules can be found in /usr/lib/gx under GNU/Linux system. It is not necessary to give the whole path and the extension when referring to a module name (for example fxvd4 is enough instead of /usr/lib/gx/fxvd4.so).
The system searches for the modules in the system directory, in the default module directory and in the directories stored in the PATH environment variable under Windows systems. Specifying the whole path is needed only if the module cannot be found in the standard directories.
The third parameter is for giving the location of the properties of the module in the property tree. If it is not specified the module will work with the default settings.
Note: Not every module uses properties. In case of not using properties give NULL for the propname parameter.
See also:
gx_closehandle() gx_isvalidhandle()
Parameters:
handle Writes the handle of the opened module to the memory area where this pointer refers.
modulename Name of the module.
groupname 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_openmodulea ( gxHANDLE handle,
const char *  modulename,
const char *  groupname 
) [static]

Opens a GX system compatible module (ASCII version).

The modules can be found in /usr/lib/gx under GNU/Linux system. It is not necessary to give the whole path and the extension when referring to a module name (for example fxvd4 is enough instead of /usr/lib/gx/fxvd4.so).
The system searches for the modules in the system directory, in the default module directory and in the directories stored in the PATH environment variable under Windows systems. Specifying the whole path is needed only if the module cannot be found in the standard directories.
The third parameter is for giving the location of the properties of the module in the property tree. If it is not specified the module will work with the default settings.
Note: Not every module uses properties. In case of not using properties give NULL for the propname parameter.
See also:
gx_closehandle() gx_isvalidhandle()
Parameters:
handle Writes the handle of the opened module to the memory area where this pointer refers.
modulename Name of module.
groupname 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_closehandle ( gxHANDLE handle  )  [static]

Closes a previously opened module.

In case of successful execution the handle will be cleared.

See also:
gx_openmodule() gx_isvalidhandle()
Parameters:
handle Pointer to the module handle.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call(), and gxHANDLE::handle.

static int gx_getmoduleinfo ( gxHANDLE  handle,
const gxMODULEINFO **  moduleinfo 
) [static]

Gives information about an opened module.

See also:
gx_openmodule()
Parameters:
handle Handle of the module.
moduleinfo Pointer to an information structure pointer where the system writes the data of the specified module. ( see gxMODULEINFO )
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