![]() |
The Fingerprint Scanner is a software product by ADAPTIVE RECOGNITION, which is for capturing and handling live fingerprints from ten fingers and it bases on the GX system. The fpsapi.h is the general interface file for the Fingerprint Scanner package.
Go to the source code of this file.
Typedefs | |
typedef void GXAPI | FPS_EVFUNC (int event, int param1, int param2, void *uparam) |
The event function is a callback function which is called during capture. | |
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_seteventfunction (gxHANDLE handle, FPS_EVFUNC *eventhandler, void *param) |
The event function is a callback function which is called during capture. | |
static int | fps_beginwindowmessaging (gxHANDLE handle, HWND hwnd, UINT base_msg) |
Starts window messaging process (WIN32 function). | |
static int | fps_endwindowmessaging (gxHANDLE handle) |
Ends window messaging process (WIN32 function). | |
static int | fps_startbgprocesses (gxHANDLE handle) |
Starts automated background process (Linux function). | |
static int | fps_stopbgprocesses (gxHANDLE handle) |
Ends the automated background process (Linux function). | |
static int | fps_capture (gxHANDLE handle, int timeout, int quality, int mode, int fingerlist) |
Scan fingers from captured images. | |
static int | fps_capture_start (gxHANDLE handle, int timeout, int quality, int mode, int fingerlist, int *reqid) |
Starts the finger image capturing process in asynchronous mode. | |
static int | fps_capture_getstatus (gxHANDLE handle, int reqid, int *status) |
Returns the state of an image capture process started with the fps_capture_start() function. | |
static int | fps_capture_stop (gxHANDLE handle) |
Stops the capture process started with the fps_capture_start() or the fps_capture() function before the timeout is elapsed. | |
static int | fps_capture_wait (gxHANDLE handle, int reqid) |
Ends the capture process started with the fps_capture_start() function. | |
static int | fps_capture_preview (gxHANDLE handle, int windowid) |
Captures a preview image. | |
static int | fps_getimage (gxHANDLE handle, int smode, int position, int type, gxVARIANT *img) |
Returns a captured image. | |
static int | fps_saveimage (gxHANDLE handle, int smode, int position, int type, const wchar_t *filename, int filetype) |
Saves an image to a file (Unicode version). | |
static int | fps_saveimagea (gxHANDLE handle, int smode, int position, int type, const char *filename, int filetype) |
Saves an image to a file (ASCII version). | |
static int | fps_drawimage (gxHANDLE handle, int smode, int position, int type, HDC hdc, int x, int y, int xsize, int ysize, gxRCT *frame) |
Displays an image (WIN32 function). | |
static int | fps_fingertonist (gxHANDLE handle, const wchar_t *filename, gxVARIANT fields) |
Saves the fingers to an nist file (Unicode version). | |
static int | fps_fingertonista (gxHANDLE handle, const char *filename, gxVARIANT fields) |
Saves the fingers to an nist file (ASCII version). | |
static int | fps_fingertonistmem (gxHANDLE handle, void **buffer, int *buflen, gxVARIANT fields) |
Saves the fingers to a memory area as a nist file. | |
static int | fps_fingerminutiatomem (gxHANDLE handle, void **buffer, int *buflen, gxVARIANT fields) |
Saves the minutiae to a memory area. | |
static int | fps_fingerminutiatofile (gxHANDLE handle, const wchar_t *filename, gxVARIANT fields) |
Saves the minutiae to a file. | |
static int | fps_fingerminutiatofilea (gxHANDLE handle, const char *filename, gxVARIANT fields) |
Saves the minutiae to a file (ASCII version). | |
static int | fps_nistfingerquality (gxHANDLE handle, int *quality, int position) |
Returns the NIST Finger Image Quality value from a finger. | |
static int | fps_resetfingerlist (gxHANDLE handle) |
Clears all the finger image buffers and deletes the internal finger image structures. |
static int fps_seteventfunction | ( | gxHANDLE | handle, | |
FPS_EVFUNC * | eventhandler, | |||
void * | param | |||
) | [static] |
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.
handle | Handle of the fpsapi module. | |
eventhandler | Reference to the callback function. | |
param | User parameter. |
References gx_call().
static int fps_beginwindowmessaging | ( | gxHANDLE | handle, | |
HWND | hwnd, | |||
UINT | base_msg | |||
) | [static] |
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 too. 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 fps_endwindowmessaging() function.
handle | Handle of the fpsapi module. | |
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. |
References gx_call().
static int fps_endwindowmessaging | ( | gxHANDLE | handle | ) | [static] |
Ends window messaging process (WIN32 function).
After calling this function no further window messages nor freerun events will arrive.
handle | Handle of the fpsapi module. |
References gx_call().
static int fps_startbgprocesses | ( | gxHANDLE | handle | ) | [static] |
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 fps_stopbgprocesses() function.
handle | Handle of the fpsapi module. |
References gx_call().
static int fps_stopbgprocesses | ( | gxHANDLE | handle | ) | [static] |
Ends the automated background process (Linux function).
After calling this function no further freerun events will arrive.
handle | Handle of the fpsapi module. |
References gx_call().
static int fps_resetfingerlist | ( | gxHANDLE | handle | ) | [static] |
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.
handle | Handle of the fpsapi module. |
References gx_call().