Header Header

Device handling


Detailed Description

Functions for device handling.


Modules

 Examples
 Device handling example

Functions

static int gx_listdevices (int *nitems, GX_DEVICE_INFO *items, unsigned int flags, GX_DEVICE_INFO *filter)
 Lists the available GX devices (Unicode version).
static int gx_listdevicesa (int *nitems, GX_DEVICE_INFOA *items, unsigned int flags, GX_DEVICE_INFOA *filter)
 Lists the available GX devices (ASCII version).
static int gx_opendevicea (gxHANDLE *handle, GX_DEVICE_INFOA *info, unsigned int flags, GX_DEVICE_INFOA *filter, int nproperties, const char **properties, int timeoutms)
 Selects and opens a device in the GX system (ASCII version).
static int gx_opendevice (gxHANDLE *handle, GX_DEVICE_INFO *info, unsigned int flags, GX_DEVICE_INFO *filter, int nproperties, const wchar_t **properties, int timeoutms)
 Selects and opens a device in the GX system (Unicode version).
static int gx_getsysteminfo (GX_SYSTEM_INFO *info)
 Returns information about the GX system.


Function Documentation

static int gx_listdevices ( int *  nitems,
GX_DEVICE_INFO items,
unsigned int  flags,
GX_DEVICE_INFO filter 
) [static]

Lists the available GX devices (Unicode version).

Parameters:
nitems Number of items in the array. On input set the maximal size of the array. The function will updates it with the number of the devices found.
items Pointer to the items of the array.
flags Flags for the filter structure (see GX_DEVICE_FLAGS).
filter The filter structure.
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_listdevicesa ( int *  nitems,
GX_DEVICE_INFOA items,
unsigned int  flags,
GX_DEVICE_INFOA filter 
) [static]

Lists the available GX devices (ASCII version).

Parameters:
nitems Number of items in the array. On input set the maximal size of the array. The function will updates it with the number of the devices found.
items Pointer to items of the array.
flags Flags for the filter structure (see GX_DEVICE_FLAGS).
filter The filter structure.
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_opendevicea ( gxHANDLE handle,
GX_DEVICE_INFOA info,
unsigned int  flags,
GX_DEVICE_INFOA filter,
int  nproperties,
const char **  properties,
int  timeoutms 
) [static]

Selects and opens a device in the GX system (ASCII version).

Parameters:
handle The function will update it with the opened handle.
info The function will fill it with the information of the opened device.
flags Flags for the filter structure (see GX_DEVICE_FLAGS).
filter The filter structure. You can pass NULL to it (if the flags field is zero too).
nproperties Number of properties of the device. It can be zero.
properties Pointer to properties of the device. It can be NULL.
timeoutms Timeout in milliseconds.
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_opendevice ( gxHANDLE handle,
GX_DEVICE_INFO info,
unsigned int  flags,
GX_DEVICE_INFO filter,
int  nproperties,
const wchar_t **  properties,
int  timeoutms 
) [static]

Selects and opens a device in the GX system (Unicode version).

Parameters:
handle The function will update it with the opened handle.
info The function will fill it with the information of the opened device.
flags Flags for the filter structure (see GX_DEVICE_FLAGS).
filter The filter structure. You can pass NULL to it (if the flags field is zero too).
nproperties Number of properties of the device. It can be zero.
properties Pointer to properties of the device. It can be NULL.
timeoutms Timeout in milliseconds.
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_getsysteminfo ( GX_SYSTEM_INFO info  )  [static]

Returns information about the GX system.

Parameters:
info Buffer for the result. Before calling this function, do not forget to set the size member of the structure. A non 0 value specifies the number of bytes required. If it is set to 0, the function returns the proper size that can be used in a successive call.
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