Device handling

---

Detailed Description

Functions for controlling the device.

Functions
int	fps_getdevicelist (gxHANDLE handle, wchar_t ***devices, int *ndevices)
	Returns a list of the available Fingerprint Scanner devices (Unicode version).
int	fps_getdevicelista (gxHANDLE handle, char ***devices, int *ndevices)
	Returns a list of the available Fingerprint Scanner devices (ASCII version).
int	fps_getdevicelist (gxHANDLE handle, char ***devices, int *ndevices)
	Returns a list of the available Fingerprint Scanner devices (ASCII version).
int	fps_usedevice (gxHANDLE handle, const wchar_t *device, int mode)
	Connects an FPS device.
int	fps_usedevicea (gxHANDLE handle, const char *device, int mode)
	Conects to an FPS device.
int	fps_usedevicen (gxHANDLE handle, int devno, int mode)
	Conects to an FPS device.
int	fps_usedevice (gxHANDLE handle, const char *device, int mode)
	Conects to an FPS device (ASCII version).
int	fps_usedevice (gxHANDLE handle, int devno, int mode)
	Conects to an FPS device.
int	fps_closedevice (gxHANDLE handle)
	Disconnects the connected device.
int	fps_testpresence (gxHANDLE handle, int *state, int windowid=0)
	Gives back the result of the finger presence detector module.
int	fps_setstatusled (gxHANDLE handle, int ledmask, int color)
	Turns on/off the status leds.
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).
int	fps_testpower (gxHANDLE handle, int *state, int *level)
	Gets the power state of the device.
int	fps_testbutton (gxHANDLE handle, int keycode, int *state)
	Gets the device's button state.
int	fps_getbuttonevent (gxHANDLE handle, int *keycode, int *state)
	Gets the device's next button event.
int	fps_suspend (gxHANDLE handle)
	Suspends the Fingerprint Scanner system.
int	fps_wakeup (gxHANDLE handle)
	Wakes up the previously suspended Fingerprint Scanner system.
int	fps_getudinfo (gxHANDLE handle, int *nblocks, int *sblock)
	Gets information about the available user data space.
int	fps_readudata (gxHANDLE handle, int fblock, int nblocks, void **data)
	Reads the user data from the device.
int	fps_writeudata (gxHANDLE handle, int fblock, int nblocks, const void *data)
	Writes the user data in the used device.
int	fps_getdeviceinfo (gxHANDLE handle, gxVARIANT *devinfo)
	Gets information about the device used.

---

Function Documentation

int fps_getdevicelist	(	gxHANDLE	handle,
		wchar_t ***	devices,
		int *	ndevices
	)			[inline]

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.

Parameters:

	handle	Handle of the fpsapi module.
	devices	List of the device names.
	ndevices	Number of devices.

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 FingerPrintScanner::GetDeviceList(), and FingerPrintScanner::GetDeviceListA().

int fps_getdevicelista	(	gxHANDLE	handle,
		char ***	devices,
		int *	ndevices
	)			[inline]

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.

Parameters:

	handle	Handle of the fpsapi module.
	devices	List of the device names.
	ndevices	Number of devices.

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 fps_getdevicelist(), and fps_usedevicen().

int fps_getdevicelist	(	gxHANDLE	handle,
		char ***	devices,
		int *	ndevices
	)			[inline]

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.

Parameters:

	handle	Handle of the fpsapi module.
	devices	List of the device names.
	ndevices	Number of devices.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References fps_getdevicelista().

int fps_usedevice	(	gxHANDLE	handle,
		const wchar_t *	device,
		int	mode
	)			[inline]

Connects an FPS device.

To get a list of the available devices call the fps_getdevicelist() function (Unicode version).

Parameters:

	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.

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 FingerPrintScanner::UseDevice().

int fps_usedevicea	(	gxHANDLE	handle,
		const char *	device,
		int	mode
	)			[inline]

Conects to an FPS device.

To get a list of the available devices call the fps_getdevicelist() function (ASCII version).

Parameters:

	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.

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 fps_usedevice(), and fps_usedevicen().

int fps_usedevicen	(	gxHANDLE	handle,
		int	devno,
		int	mode
	)			[inline]

Conects to an FPS device.

Parameters:

	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.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References fps_getdevicelista(), fps_usedevicea(), gx_globalfree(), and gx_seterror().

Referenced by fps_usedevice().

int fps_usedevice	(	gxHANDLE	handle,
		const char *	device,
		int	mode
	)			[inline]

Conects to an FPS device (ASCII version).

To get a list of the available devices call the fps_getdevicelist() function.

Parameters:

	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.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References fps_usedevicea().

int fps_usedevice	(	gxHANDLE	handle,
		int	devno,
		int	mode
	)			[inline]

Conects to an FPS device.

Parameters:

	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.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References fps_usedevicen().

int fps_closedevice

(

gxHANDLE

handle

)

[inline]

Disconnects the connected device.

Parameters:

handle

Handle of the fpsapi 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().

Referenced by FingerPrintScanner::CloseDevice().

int fps_testpresence	(	gxHANDLE	handle,
		int *	state,
		int	windowid = 0
	)			[inline]

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.

Parameters:

	handle	Handle of the fpsapi module.
	state	Buffer for the result.
	windowid	RFU.

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 FingerPrintScanner::TestPresence().

int fps_setstatusled	(	gxHANDLE	handle,
		int	ledmask,
		int	color
	)			[inline]

Turns on/off the status leds.

Parameters:

	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.

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 FingerPrintScanner::SetStatusLed().

int fps_blinkstatus	(	gxHANDLE	handle,
		int	coding,
		int	mask,
		int	type,
		int	iteration,
		unsigned int *	data,
		unsigned int	datalength
	)			[inline]

Blinks status outputs (led or buzzer).

Parameters:

	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).

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 FingerPrintScanner::BlinkStatus().

int fps_testpower	(	gxHANDLE	handle,
		int *	state,
		int *	level
	)			[inline]

Gets the power state of the device.

Parameters:

	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.

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 FingerPrintScanner::TestPowerLevel(), and FingerPrintScanner::TestPowerState().

int fps_testbutton	(	gxHANDLE	handle,
		int	keycode,
		int *	state
	)			[inline]

Gets the device's button state.

Parameters:

	handle	Handle of the fpsapi module.
	keycode	The code of the button/key.
	state	Buffer for the button/key state.

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 FingerPrintScanner::TestButton().

int fps_getbuttonevent	(	gxHANDLE	handle,
		int *	keycode,
		int *	state
	)			[inline]

Gets the device's next button event.

Parameters:

	handle	Handle of the fpsapi module.
	keycode	Buffer for the button/key code.
	state	Buffer for the button/key state.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

int fps_suspend

(

gxHANDLE

handle

)

[inline]

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.

Parameters:

handle

Handle of the fpsapi 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().

Referenced by FingerPrintScanner::Suspend().

int fps_wakeup

(

gxHANDLE

handle

)

[inline]

Wakes up the previously suspended Fingerprint Scanner system.

Parameters:

handle

Handle of the fpsapi 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().

Referenced by FingerPrintScanner::WakeUp().

int fps_getudinfo	(	gxHANDLE	handle,
		int *	nblocks,
		int *	sblock
	)			[inline]

Gets information about the available user data space.

Parameters:

	handle	Handle of the fpsapi module.
	nblocks	Number of blocks.
	sblock	Size of a block.

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 FingerPrintScanner::GetUDBlockSize(), FingerPrintScanner::GetUDInfo(), and FingerPrintScanner::GetUDNumberOfBlocks().

int fps_readudata	(	gxHANDLE	handle,
		int	fblock,
		int	nblocks,
		void **	data
	)			[inline]

Reads the user data from the device.

The application must call the gx_globalfree() function for the data to free the allocated memory.

Parameters:

	handle	Handle of the fpsapi module.
	fblock	First block to read.
	nblocks	Number of blocks to read.
	data	Bytes read.

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 FingerPrintScanner::ReadUData().

int fps_writeudata	(	gxHANDLE	handle,
		int	fblock,
		int	nblocks,
		const void *	data
	)			[inline]

Writes the user data in the used device.

Parameters:

	handle	Handle of the fpsapi module.
	fblock	First block to write.
	nblocks	Number of blocks to write.
	data	Bytes to write.

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 FingerPrintScanner::WriteUData().

int fps_getdeviceinfo	(	gxHANDLE	handle,
		gxVARIANT *	devinfo
	)			[inline]

Gets information about the device used.

Parameters:

	handle	Handle of the fpsapi module.
	devinfo	Variant structure for device information.

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 FingerPrintScanner::GetDeviceInfo().