FingerPrintScanner Class Reference

Inheritance diagram for FingerPrintScanner:

List of all members.

---

Detailed Description

This class contains functions that contol the Fingerprint Scanner system.

Public Member Functions
	FingerPrintScanner () throw (gxError)
	Class initialization.
void	Dispose (void)
	Disposes the class.
bool	GetDeviceList (wchar_t ***devices, int *ndevices) throw (gxError)
	Returns a list of the available Fingerprint Scanner devices (Unicode version).
bool	GetDeviceList (char ***devices, int *ndevices) throw (gxError)
	Returns a list of the available Fingerprint Scanner devices (ASCII version).
gxOutStrArray	GetDeviceList (void) throw (gxError)
	Returns a list of the available Fingerprint Scanner devices (Unicode version).
gxOutAStrArray	GetDeviceListA (void) throw (gxError)
	Returns a list of the available Fingerprint Scanner devices (ASCII version).
bool	UseDevice (const wchar_t *device, int mode) throw (gxError)
	Connects an FPS device (Unicode version).
bool	UseDevice (const char *device, int mode) throw (gxError)
	Conects to an FPS device (ASCII version).
bool	UseDevice (gxInStr device, int mode) throw (gxError)
	Conects to an FPS device (Unicode version).
bool	UseDevice (gxInAStr device, int mode) throw (gxError)
	Conects to an FPS device (ASCII version).
bool	UseDevice (int devno, int mode) throw (gxError)
	Conects to an FPS device.
bool	CloseDevice (void) throw (gxError)
	Disconnects the connected device.
int	TestPresence (int windowid=0)
	Returns the result of the finger presence detection module.
bool	SetStatusLed (int ledmask, int color) throw (gxError)
	Turns on/off the status leds.
bool	BlinkStatus (int coding, int mask, int type, int iteration, unsigned int *data, unsigned int datalength) throw (gxError)
	Blinks status outputs (led or buzzer).
bool	BlinkStatus (int coding, int mask, int type, int iteration, gxInIntArray data)
	Blinks status outputs (led or buzzer).
int	TestPowerState (void)
	Gets the power state of the device.
int	TestPowerLevel (void)
	Gets the power level of the device.
int	TestButton (int keycode)
	Gets the device's button state.
bool	Suspend ()
	Suspends the Fingerprint Scanner system.
bool	WakeUp ()
	Wakes up the previously suspended Fingerprint Scanner system.
bool	GetUDInfo (int *nblocks, int *sblock) throw (gxError)
	Gets information about the available user data space.
bool	ReadUData (int fblock, int nblocks, void **data) throw (gxError)
	Reads the user data from the device.
bool	WriteUData (int fblock, int nblocks, const void *data) throw (gxError)
	Writes the user data in the used device.
int	GetUDNumberOfBlocks (void) throw (gxError)
	Returns the number of blocks available in the user data space.
int	GetUDBlockSize (void) throw (gxError)
	Returns the block size of the user data space.
gxVariant *	GetDeviceInfo () throw (gxError)
	Returns the information about the used device.
bool	SetEventFunction (FPS_EVFUNC *eventhandler, void *param)
	The event function is a callback function which is called during capture.
bool	BeginWindowMessaging (HWND hwnd, UINT base_msg=WM_USER)
	Starts window messaging process (WIN32 function).
bool	EndWindowMessaging ()
	Ends window messaging process (WIN32 function).
int	StartBGProcesses () throw (gxError)
	Starts automated background process (Linux function).
int	StopBGProcesses ()
	Ends the automated background process (Linux function).
bool	Capture (int timeout, int quality, int mode, int fingerlist) throw (gxError)
	Scan fingers from captured images.
int	CaptureStart (int timeout, int quality, int mode, int fingerlist) throw (gxError)
	Starts the finger image capturing process in asynchronous mode.
int	CaptureStatus (int reqid) throw (gxError)
	Returns the state of an image capture process started with the CaptureStart() method.
bool	CaptureStop () throw (gxError)
	Stops the capture process started with the CaptureStart() or the Capture() method before the timeout is elapsed.
bool	CaptureWait (int reqid) throw (gxError)
	Ends the capture process started with the CaptureStart() method.
bool	CapturePreview (int windowid=0) throw (gxError)
	Captures a preview image.
gxVariant *	GetImage (int smode, int position, int type) throw (gxError)
	The Fingerprint Scanner system has several functions for working with the captured images.
bool	SaveImage (int smode, int position, int type, const wchar_t *filename, int filetype) throw (gxError)
	Saves an image to a file (Unicode version).
bool	SaveImage (int smode, int position, int type, const char *filename, int filetype) throw (gxError)
	Saves an image to a file (ASCII version).
bool	SaveImage (int smode, int position, int type, gxInStr filename, int filetype) throw (gxError)
	Saves an image to a file (Unicode version).
bool	SaveImage (int smode, int position, int type, gxInAStr filename, int filetype) throw (gxError)
	Saves an image to a file (ASCII version).
bool	DisplayImage (int smode, int position, int type, HDC hdc, int x, int y, int xsize, int ysize, gxRCT *frame) throw (gxError)
	Displays an image (WIN32 function).
bool	FingerToNist (const wchar_t *filename, gxVariant *fields) throw (gxError)
	Saves the fingers to an nist file (Unicode version).
bool	FingerToNist (const char *filename, gxVariant *fields) throw (gxError)
	Saves the fingers to an nist file (ASCII version).
bool	FingerToNistMem (void **buffer, int *buflen, gxVariant *fields) throw (gxError)
	Saves the fingers to a memory area as a nist file.
bool	FingerToNist (gxInStr filename, gxVariant *fields) throw (gxError)
	Saves the fingers to an nist file (Unicode version).
bool	FingerToNist (gxInAStr filename, gxVariant *fields) throw (gxError)
	Saves the fingers to an nist file (ASCII version).
int	NistFingerQuality (int position) throw (gxError)
	Returns the NIST Finger Image Quality value from a finger.
bool	ResetFingerList (void) throw (gxError)
	Clears all the finger image buffers and deletes the internal finger image structures.
bool	Open (const wchar_t *modulename, const wchar_t *groupname=(const wchar_t *) 0)
bool	Open (const char *modulename, const char *groupname=(const char *) 0)
bool	Open (gxInStr modulename, gxInStr groupname)
bool	Open (gxInStr modulename)
bool	Open (gxInAStr modulename, gxInAStr groupname)
bool	Open (gxInAStr modulename)
bool	Close (void)
bool	IsValid (void) const
bool	GetInfo (const gxMODULEINFO **moduleinfo)
bool	GetDependencies (const unsigned int **groupcodes)
bool	Call (int callcode, void *params)
bool	GetProperty (const wchar_t *name, wchar_t *string, int maxlen)
std::wstring	GetProperty (const wchar_t *name)
bool	GetProperty (const char *name, char *string, int maxlen)
std::string	GetProperty (const char *name)
gxOutStr	GetProperty (gxInStr name)
gxOutAStr	GetProperty (gxInAStr name)
bool	GetProperty (const wchar_t *name, int *ivalue)
bool	GetProperty (const char *name, int *ivalue)
bool	GetProperty (const wchar_t *name, double *fvalue)
bool	GetProperty (const char *name, double *fvalue)
int	GetPropertyInt (const wchar_t *name)
int	GetPropertyInt (gxInStr name)
int	GetPropertyInt (const char *name)
int	GetPropertyInt (gxInAStr name)
double	GetPropertyFloat (const wchar_t *name)
double	GetPropertyFloat (gxInStr name)
double	GetPropertyFloat (const char *name)
double	GetPropertyFloat (gxInAStr name)
bool	SetProperty (const wchar_t *name, const wchar_t *string)
bool	SetProperty (const char *name, const char *string)
bool	SetProperty (gxInStr name, gxInStr str)
bool	SetProperty (gxInAStr name, gxInAStr str)
bool	SetProperty (const wchar_t *name, int ivalue)
bool	SetProperty (const char *name, int ivalue)
bool	SetProperty (gxInStr name, int ivalue)
bool	SetProperty (gxInAStr name, int ivalue)
bool	SetProperty (const wchar_t *name, double fvalue)
bool	SetProperty (const char *name, double fvalue)
bool	SetProperty (gxInStr name, double fvalue)
bool	SetProperty (gxInAStr name, double fvalue)
bool	SaveProperties (const wchar_t *name, int level=0)
bool	SaveProperties (const char *name, int level=0)
bool	SaveProperties (gxInStr name, int level)
bool	SaveProperties (gxInStr name)
bool	SaveProperties (gxInAStr name, int level=0)
bool	MPStartTransaction (void)
bool	MPCommit (void)
Public Attributes
gxu32	handle

---

Constructor & Destructor Documentation

FingerPrintScanner

(

)

throw (gxError) [inline]

Class initialization.

References gx_openmodule().

---

Member Function Documentation

void Dispose

(

void

)

[inline]

Disposes the class.

Reimplemented from gxHandle.

References gxHandle::Dispose().

bool GetDeviceList	(	wchar_t ***	devices,
		int *	ndevices
	)			throw (gxError) [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:

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

bool GetDeviceList	(	char ***	devices,
		int *	ndevices
	)			throw (gxError) [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 allocated memory.

Parameters:

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

gxOutStrArray GetDeviceList

(

void

)

throw (gxError) [inline]

Returns a list of the available Fingerprint Scanner devices (Unicode version).

Returns:

The list of the available Fingerprint Scanner devices.

References fps_getdevicelist().

gxOutAStrArray GetDeviceListA

(

void

)

throw (gxError) [inline]

Returns a list of the available Fingerprint Scanner devices (ASCII version).

Returns:

The list of the available Fingerprint Scanner devices.

References fps_getdevicelist().

bool UseDevice	(	const wchar_t *	device,
		int	mode
	)			throw (gxError) [inline]

Connects an FPS device (Unicode version).

To get a list of the available devices call the GetDeviceList() method.

Parameters:

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

bool UseDevice	(	const char *	device,
		int	mode
	)			throw (gxError) [inline]

Conects to an FPS device (ASCII version).

To get a list of the available devices call the GetDeviceList() method.

Parameters:

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

bool UseDevice	(	gxInStr	device,
		int	mode
	)			throw (gxError) [inline]

Conects to an FPS device (Unicode version).

To get a list of the available devices call the GetDeviceList() method.

Parameters:

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

bool UseDevice	(	gxInAStr	device,
		int	mode
	)			throw (gxError) [inline]

Conects to an FPS device (ASCII version).

To get a list of the available devices call the GetDeviceListA() method.

Parameters:

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

bool UseDevice	(	int	devno,
		int	mode
	)			throw (gxError) [inline]

Conects to an FPS device.

Parameters:

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

bool CloseDevice

(

void

)

throw (gxError) [inline]

Disconnects the connected device.

Returns:

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

References fps_closedevice().

int TestPresence

(

int

windowid = 0

)

[inline]

Returns the result of the finger presence detection module.

The possible result values are defined in the FPS_TESTPRESENCE enumeration. Call this method 4-5 times in every second. The test is working only when the freerun_mode property contains the FPS_FRMODE_TESTPRESENCE value.

Parameters:

windowid

RFU.

Returns:

The result of the motion detection. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References fps_testpresence().

bool SetStatusLed	(	int	ledmask,
		int	color
	)			throw (gxError) [inline]

Turns on/off the status leds.

Parameters:

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

bool BlinkStatus	(	int	coding,
		int	mask,
		int	type,
		int	iteration,
		unsigned int *	data,
		unsigned int	datalength
	)			throw (gxError) [inline]

Blinks status outputs (led or buzzer).

Parameters:

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

bool BlinkStatus	(	int	coding,
		int	mask,
		int	type,
		int	iteration,
		gxInIntArray	data
	)			[inline]

Blinks status outputs (led or buzzer).

Parameters:

	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, (maximum 16).

Returns:

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

References fps_blinkstatus().

int TestPowerState

(

void

)

[inline]

Gets the power state of the device.

Returns:

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

References fps_testpower().

int TestPowerLevel

(

void

)

[inline]

Gets the power level of the device.

In case of devices without battery -1 is returned.

Returns:

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

References fps_testpower().

int TestButton

(

int

keycode

)

[inline]

Gets the device's button state.

Parameters:

keycode

The code of the button/key.

Returns:

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

References fps_testbutton().

bool Suspend

(

)

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

Returns:

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

References fps_suspend().

bool WakeUp

(

)

[inline]

Wakes up the previously suspended Fingerprint Scanner system.

Returns:

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

References fps_wakeup().

bool GetUDInfo	(	int *	nblocks,
		int *	sblock
	)			throw (gxError) [inline]

Gets information about the available user data space.

Parameters:

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

bool ReadUData	(	int	fblock,
		int	nblocks,
		void **	data
	)			throw (gxError) [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:

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

bool WriteUData	(	int	fblock,
		int	nblocks,
		const void *	data
	)			throw (gxError) [inline]

Writes the user data in the used device.

Parameters:

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

int GetUDNumberOfBlocks

(

void

)

throw (gxError) [inline]

Returns the number of blocks available in the user data space.

Returns:

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

References fps_getudinfo().

int GetUDBlockSize

(

void

)

throw (gxError) [inline]

Returns the block size of the user data space.

Returns:

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

References fps_getudinfo().

gxVariant* GetDeviceInfo

(

)

throw (gxError) [inline]

Returns the information about the used device.

Returns:

The device info in variant data type.

References gxSystem::ClearError(), fps_getdeviceinfo(), GX_ENOMEM, gx_unrefvariant(), and gxSystem::SetError().

bool SetEventFunction	(	FPS_EVFUNC *	eventhandler,
		void *	param
	)			[inline]

The event function is a callback function which is called during capture.

There are different kind of events. The event types and the events are defined in the FPS_EVENT enumeration. The invoked event types can be set through the event_types property.

Parameters:

	eventhandler	Reference to the callback function.
	param	User parameter.

Returns:

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

References fps_seteventfunction().

bool BeginWindowMessaging	(	HWND	hwnd,
		UINT	base_msg = WM_USER
	)			[inline]

Starts window messaging process (WIN32 function).

After starting window messaging process the freerun mode events will be raised and all the FPS events will be appeared as standard window messages. No threaded poll is needed to test for example the state of the button. The message will arrive to the window handle set in case of status change. To stop the messaging process call the EndWindowMessaging() function.

Parameters:

	hwnd	Window handle to send the messages to. This parameter can be 0 to disable window messaging.
	base_msg	Message id base. Set this parameter if you want to use other then the default message id space. Make sure of not using the same space in other parts of your program.

Returns:

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

References fps_beginwindowmessaging().

bool EndWindowMessaging

(

)

[inline]

Ends window messaging process (WIN32 function).

After calling this function no further window messages nor freerun events will arrive.

Returns:

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

References fps_endwindowmessaging().

int StartBGProcesses

(

)

throw (gxError) [inline]

Starts automated background process (Linux function).

After starting the background process the freerun mode events will be raised. No threaded poll is needed to test for example the state of the button. To stop the messaging process call the StopBGProcesses() function.

Returns:

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

References fps_startbgprocesses().

int StopBGProcesses

(

)

[inline]

Ends the automated background process (Linux function).

After calling this function no further freerun events will arrive.

Returns:

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

References fps_stopbgprocesses().

bool Capture	(	int	timeout,
		int	quality,
		int	mode,
		int	fingerlist
	)			throw (gxError) [inline]

Scan fingers from captured images.

To set a callback function to inform the state of the capturing call the SetEventFunction() method. The captured images are stored in an internal array. The image handling functions are part of the api (draw, save, ...).

Parameters:

	timeout	Reading timeout, the function returns at timeout.
	quality	Quality threshold, the function returns when the quality of all fingers reaches the threshold.
	mode	Scan mode, FPS_IMPRESSION_TYPE.
	fingerlist	The finger list, having the format 0hhh 0000 iiii mmmm rrrr llll tttt ssss h - scan object: 001 left hand, 010 right hand, 011 same fingers of both hands i - index finger m - middle finger r - ring finger l - little finger t - left thumb s - right thumb The four bits are value of FPS_PRESENCE

Returns:

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

References fps_capture().

int CaptureStart	(	int	timeout,
		int	quality,
		int	mode,
		int	fingerlist
	)			throw (gxError) [inline]

Starts the finger image capturing process in asynchronous mode.

See FingerCapture() for details. Only one capture can be started at a time. The CaptureStatus() or the CaptureWait() methods must be called in order the system to call the Event function. (see SetEventFunction() )

Parameters:

	timeout	Reading timeout, the function returns at timeout.
	quality	Quality threshold, the function returns when the quality of all fingers reaches the threshold.
	mode	Scan mode, FPS_IMPRESSION_TYPE.
	fingerlist	The finger list, having the format 0hhh 0000 iiii mmmm rrrr llll tttt ssss h - scan object: 001 left hand, 010 right hand, 011 same fingers of both hands i - index finger m - middle finger r - ring finger l - little finger t - left thumb s - right thumb The four bits are value of FPS_PRESENCE

Returns:

Id for the CaptureStatus() and the CaptureWait() methods. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References fps_capture_start().

int CaptureStatus

(

int

reqid

)

throw (gxError) [inline]

Returns the state of an image capture process started with the CaptureStart() method.

If an internal event occurred this method calls the Event function.

Parameters:

reqid

Id for the capture. The CaptureStart() returned this value.

Returns:

The value of the result is the elapsed time in percent of timeout, it can be negative when the capture is in preprocess state. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References fps_capture_getstatus().

bool CaptureStop

(

)

throw (gxError) [inline]

Stops the capture process started with the CaptureStart() or the Capture() method before the timeout is elapsed.

The CaptureWait() method must be called in asynchronous mode anyway.

Returns:

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

References fps_capture_stop().

bool CaptureWait

(

int

reqid

)

throw (gxError) [inline]

Ends the capture process started with the CaptureStart() method.

If there are internal events waiting for report this method calls the Event function.

Parameters:

reqid

Id of the capture returned by the CaptureStart() method.

Returns:

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

References fps_capture_wait().

bool CapturePreview

(

int

windowid = 0

)

throw (gxError) [inline]

Captures a preview image.

The preview image is a small resolution real-time captured image. For preview light control the freerun_mode property must contain the FPS_FRMODE_PREVIEWLIGHT value.

Parameters:

windowid

RFU.

Returns:

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

References fps_capture_preview().

gxVariant* GetImage	(	int	smode,
		int	position,
		int	type
	)			throw (gxError) [inline]

The Fingerprint Scanner system has several functions for working with the captured images.

In special cases user functions can be used that are not supported by the system. This method returns an image packed into a gxVariant object. The image data can be accessed throught this object.

Parameters:

	smode	The actual scan mode of the image. The possible values are defined in FPS_IMPRESSION_TYPE enumeration.
	position	The finger position. The possible values are defined in the FPS_POSITION enumeration.
	type	The type of the image. The possible values are defined in the FPS_IMAGE_TYPE enumeration. If the type is FPS_IT_PREVIEW the smode and position parameters have no meanings.

Returns:

A gxVariant object that contains the image data. On error 0 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gxSystem::ClearError(), fps_getimage(), GX_ENOMEM, gx_unrefvariant(), and gxSystem::SetError().

bool SaveImage	(	int	smode,
		int	position,
		int	type,
		const wchar_t *	filename,
		int	filetype
	)			throw (gxError) [inline]

Saves an image to a file (Unicode version).

Parameters:

	smode	The actual scan mode of the image. The possible values are defined in FPS_IMPRESSION_TYPE enumeration.
	position	The finger position. The possible values are defined in the FPS_POSITION enumeration.
	type	The type of the image. The possible values are defined in the FPS_IMAGE_TYPE enumeration. If the type is FPS_IT_PREVIEW the smode and position parameters have no meanings.
	filename	The name of the file where to save the image.
	filetype	File type. The currently supported file types are defined in gximage.h.

Returns:

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

References fps_saveimage().

bool SaveImage	(	int	smode,
		int	position,
		int	type,
		const char *	filename,
		int	filetype
	)			throw (gxError) [inline]

Saves an image to a file (ASCII version).

Parameters:

	smode	The actual scan mode of the image. The possible values are defined in FPS_IMPRESSION_TYPE enumeration.
	position	The finger position. The possible values are defined in the FPS_POSITION enumeration.
	type	The type of the image. The possible values are defined in the FPS_IMAGE_TYPE enumeration. If the type is FPS_IT_PREVIEW the smode and position parameters have no meanings.
	filename	The name of the file where to save the image.
	filetype	File type. The currently supported file types are defined in gximage.h.

Returns:

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

References fps_saveimage().

bool SaveImage	(	int	smode,
		int	position,
		int	type,
		gxInStr	filename,
		int	filetype
	)			throw (gxError) [inline]

Saves an image to a file (Unicode version).

Parameters:

	smode	The actual scan mode of the image. The possible values are defined in FPS_IMPRESSION_TYPE enumeration.
	position	The finger position. The possible values are defined in the FPS_POSITION enumeration.
	type	The type of the image. The possible values are defined in the FPS_IMAGE_TYPE enumeration. If the type is FPS_IT_PREVIEW the smode and position parameters have no meanings.
	filename	The name of the file where to save the image.
	filetype	File type. The currently supported file types are defined in gximage.h.

Returns:

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

References fps_saveimage().

bool SaveImage	(	int	smode,
		int	position,
		int	type,
		gxInAStr	filename,
		int	filetype
	)			throw (gxError) [inline]

Saves an image to a file (ASCII version).

Parameters:

	smode	The actual scan mode of the image. The possible values are defined in FPS_IMPRESSION_TYPE enumeration.
	position	The finger position. The possible values are defined in the FPS_POSITION enumeration.
	type	The type of the image. The possible values are defined in the FPS_IMAGE_TYPE enumeration. If the type is FPS_IT_PREVIEW the smode and position parameters have no meanings.
	filename	The name of the file where to save the image.
	filetype	File type. The currently supported file types are defined in gximage.h.

Returns:

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

References fps_saveimage().

bool DisplayImage	(	int	smode,
		int	position,
		int	type,
		HDC	hdc,
		int	x,
		int	y,
		int	xsize,
		int	ysize,
		gxRCT *	frame
	)			throw (gxError) [inline]

Displays an image (WIN32 function).

Parameters:

	smode	The actual scan mode of the image. The possible values are defined in FPS_IMPRESSION_TYPE enumeration.
	position	The finger position. The possible values are defined in the FPS_POSITION enumeration.
	type	The type of the image. The possible values are defined in the FPS_IMAGE_TYPE enumeration. If the type is FPS_IT_PREVIEW the smode and position parameters have no meanings.
	hdc	Handle to the device context.
	x	Left side of the draw area.
	y	Upper side of the draw area.
	xsize	Horizontal size of the draw area.
	ysize	Vertical size of the draw area.
	frame	Frame of the area on the image to display.

Returns:

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

References fps_drawimage().

bool FingerToNist	(	const wchar_t *	filename,
		gxVariant *	fields
	)			throw (gxError) [inline]

Saves the fingers to an nist file (Unicode version).

Parameters:

	filename	The name of the file where to save the data.
	fields	List of fields to add to the record.

Returns:

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

References fps_fingertonist().

bool FingerToNist	(	const char *	filename,
		gxVariant *	fields
	)			throw (gxError) [inline]

Saves the fingers to an nist file (ASCII version).

Parameters:

	filename	The name of the file where to save the data.
	fields	List of fields to add to the record.

Returns:

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

References fps_fingertonist().

bool FingerToNistMem	(	void **	buffer,
		int *	buflen,
		gxVariant *	fields
	)			throw (gxError) [inline]

Saves the fingers to a memory area as a nist file.

Parameters:

	buffer	Pointer to the memory area pointer that is large enough or NULL.
	buflen	Size of memory area.
	fields	List of fields to add to the record.

Returns:

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

References fps_fingertonistmem().

bool FingerToNist	(	gxInStr	filename,
		gxVariant *	fields
	)			throw (gxError) [inline]

Saves the fingers to an nist file (Unicode version).

Parameters:

	filename	The name of the file where to save the data.
	fields	List of fields to add to the record.

Returns:

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

References fps_fingertonist().

bool FingerToNist	(	gxInAStr	filename,
		gxVariant *	fields
	)			throw (gxError) [inline]

Saves the fingers to an nist file (ASCII version).

Parameters:

	filename	The name of the file where to save the data.
	fields	List of fields to add to the record.

Returns:

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

References fps_fingertonist().

int NistFingerQuality

(

int

position

)

throw (gxError) [inline]

Returns the NIST Finger Image Quality value from a finger.

Parameters:

position

The finger position. The possible values are defined in the FPS_POSITION enumeration.

Returns:

NIST Finger Image Quality value. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References fps_nistfingerquality().

bool ResetFingerList

(

void

)

throw (gxError) [inline]

Clears all the finger image buffers and deletes the internal finger image structures.

It is NOT called automatically. Without calling this function the earlier scanned finger images are not deleted just replaced by quality update. Call this function to initiate a new finger scan process.

Returns:

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

References fps_resetfingerlist().