![]() |
Functions | |
static int | fps_getdevicelist (gxHANDLE handle, wchar_t ***devices, int *ndevices) |
Returns a list of the available Fingerprint Scanner devices (Unicode version). | |
static int | fps_getdevicelista (gxHANDLE handle, char ***devices, int *ndevices) |
Returns a list of the available Fingerprint Scanner devices (ASCII version). | |
static int | fps_usedevice (gxHANDLE handle, const wchar_t *device, int mode) |
Connects an FPS device. | |
static int | fps_usedevicea (gxHANDLE handle, const char *device, int mode) |
Conects to an FPS device. | |
static int | fps_usedevicen (gxHANDLE handle, int devno, int mode) |
Conects to an FPS device. | |
static int | fps_closedevice (gxHANDLE handle) |
Disconnects the connected device. | |
static int | fps_calibrate (gxHANDLE handle, int windowid) |
Calibrates the used device. | |
static int | fps_iscalibrated (gxHANDLE handle, int windowid) |
Tests the calibrated state of the device. | |
static int | fps_testpresence (gxHANDLE handle, int *state, int windowid) |
Gives back the result of the finger presence detector module. | |
static int | fps_setstatusled (gxHANDLE handle, int ledmask, int color) |
Turns on/off the status leds. | |
static int | fps_blinkstatus (gxHANDLE handle, int coding, int mask, int type, int iteration, unsigned int *data, unsigned int datalength) |
Blinks status outputs (led or buzzer). | |
static int | fps_testpower (gxHANDLE handle, int *state, int *level) |
Gets the power state of the device. | |
static int | fps_testbutton (gxHANDLE handle, int keycode, int *state) |
Gets the device's button state. | |
static int | fps_getbuttonevent (gxHANDLE handle, int *keycode, int *state) |
Gets the device's next button event. | |
static int | fps_suspend (gxHANDLE handle) |
Suspends the Fingerprint Scanner system. | |
static int | fps_wakeup (gxHANDLE handle) |
Wakes up the previously suspended Fingerprint Scanner system. | |
static int | fps_getudinfo (gxHANDLE handle, int *nblocks, int *sblock) |
Gets information about the available user data space. | |
static int | fps_readudata (gxHANDLE handle, int fblock, int nblocks, void **data) |
Reads the user data from the device. | |
static int | fps_writeudata (gxHANDLE handle, int fblock, int nblocks, const void *data) |
Writes the user data in the used device. | |
static int | fps_getdeviceinfo (gxHANDLE handle, gxVARIANT *devinfo) |
Gets information about the device used. |
static int fps_getdevicelist | ( | gxHANDLE | handle, | |
wchar_t *** | devices, | |||
int * | ndevices | |||
) | [static] |
Returns a list of the available Fingerprint Scanner devices (Unicode version).
The application must call the gx_globalfree() function for the devices list to free the allocated memory.
handle | Handle of the fpsapi module. | |
devices | List of the device names. | |
ndevices | Number of devices. |
References gx_call().
static int fps_getdevicelista | ( | gxHANDLE | handle, | |
char *** | devices, | |||
int * | ndevices | |||
) | [static] |
Returns a list of the available Fingerprint Scanner devices (ASCII version).
The application must call the gx_globalfree() function for the devices list to free the allocated memory.
handle | Handle of the fpsapi module. | |
devices | List of the device names. | |
ndevices | Number of devices. |
References gx_call().
Referenced by fps_usedevicen().
static int fps_usedevice | ( | gxHANDLE | handle, | |
const wchar_t * | device, | |||
int | mode | |||
) | [static] |
Connects an FPS device.
To get a list of the available devices call the fps_getdevicelist() function (Unicode version).
handle | Handle of the fpsapi module. | |
device | Name of the device to connect to. | |
mode | Connection mode. The possible values are defined in the FPS_USAGEMODE enumeration. Generally the FPS_UMODE_FULL_CONTROL is recommended to use. |
References gx_call().
static int fps_usedevicea | ( | gxHANDLE | handle, | |
const char * | device, | |||
int | mode | |||
) | [static] |
Conects to an FPS device.
To get a list of the available devices call the fps_getdevicelist() function (ASCII version).
handle | Handle of the fpsapi module. | |
device | Name of the device to connect to. | |
mode | Connection mode. The possible values are defined in the FPS_USAGEMODE enumeration. Generally the FPS_UMODE_FULL_CONTROL is recommended to use. |
References gx_call().
Referenced by fps_usedevicen().
static int fps_usedevicen | ( | gxHANDLE | handle, | |
int | devno, | |||
int | mode | |||
) | [static] |
Conects to an FPS device.
handle | Handle of the fpsapi module. | |
devno | Ordinal number of the device to connect to. | |
mode | Connection mode. The possible values are defined in the FPS_USAGEMODE enumeration. Generally the FPS_UMODE_FULL_CONTROL is recommended to use. |
References fps_getdevicelista(), fps_usedevicea(), gx_globalfree(), and gx_seterror().
static int fps_closedevice | ( | gxHANDLE | handle | ) | [static] |
Disconnects the connected device.
handle | Handle of the fpsapi module. |
References gx_call().
static int fps_calibrate | ( | gxHANDLE | handle, | |
int | windowid | |||
) | [static] |
Calibrates the used device.
Generates data for correting the determinable distotions of the capturing system. This process can take up to 5-30 seconds according to the computer's speed. To use this function correctly, you need to clean the platen and protect the device from external light.
handle | Handle of the fpsapi module. | |
windowid | RFU. |
References gx_call().
static int fps_iscalibrated | ( | gxHANDLE | handle, | |
int | windowid | |||
) | [static] |
Tests the calibrated state of the device.
handle | Handle of the fpsapi module. | |
windowid | RFU. |
References gx_call().
static int fps_testpresence | ( | gxHANDLE | handle, | |
int * | state, | |||
int | windowid | |||
) | [static] |
Gives back the result of the finger presence detector module.
The possible result values are defined in the FPS_TESTPRESENCE enumeration. Call this function 4-5 times in every second. The test is work only when the freerun_mode property contains the FPS_FRMODE_TESTPRESENCE value.
handle | Handle of the fpsapi module. | |
state | Buffer for the result. | |
windowid | RFU. |
References gx_call().
static int fps_setstatusled | ( | gxHANDLE | handle, | |
int | ledmask, | |||
int | color | |||
) | [static] |
Turns on/off the status leds.
handle | Handle of the fpsapi module. | |
ledmask | Mask representing the status leds. Each bit represents a status led on the device. | |
color | The color to display on the specified status leds. The predefined values of the lights are stored in the FPS_STATUS_LED_COLOR enumeration. Bit 7 represents the on/off parameter of the light so any value below 80 hex means led off. |
References gx_call().
static int fps_blinkstatus | ( | gxHANDLE | handle, | |
int | coding, | |||
int | mask, | |||
int | type, | |||
int | iteration, | |||
unsigned int * | data, | |||
unsigned int | datalength | |||
) | [static] |
Blinks status outputs (led or buzzer).
handle | Handle of the prapi module. | |
coding | Coding of the data. The possible values are: 0: stop pulses, 1: data[odd]: time duration output high level [ms], data[even]: time duration output low level [ms] | |
mask | Mask representing the status leds and buzzer. Each bit represents a status led or buzzer on the device. | |
type | Led color id or buzzer id. Its predefined values are stored in the FPS_STATUS_LED_COLOR and FPS_BUZZER enumerations. | |
iteration | Number of repeat, 0 menas forever. | |
data | Data of blinking. | |
datalength | Length of the data, (maximum 16). |
References gx_call().
static int fps_testpower | ( | gxHANDLE | handle, | |
int * | state, | |||
int * | level | |||
) | [static] |
Gets the power state of the device.
handle | Handle of the fpsapi module. | |
state | Buffer for the device power state. | |
level | Buffer for the battery power level. In case of devices without battery -1 is returned. |
References gx_call().
static int fps_testbutton | ( | gxHANDLE | handle, | |
int | keycode, | |||
int * | state | |||
) | [static] |
Gets the device's button state.
handle | Handle of the fpsapi module. | |
keycode | The code of the button/key. | |
state | Buffer for the button/key state. |
References gx_call().
static int fps_getbuttonevent | ( | gxHANDLE | handle, | |
int * | keycode, | |||
int * | state | |||
) | [static] |
Gets the device's next button event.
handle | Handle of the fpsapi module. | |
keycode | Buffer for the button/key code. | |
state | Buffer for the button/key state. |
References gx_call().
static int fps_suspend | ( | gxHANDLE | handle | ) | [static] |
Suspends the Fingerprint Scanner system.
It may be called for example when the operating system tries to suspend or for power saving reasons you want to suspend the connected device. Depending on the type of the device and the control level set different suspend levels can be reached.
handle | Handle of the fpsapi module. |
References gx_call().
static int fps_wakeup | ( | gxHANDLE | handle | ) | [static] |
Wakes up the previously suspended Fingerprint Scanner system.
handle | Handle of the fpsapi module. |
References gx_call().
static int fps_getudinfo | ( | gxHANDLE | handle, | |
int * | nblocks, | |||
int * | sblock | |||
) | [static] |
Gets information about the available user data space.
handle | Handle of the fpsapi module. | |
nblocks | Number of blocks. | |
sblock | Size of a block. |
References gx_call().
static int fps_readudata | ( | gxHANDLE | handle, | |
int | fblock, | |||
int | nblocks, | |||
void ** | data | |||
) | [static] |
Reads the user data from the device.
The application must call the gx_globalfree() function for the data to free the allocated memory.
handle | Handle of the fpsapi module. | |
fblock | First block to read. | |
nblocks | Number of blocks to read. | |
data | Bytes read. |
References gx_call().
static int fps_writeudata | ( | gxHANDLE | handle, | |
int | fblock, | |||
int | nblocks, | |||
const void * | data | |||
) | [static] |
Writes the user data in the used device.
handle | Handle of the fpsapi module. | |
fblock | First block to write. | |
nblocks | Number of blocks to write. | |
data | Bytes to write. |
References gx_call().
Gets information about the device used.
handle | Handle of the fpsapi module. | |
devinfo | Variant structure for device information. |
References gx_call().