|
|
|
The Passport Reader is a travel document reader and analyser system by ARH Inc., which bases on the GX system. The prapi.h is the general interface file for the Passport Reader package.
Go to the source code of this file.
Classes | |
| class | prDoc |
| This class represents a recognized document structure in the PR system. More... | |
| class | prImage |
| This class represents a captured image in the PR system. More... | |
| class | PassportReader |
| This class contains functions that contol the Passport Reader system. More... | |
Typedefs | |
| typedef void GXAPI | PR_EVFUNC (int event, int param1, int param2, void *uparam) |
| The event function is a callback function which is called during capture. | |
Functions | |
| int | pr_getdevicelist (gxHANDLE handle, wchar_t ***devices, int *ndevices) |
| Returns a list of the available Passport Reader devices (Unicode version). | |
| int | pr_getdevicelista (gxHANDLE handle, char ***devices, int *ndevices) |
| Returns a list of the available Passport Reader devices (ASCII version). | |
| int | pr_getdevicelist (gxHANDLE handle, char ***devices, int *ndevices) |
| Returns a list of the available Passport Reader devices (ASCII version). | |
| int | pr_usedevice (gxHANDLE handle, const wchar_t *device, int mode) |
| Connects a PR device. | |
| int | pr_usedevicea (gxHANDLE handle, const char *device, int mode) |
| Conects to a PR device. | |
| int | pr_usedevicen (gxHANDLE handle, int devno, int mode) |
| Conects to a PR device. | |
| int | pr_usedevice (gxHANDLE handle, const char *device, int mode) |
| Conects to a PR device (ASCII version). | |
| int | pr_usedevice (gxHANDLE handle, int devno, int mode) |
| Conects to a PR device. | |
| int | pr_closedevice (gxHANDLE handle) |
| Disconnects the connected device. | |
| int | pr_getctrlhandle (gxHANDLE handle, gxHANDLE **hctrl) |
| Returns a handle of the capturing device. | |
| int | pr_calibrate (gxHANDLE handle, int windowid=0) |
| Calibrates the used device. | |
| int | pr_iscalibrated (gxHANDLE handle, int windowid=0) |
| Tests the calibrated state of the device. | |
| int | pr_testdocument (gxHANDLE handle, int *state, int windowid=0) |
| Gives back the result of the document (motion) detector module. | |
| int | pr_getlightnumber (gxHANDLE handle, int *lights) |
| Gives back the number of usable lights of the device. | |
| int | pr_getlightmask (gxHANDLE handle, int *lightmask, int lightid, int windowid) |
| Gives back a light mask for a given light and window. | |
| int | pr_getlightlist (gxHANDLE handle, int *lightbuf, int nlights) |
| Gives back a list of usable lights of the device. | |
| int | pr_getwindownumber (gxHANDLE handle, int *windows) |
| Gives back the number of object windows of the device. | |
| int | pr_setstatusled (gxHANDLE handle, int ledmask, int color) |
| Turns on/off the status leds. | |
| int | pr_blinkstatus (gxHANDLE handle, int coding, int mask, int type, int iteration, unsigned int *data, unsigned int datalength) |
| Blinks status outputs (led or buzzer). | |
| int | pr_testpower (gxHANDLE handle, int *state, int *level) |
| Gets the power state of the device. | |
| int | pr_testbutton (gxHANDLE handle, int keycode, int *state) |
| Gets the device's button state. | |
| int | pr_getbuttonevent (gxHANDLE handle, int *keycode, int *state) |
| Gets the device's next button event. | |
| int | pr_suspend (gxHANDLE handle) |
| Suspends the Passport Reader system. | |
| int | pr_wakeup (gxHANDLE handle) |
| Wakes up the previously suspended Passport Reader system. | |
| int | pr_getudinfo (gxHANDLE handle, int *nblocks, int *sblock) |
| Gets information about the available user data space. | |
| int | pr_readudata (gxHANDLE handle, int fblock, int nblocks, void **data) |
| Reads the user data from the device. | |
| int | pr_writeudata (gxHANDLE handle, int fblock, int nblocks, const void *data) |
| Writes the user data in the used device. | |
| int | pr_getdeviceinfo (gxHANDLE handle, gxVARIANT *devinfo) |
| Gets information about the device used. | |
| int | pr_selftest (gxHANDLE handle, int condition, gxVARIANT *result) |
| Performs a device self test. | |
| int | pr_readmagstripe (gxHANDLE handle, wchar_t ***tracks, int *ntracks) |
| Reads magnetic stripe (Unicode version). | |
| int | pr_readmagstripea (gxHANDLE handle, char ***tracks, int *ntracks) |
| Reads magnetic stripe (ASCII version). | |
| int | pr_readmagstripe (gxHANDLE handle, char ***tracks, int *ntracks) |
| Reads magnetic stripe (ASCII version). | |
| int | pr_seteventfunction (gxHANDLE handle, PR_EVFUNC *eventhandler, void *param) |
| The event function is a callback function which is called during capture. | |
| int | pr_beginwindowmessaging (gxHANDLE handle, HWND hwnd, UINT base_msg=WM_USER) |
| Starts window messaging process (WIN32 function). | |
| int | pr_endwindowmessaging (gxHANDLE handle) |
| Ends window messaging process (WIN32 function). | |
| int | pr_startbgprocesses (gxHANDLE handle) |
| Starts automated background process (Linux function). | |
| int | pr_stopbgprocesses (gxHANDLE handle) |
| Ends the automated background process (Linux function). | |
| int | pr_setpagelight (gxHANDLE handle, int pages, unsigned int *lights) |
| Sets the number of document pages to capture and the needed lights for each page. | |
| int | pr_capture (gxHANDLE handle) |
| Captures an image sequence from the object window of the PR device. | |
| int | pr_capture_start (gxHANDLE handle, int *reqid) |
| Starts the image capturing process in asynchronous mode. | |
| int | pr_capture_getstatus (gxHANDLE handle, int reqid, int *status) |
| Returns the state of an image capture process started with the pr_capture_start() function. | |
| int | pr_capture_wait (gxHANDLE handle, int reqid) |
| Ends the capture process started with the pr_capture_start() function. | |
| int | pr_capture_preview (gxHANDLE handle, int windowid=0) |
| Captures a preview image. | |
| int | pr_getimage (gxHANDLE handle, int page, int light, int type, gxVARIANT *img) |
| Returns a captured image. | |
| int | pr_getenhanceduv (gxHANDLE handle, int page, int imagetype, gxVARIANT *img) |
| Remove white backligthing from uv image. | |
| int | pr_saveimage (gxHANDLE handle, int page, int light, int type, const wchar_t *filename, int filetype) |
| Saves an image to a file (Unicode version). | |
| int | pr_saveimagea (gxHANDLE handle, int page, int light, int type, const char *filename, int filetype) |
| Saves an image to a file (ASCII version). | |
| int | pr_saveimage (gxHANDLE handle, int page, int light, int type, const char *filename, int filetype) |
| Saves an image to a file (ASCII version). | |
| int | pr_drawimage (gxHANDLE handle, int page, int light, int type, HDC hdc, int x, int y, int xsize, int ysize, gxRCT *frame) |
| Displays an image (WIN32 function). | |
| int | pr_fingertonist (gxHANDLE handle, const wchar_t *filename, gxVARIANT fields) |
| Saves the fingers to an nist file (Unicode version). | |
| int | pr_fingertonista (gxHANDLE handle, const char *filename, gxVARIANT fields) |
| Saves the fingers to an nist file (ASCII version). | |
| int | pr_fingertonist (gxHANDLE handle, const char *filename, gxVARIANT fields) |
| Saves the fingers to an nist file (ASCII version). | |
| int | pr_fingertonistmem (gxHANDLE handle, void **buffer, int *buflen, gxVARIANT fields) |
| Saves the fingers to a memory area as a nist file. | |
| int | pr_resetdocument (gxHANDLE handle, int lastpage=0) |
| Clears all the image and document buffers and deletes the internal image and document structures. | |
| int | pr_loaddocument (gxHANDLE handle, const wchar_t *filename, gxVARIANT *pdoc) |
| Loads a document from the mass storage device in the specific file format (Unicode version). | |
| int | pr_loaddocumenta (gxHANDLE handle, const char *filename, gxVARIANT *pdoc) |
| Loads a document from the mass storage device in the specific file format (ASCII version). | |
| int | pr_loaddocument (gxHANDLE handle, const char *filename, gxVARIANT *pdoc) |
| Loads a document from the mass storage device in the specific file format (ASCII version). | |
| int | pr_loaddocumentfrommem (gxHANDLE handle, const gxu8 *buffer, int buflen, gxVARIANT *pdoc) |
| Loads a document from the memory in the specific file format. | |
| int | pr_getocr (gxHANDLE handle, int page, int light, int type, gxVARIANT *doc, gxVARIANT ocrparams=0) |
| Reads the OCR from an unknown document. | |
| int | pr_getmrz (gxHANDLE handle, int page, int light, int type, gxVARIANT *doc) |
| Reads the MRZ lines from the document. | |
| int | pr_getbarcode (gxHANDLE handle, int page, int light, int type, int bctype, int index, gxVARIANT *doc) |
| Reads the barcodes from an unknown document. | |
| int | pr_getdocumentrect (gxHANDLE handle, int page, int light, int type, gxVARIANT *doc) |
| Returns the quad of the document. | |
| int | pr_recognize (gxHANDLE handle, int page, gxVARIANT *doc) |
| Reads all of the known data from a known document type. | |
| int | pr_analyze (gxHANDLE handle, gxVARIANT page, int tasklen, int *task, gxVARIANT *doc) |
| Reads the data specified in task array from the document. | |
| int | pr_analyzed (gxHANDLE handle, gxu8 *buffer, int buflen, gxVARIANT *doc) |
| Separates and processes the data fields in a given binary data array. | |
| int | pr_analyze (gxHANDLE handle, gxu8 *buffer, int buflen, gxVARIANT *doc) |
| Separates and processes the data fields in a given binary data array. | |
| int | pr_resolvemrztext (gxHANDLE handle, const wchar_t **lines, int nlines, gxVARIANT *doc) |
| Separates the data fields in the given MRZ text (Unicode version). | |
| int | pr_resolvemrztexta (gxHANDLE handle, const char **lines, int nlines, gxVARIANT *doc) |
| Separates the data fields in the given MRZ text (ASCII version). | |
| int | pr_resolvemrztext (gxHANDLE handle, const char **lines, int nlines, gxVARIANT *doc) |
| Separates the data fields in the given MRZ text (ASCII version). | |
| int | pr_getdocumentstatus (gxHANDLE handle, gxVARIANT doc, int *code, int *status) |
| Document structure analyser function, it gives back the main document properties. | |
| int | pr_getfieldfromdoc (gxHANDLE handle, gxVARIANT doc, int field_code, int index, gxVARIANT *field) |
| Document structure analyser function and gives back the properties of a field. | |
| int | pr_getfieldfromdocw (gxHANDLE handle, gxVARIANT doc, int field_code, wchar_t *text, int *stext, int *status, gxPG4 *frame) |
| Document structure analyser function and gives back the properties of a field (Unicode version). | |
| int | pr_getfieldfromdoc (gxHANDLE handle, gxVARIANT doc, int field_code, wchar_t *text, int *stext, int *status, gxPG4 *frame) |
| Document structure analyser function and gives back the properties of a field (Unicode version). | |
| int | pr_getfieldfromdoc (gxHANDLE handle, const gxVARIANT doc, int field_code, wchar_t *text, int stext, int *status, gxPG4 *frame) |
| Document structure analyser function and gives back the properties of a field (Unicode version). | |
| int | pr_getfieldfromdoca (gxHANDLE handle, gxVARIANT doc, int field_code, char *text, int *stext, int *status, gxPG4 *frame) |
| Document structure analyser function and gives back the properties of a field (ASCII version). | |
| int | pr_getfieldfromdoc (gxHANDLE handle, gxVARIANT doc, int field_code, char *text, int *stext, int *status, gxPG4 *frame) |
| Document structure analyser function and gives back the properties of a field (ASCII version). | |
| int | pr_getfieldfromdoc (gxHANDLE handle, gxVARIANT doc, int field_code, char *text, int stext, int *status, gxPG4 *frame) |
| Document structure analyser function and gives back the properties of a field (ASCII version). | |
| int | pr_getfieldfromdocb (gxHANDLE handle, gxVARIANT doc, int field_code, void *data, int *sdata, int *status, gxPG4 *frame) |
| Document structure analyser function and gives back the properties of a field (Binary version). | |
| int | pr_getfieldfromdoc (gxHANDLE handle, gxVARIANT doc, int field_code, void *data, int *sdata, int *status, gxPG4 *frame) |
| Document structure analyser function and gives back the properties of a field (Binary version). | |
| int | pr_getfieldfromdoc (gxHANDLE handle, gxVARIANT doc, int field_code, void *data, int sdata, int *status, gxPG4 *frame) |
| This is a document structure analyser function and gives back the properties of a field (Binary version). | |
| int | pr_getfieldimage (gxHANDLE handle, gxVARIANT doc, int field_code, int index, gxVARIANT *img) |
| Returns a variant image from the document structure. | |
| int | pr_getgximagefromdoc (gxHANDLE handle, gxVARIANT doc, int field_code, gxIMAGE **img) |
| Returns a gxIMAGE from the document structure. | |
| int | pr_getpropfromdoc (gxHANDLE handle, gxVARIANT doc, int field_code, int prop_code, void *data, int *sdata, int *data_type) |
| Returns a property field from the document structure. | |
| int | pr_compareface (gxHANDLE handle, int page, int face_no, gxVARIANT *doc) |
| Compares a captured face photo with one that is stored in rfid chip. | |
| int | pr_savedocument (gxHANDLE handle, gxVARIANT pdoc, const wchar_t *filename, int filetype) |
| Saves a document to a mass storage device in the specific file format (Unicode version). | |
| int | pr_savedocumenta (gxHANDLE handle, gxVARIANT pdoc, const char *filename, int filetype) |
| Saves a document to a mass storage device in the specific file format (ASCII version). | |
| int | pr_savedocument (gxHANDLE handle, gxVARIANT pdoc, const char *filename, int filetype) |
| Saves a document to a mass storage device in the specific file format (ASCII version). | |
| int | pr_savedocumenttomem (gxHANDLE handle, gxVARIANT pdoc, gxu8 **buffer, int *buflen, int filetype) |
| Saves a document to memory in the specific file format. | |
| int | pr_getdocumentroot (gxHANDLE handle, gxVARIANT *pdoc) |
| Returns the root document of the PR system. | |
| int | pr_decodelatentimage (gxHANDLE handle, int page, int light, int type, const wchar_t *decpar, gxVARIANT *image) |
| Decodes a latent image from a stored image. | |
| int | pr_resolvemagstripe (gxHANDLE handle, const wchar_t **tracks, int ntracks, gxVARIANT *doc) |
| Separates the data fields in the given magnetic stripe text (Unicode version). | |
| int | pr_resolvemagstripea (gxHANDLE handle, const char **tracks, int ntracks, gxVARIANT *doc) |
| Separates the data fields in the given magnetic stripe text (ASCII version). | |
| int | pr_resolvemagstripe (gxHANDLE handle, const char **tracks, int ntracks, gxVARIANT *doc) |
| Separates the data fields in the given magnetic stripe text (ASCII version). | |
| int | pr_getrfidcardlist (gxHANDLE handle, wchar_t ***cards, int *ncards) |
| Gets the list of cards in the range of the contactless reader (Unicode version). | |
| int | pr_getrfidcardlista (gxHANDLE handle, char ***cards, int *ncards) |
| Gets the list of cards in the range of the contactless reader (ASCII version). | |
| int | pr_getrfidcardlist (gxHANDLE handle, char ***cards, int *ncards) |
| Gets the list of cards in the range of the contactless reader (ASCII version). | |
| int | pr_getrfidfile (gxHANDLE handle, const wchar_t *card, int fileid, void **data, int *sdata) |
| Reads files from the RFID card (Unicode version). | |
| int | pr_getrfidfilea (gxHANDLE handle, const char *card, int fileid, void **data, int *sdata) |
| Reads files from the RFID card (ASCII version). | |
| int | pr_getrfidfile (gxHANDLE handle, const char *card, int fileid, void **data, int *sdata) |
| Reads files from the RFID card (ASCII version). | |
| int | pr_getrfidfile_start (gxHANDLE handle, const wchar_t *card, int fileid, int *reqid) |
| Starts reading files from the RFID card in asynchronous mode. | |
| int | pr_getrfidfile_starta (gxHANDLE handle, const char *card, int fileid, int *reqid) |
| Starts reading files from the RFID card in asynchronous mode. | |
| int | pr_getrfidfile_start (gxHANDLE handle, const char *card, int fileid, int *reqid) |
| Starts reading files from the RFID card in asynchronous mode. | |
| int | pr_getrfidfile_getstatus (gxHANDLE handle, int reqid, int *status) |
| Returns the state of a rfid reading process started with the pr_getrfidfile_start() function. | |
| int | pr_getrfidfile_wait (gxHANDLE handle, int reqid, void **data, int *sdata) |
| Wait for the finish of the rfid reading process started with the pr_getrfidfile_start() function. | |
| int | pr_getrfidfile_stop (gxHANDLE handle) |
| Cancel the rfid reading process started with the pr_getrfidfile_start() function. | |
| int | pr_resolverfiddata (gxHANDLE handle, const void *data, int sdata, gxVARIANT *doc) |
| Resolves a composite RFID data and fills a document structure with the descompounded data. | |
| int | pr_getapplications (gxHANDLE handle, const wchar_t *card, int **apps, int *napps) |
| Get applications supported by the card. | |
| int | pr_getapplicationsa (gxHANDLE handle, const char *card, int **apps, int *napps) |
| Get applications supported by the card. | |
| int | pr_getapplications (gxHANDLE handle, const char *card, int **apps, int *napps) |
| Get applications supported by the card. | |
| int | pr_selectapplication (gxHANDLE handle, const wchar_t *card, int application) |
| Select the chip application. | |
| int | pr_selectapplicationa (gxHANDLE handle, const char *card, int application) |
| Select the chip application. | |
| int | pr_selectapplication (gxHANDLE handle, const char *card, int application) |
| Select the chip application. | |
| int | pr_makebac (gxHANDLE handle, const wchar_t *card, const wchar_t **lines, int nlines) |
| Switches to secure messaging by making Basic Access Control (Unicode version). | |
| int | pr_makebaca (gxHANDLE handle, const char *card, const char **lines, int nlines) |
| Switches to secure messaging by making Basic Access Control (ASCII version). | |
| int | pr_makebac (gxHANDLE handle, const char *card, const char **lines, int nlines) |
| Switches to secure messaging by making Basic Access Control (ASCII version). | |
| int | pr_makepace (gxHANDLE handle, const wchar_t *card, const wchar_t **lines, int nlines, int PasswordType) |
| Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (Unicode version). | |
| int | pr_makepacea (gxHANDLE handle, const char *card, const char **lines, int nlines, int PasswordType) |
| Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (ASCII version). | |
| int | pr_makepace (gxHANDLE handle, const char *card, const char **lines, int nlines, int PasswordType) |
| Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (ASCII version). | |
| int | pr_makepassiveauth (gxHANDLE handle, const wchar_t *card) |
| Makes the Passive Authentication of the RFID chip (Unicode version). | |
| int | pr_makepassiveautha (gxHANDLE handle, const char *card) |
| Makes the Passive Authentication of the RFID chip (ASCII version). | |
| int | pr_makepassiveauth (gxHANDLE handle, const char *card) |
| Makes the Passive Authentication of the RFID chip (ASCII version). | |
| int | pr_makeactiveauth (gxHANDLE handle, const wchar_t *card) |
| Makes the Active Authentication of the RFID chip (Unicode version). | |
| int | pr_makeactiveautha (gxHANDLE handle, const char *card) |
| Makes the Active Authentication of the RFID chip (ASCII version). | |
| int | pr_makeactiveauth (gxHANDLE handle, const char *card) |
| Makes the Active Authentication of the RFID chip (ASCII version). | |
| int | pr_makechipauth (gxHANDLE handle, const wchar_t *card) |
| Makes the Chip Authentication of the RFID chip (Unicode version). | |
| int | pr_makechipautha (gxHANDLE handle, const char *card) |
| Makes the Chip Authentication of the RFID chip (ASCII version). | |
| int | pr_makechipauth (gxHANDLE handle, const char *card) |
| Makes the Chip Authentication of the RFID chip (ASCII version). | |
| int | pr_maketerminalauth (gxHANDLE handle, const wchar_t *card) |
| Makes the Terminal Authentication of the RFID chip (Unicode version). | |
| int | pr_maketerminalautha (gxHANDLE handle, const char *card) |
| Makes the Terminal Authentication of the RFID chip (ASCII version). | |
| int | pr_maketerminalauth (gxHANDLE handle, const char *card) |
| Makes the Terminal Authentication of the RFID chip (ASCII version). | |
| int | pr_initta (gxHANDLE handle, const wchar_t *card, void **data, int *sdata) |
| Initiates the Terminal Authentication of the RFID chip (Unicode version). | |
| int | pr_inittaa (gxHANDLE handle, const char *card, void **data, int *sdata) |
| Initiates the Terminal Authentication of the RFID chip (ASCII version). | |
| int | pr_initta (gxHANDLE handle, const char *card, void **data, int *sdata) |
| Initiates the Terminal Authentication of the RFID chip (ASCII version). | |
| int | pr_completeta (gxHANDLE handle, const wchar_t *card, const void *data, int sdata) |
| Completes the Terminal Authentication of the RFID chip (Unicode version). | |
| int | pr_completetaa (gxHANDLE handle, const char *card, const void *data, int sdata) |
| Completes the Terminal Authentication of the RFID chip (ASCII version). | |
| int | pr_completeta (gxHANDLE handle, const char *card, const void *data, int sdata) |
| Completes the Terminal Authentication of the RFID chip (ASCII version). | |
| int | pr_loadcertfile (gxHANDLE handle, const wchar_t *certificate, const wchar_t *privateKey=NULL) |
| Loads a certificate and a private key from file (Unicode version). | |
| int | pr_loadcertfilea (gxHANDLE handle, const char *certificate, const char *privateKey=NULL) |
| Loads a certificate and a private key from file (ASCII version). | |
| int | pr_loadcertfile (gxHANDLE handle, const char *certificate, const char *privateKey=NULL) |
| Loads a certificate and a private key from file (ASCII version). | |
| int | pr_loadcertfromstore (gxHANDLE handle, const wchar_t *storename) |
| Loads certificates and CRLs from store (Unicode version). | |
| int | pr_loadcertfromstorea (gxHANDLE handle, const char *storename) |
| Loads certificates and CRLs from store (ASCII version). | |
| int | pr_loadcertfromstore (gxHANDLE handle, const char *storename) |
| Loads certificates and CRLs from store (ASCII version). | |
| int | pr_loadcertfrommem (gxHANDLE handle, void *certificate_data, unsigned int certificate_length, void *privateKey_data=NULL, unsigned int privateKey_length=0) |
| Loads a certificate and a private key from memory. | |
| int | pr_clearcertlist (gxHANDLE handle, int sel) |
| Clears the internal certificate list. | |
| int | pr_connectrfidcard (gxHANDLE handle, const wchar_t *card) |
| Connects to an RFID card (Unicode version). | |
| int | pr_connectrfidcarda (gxHANDLE handle, const char *card) |
| Connects to an RFID card (ASCII version). | |
| int | pr_connectrfidcard (gxHANDLE handle, const char *card) |
| Connects to an RFID card (ASCII version). | |
| int | pr_disconnectrfidcard (gxHANDLE handle, const wchar_t *card) |
| Disconnects from RFID card (Unicode version). | |
| int | pr_disconnectrfidcarda (gxHANDLE handle, const char *card) |
| Disconnects from an RFID card (ASCII version). | |
| int | pr_disconnectrfidcard (gxHANDLE handle, const char *card) |
| Disconnects from an RFID card (ASCII version). | |
| int | pr_checkrfidfilehash (gxHANDLE handle, const wchar_t *card, int fileid) |
| Checks the hash of the file read from the RFID card (Unicode version). | |
| int | pr_checkrfidfilehasha (gxHANDLE handle, const char *card, int fileid) |
| Checks the hash of the file read from the RFID card (ASCII version). | |
| int | pr_checkrfidfilehash (gxHANDLE handle, const char *card, int fileid) |
| Checks the hash of the file read from the RFID card (ASCII version). | |
| int | pr_getrfidcardinfo (gxHANDLE handle, const wchar_t *card, gxVARIANT *cardinfo) |
| Gets information about the rfid card (Unicode version). | |
| int | pr_getrfidcardinfoa (gxHANDLE handle, const char *card, gxVARIANT *cardinfo) |
| Gets information about the rfid card (ASCII version). | |
| int | pr_getrfidcardinfo (gxHANDLE handle, const char *card, gxVARIANT *cardinfo) |
| Gets information about the rfid card (ASCII version). | |
| int | pr_getcertificateid (gxHANDLE handle, const wchar_t *card, int Authentication, gxVARIANT *CertificateId) |
| Gets information about certificate (Unicode version). | |
| int | pr_getcertificateida (gxHANDLE handle, const char *card, int Authentication, gxVARIANT *CertificateId) |
| Gets information about certificate (ASCII version). | |
| int | pr_getcertificateid (gxHANDLE handle, const char *card, int Authentication, gxVARIANT *CertificateId) |
| Gets information about certificate (ASCII version). | |
| int | pr_getnextauthentication (gxHANDLE handle, const wchar_t *card, int *Authentication, int ForceNext=false) |
| Gets information about the next suggested authentication process (Unicode version). | |
| int | pr_getnextauthenticationa (gxHANDLE handle, const char *card, int *Authentication, int ForceNext=false) |
| Gets information about the next suggested authentication process (Unicode version). | |
| int | pr_getnextauthentication (gxHANDLE handle, const char *card, int *Authentication, int ForceNext=false) |
| Gets information about the next suggested authentication process (ASCII version). | |
| int | pr_doauthentication (gxHANDLE handle, const wchar_t *card, int Authentication, const wchar_t **AuthData=0, int Lines=0, int PasswordType=PR_PACE_PW_MRZ) |
| Making authentication process (ASCII version). | |
| int | pr_doauthenticationa (gxHANDLE handle, const char *card, int Authentication, const char **AuthData=0, int Lines=0, int PasswordType=PR_PACE_PW_MRZ) |
| Making authentication process (Unicode version). | |
| int | pr_doauthentication (gxHANDLE handle, const char *card, int Authentication, const char **AuthData=0, int Lines=0, int PasswordType=PR_PACE_PW_MRZ) |
| Making authentication process (ASCII version). | |
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 PR_EVENT enumeration. The invoked event types can be set through the event_types property.
| handle | Handle of the prapi module. | |
| eventhandler | Reference to the callback function. | |
| param | User parameter. |
References gx_call().
Referenced by PassportReader::SetEventFunction().
| int pr_beginwindowmessaging | ( | gxHANDLE | handle, | |
| 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 PR 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 pr_endwindowmessaging() function.
| handle | Handle of the prapi 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 than the default message id space. Make sure of not using the same space in other parts of your program. |
References gx_call().
Referenced by PassportReader::BeginWindowMessaging().
| int pr_endwindowmessaging | ( | gxHANDLE | handle | ) | [inline] |
Ends window messaging process (WIN32 function).
After calling this function no further window messages nor freerun events will arrive.
| handle | Handle of the prapi module. |
References gx_call().
Referenced by PassportReader::EndWindowMessaging().
| int pr_startbgprocesses | ( | gxHANDLE | handle | ) | [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 pr_stopbgprocesses() function.
| handle | Handle of the prapi module. |
References gx_call().
Referenced by PassportReader::StartBGProcesses().
| int pr_stopbgprocesses | ( | gxHANDLE | handle | ) | [inline] |
Ends the automated background process (Linux function).
After calling this function no further freerun events will arrive.
| handle | Handle of the prapi module. |
References gx_call().
Referenced by PassportReader::StopBGProcesses().
Saves the fingers to an nist file (Unicode version).
| handle | Handle of the prapi module. | |
| filename | The name of the file where to save the data. | |
| fields | List of fields to add to the record. |
References gx_call().
Referenced by PassportReader::FingerToNist().
Saves the fingers to an nist file (ASCII version).
| handle | Handle of the prapi module. | |
| filename | The name of the file where to save the data. | |
| fields | List of fields to add to the record. |
References gx_call().
Referenced by pr_fingertonist().
Saves the fingers to an nist file (ASCII version).
| handle | Handle of the prapi module. | |
| filename | The name of the file where to save the data. | |
| fields | List of fields to add to the record. |
References pr_fingertonista().
Saves the fingers to a memory area as a nist file.
| handle | Handle of the prapi module. | |
| 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. |
References gx_call().
Referenced by PassportReader::FingerToNistMem().
| int pr_resetdocument | ( | gxHANDLE | handle, | |
| int | lastpage = 0 | |||
| ) | [inline] |
Clears all the image and document buffers and deletes the internal image and document structures.
It is called automatically when each previously set number of pages are captured and a new capture process is started, or when the number of pages are modified and the actual page number is greater than the new number of pages.
| handle | Handle of the prapi module. | |
| lastpage | Set it to true for reset only the last captured page. |
References gx_call().
Referenced by PassportReader::ResetDocument().
Loads a document from the mass storage device in the specific file format (Unicode version).
| handle | Handle of the prapi module. | |
| filename | Name of the file to load the document from. | |
| pdoc | Pointer to the document structure pointer that will contain the pointer to the loaded document on success. |
References gx_call().
Referenced by PassportReader::LoadDocument().
Loads a document from the mass storage device in the specific file format (ASCII version).
| handle | Handle of the prapi module. | |
| filename | Name of the file to load the document from. | |
| pdoc | Pointer to the document structure pointer that will contain the pointer to the loaded document on success. |
References gx_call().
Referenced by pr_loaddocument().
Loads a document from the mass storage device in the specific file format (ASCII version).
| handle | Handle of the prapi module. | |
| filename | Name of the file to load the document from. | |
| pdoc | Pointer to the document structure pointer that will contain the pointer to the loaded document on success. |
References pr_loaddocumenta().
| int pr_loaddocumentfrommem | ( | gxHANDLE | handle, | |
| const gxu8 * | buffer, | |||
| int | buflen, | |||
| gxVARIANT * | pdoc | |||
| ) | [inline] |
Loads a document from the memory in the specific file format.
| handle | Handle of the prapi module. | |
| buffer | Pointer to the data. | |
| buflen | Length of data in bytes. | |
| pdoc | Pointer to the document structure pointer that will contain the pointer to the loaded document on success. |
References gx_call().
Referenced by PassportReader::LoadDocumentFromMem().