Header

prapi.h File Reference


Detailed Description

Passport Reader Api functions

The Passport Reader is a travel document reader and analyser system by ADAPTIVE RECOGNITION, 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.

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

static int pr_getdevicelist (gxHANDLE handle, wchar_t ***devices, int *ndevices)
 Returns a list of the available Passport Reader devices (Unicode version).
static int pr_getdevicelista (gxHANDLE handle, char ***devices, int *ndevices)
 Returns a list of the available Passport Reader devices (ASCII version).
static int pr_usedevice (gxHANDLE handle, const wchar_t *device, int mode)
 Connects a PR device.
static int pr_usedevicea (gxHANDLE handle, const char *device, int mode)
 Conects to a PR device.
static int pr_usedevicen (gxHANDLE handle, int devno, int mode)
 Conects to a PR device.
static int pr_closedevice (gxHANDLE handle)
 Disconnects the connected device.
static int pr_getctrlhandle (gxHANDLE handle, gxHANDLE **hctrl)
 Returns a handle of the capturing device.
static int pr_calibrate (gxHANDLE handle, int windowid)
 Calibrates the used device.
static int pr_iscalibrated (gxHANDLE handle, int windowid)
 Tests the calibrated state of the device.
static int pr_testdocument (gxHANDLE handle, int *state, int windowid)
 Gives back the result of the document (motion) detector module.
static int pr_getlightnumber (gxHANDLE handle, int *lights)
 Gives back the number of usable lights of the device.
static int pr_getlightmask (gxHANDLE handle, int *lightmask, int lightid, int windowid)
 Gives back a light mask for a given light and window.
static int pr_getlightlist (gxHANDLE handle, int *lightbuf, int nlights)
 Gives back a list of usable lights of the device.
static int pr_getwindownumber (gxHANDLE handle, int *windows)
 Gives back the number of object windows of the device.
static int pr_setstatusled (gxHANDLE handle, int ledmask, int color)
 Turns on/off the status leds.
static 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).
static int pr_testpower (gxHANDLE handle, int *state, int *level)
 Gets the power state of the device.
static int pr_testbutton (gxHANDLE handle, int keycode, int *state)
 Gets the device's button state.
static int pr_getbuttonevent (gxHANDLE handle, int *keycode, int *state)
 Gets the device's next button event.
static int pr_suspend (gxHANDLE handle)
 Suspends the Passport Reader system.
static int pr_wakeup (gxHANDLE handle)
 Wakes up the previously suspended Passport Reader system.
static int pr_getudinfo (gxHANDLE handle, int *nblocks, int *sblock)
 Gets information about the available user data space.
static int pr_readudata (gxHANDLE handle, int fblock, int nblocks, void **data)
 Reads the user data from the device.
static int pr_writeudata (gxHANDLE handle, int fblock, int nblocks, const void *data)
 Writes the user data in the used device.
static int pr_getdeviceinfo (gxHANDLE handle, gxVARIANT *devinfo)
 Gets information about the device used.
static int pr_selftest (gxHANDLE handle, int condition, gxVARIANT *result)
 Performs a device self test.
static int pr_readmagstripe (gxHANDLE handle, wchar_t ***tracks, int *ntracks)
 Reads magnetic stripe (Unicode version).
static int pr_readmagstripea (gxHANDLE handle, char ***tracks, int *ntracks)
 Reads magnetic stripe (ASCII version).
static int pr_getlicenses (gxHANDLE handle, int **licenses, int *nlicenses)
 Returns a list of available licenses.
static int pr_getlicensedate (gxHANDLE handle, int license, wchar_t **date)
 Returns the engine acceptance date of a license.
static int pr_getengineinfo (gxHANDLE handle, gxVARIANT *info)
 Returns information about the used engine.
static int pr_seteventfunction (gxHANDLE handle, PR_EVFUNC *eventhandler, void *param)
 The event function is a callback function which is called during capture.
static int pr_beginwindowmessaging (gxHANDLE handle, HWND hwnd, UINT base_msg)
 Starts window messaging process (WIN32 function).
static int pr_endwindowmessaging (gxHANDLE handle)
 Ends window messaging process (WIN32 function).
static int pr_startbgprocesses (gxHANDLE handle)
 Starts automated background process (Linux function).
static int pr_stopbgprocesses (gxHANDLE handle)
 Ends the automated background process (Linux function).
static int pr_getdataformat (gxHANDLE handle, const gxu8 *databuf, int buflen, wchar_t *format, int fmtlen)
 Returns the file format type of a given binary data.
static 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.
static int pr_capture (gxHANDLE handle)
 Captures an image sequence from the object window of the PR device.
static int pr_capture_start (gxHANDLE handle, int *reqid)
 Starts the image capturing process in asynchronous mode.
static 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.
static int pr_capture_wait (gxHANDLE handle, int reqid)
 Ends the capture process started with the pr_capture_start() function.
static int pr_capture_preview (gxHANDLE handle, int windowid)
 Captures a preview image.
static int pr_getimage (gxHANDLE handle, int page, int light, int type, gxVARIANT *img)
 Returns a captured image.
static int pr_getenhanceduv (gxHANDLE handle, int page, int imagetype, gxVARIANT *img)
 Remove white backligthing from uv image.
static 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).
static int pr_saveimagea (gxHANDLE handle, int page, int light, int type, const char *filename, int filetype)
 Saves an image to a file (ASCII version).
static 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).
static int pr_fingertonist (gxHANDLE handle, const wchar_t *filename, gxVARIANT fields)
 Saves the fingers to an nist file (Unicode version).
static int pr_fingertonista (gxHANDLE handle, const char *filename, gxVARIANT fields)
 Saves the fingers to an nist file (ASCII version).
static int pr_fingertonistmem (gxHANDLE handle, void **buffer, int *buflen, gxVARIANT fields)
 Saves the fingers to a memory area as a nist file.
static int pr_resetdocument (gxHANDLE handle, int lastpage)
 Clears all the image and document buffers and deletes the internal image and document structures.
static 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).
static 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).
static int pr_loaddocumentfrommem (gxHANDLE handle, const gxu8 *buffer, int buflen, gxVARIANT *pdoc)
 Loads a document from the memory in the specific file format.
static int pr_getocr (gxHANDLE handle, int page, int light, int type, gxVARIANT *doc, gxVARIANT ocrparams)
 Reads the OCR from an unknown document.
static int pr_getmrz (gxHANDLE handle, int page, int light, int type, gxVARIANT *doc)
 Reads the MRZ lines from the document.
static int pr_getbarcode (gxHANDLE handle, int page, int light, int type, int bctype, int index, gxVARIANT *doc)
 Reads the barcodes from an unknown document.
static int pr_getdocumentrect (gxHANDLE handle, int page, int light, int type, gxVARIANT *doc)
 Returns the quad of the document.
static int pr_recognize (gxHANDLE handle, int page, gxVARIANT *doc)
 Reads all of the known data from a known document type.
static int pr_analyze (gxHANDLE handle, gxVARIANT page, int tasklen, int *task, gxVARIANT *doc)
 Reads the data specified in task array from the document.
static int pr_analyzed (gxHANDLE handle, gxu8 *buffer, int buflen, gxVARIANT *doc, const wchar_t *comment)
 Separates and processes the data fields in a given binary data array.
static int pr_resolvemrztext (gxHANDLE handle, const wchar_t **lines, int nlines, gxVARIANT *doc)
 Separates the data fields in the given MRZ text (Unicode version).
static int pr_resolvemrztexta (gxHANDLE handle, const char **lines, int nlines, gxVARIANT *doc)
 Separates the data fields in the given MRZ text (ASCII version).
static int pr_getdocumentstatus (gxHANDLE handle, gxVARIANT doc, int *code, int *status)
 Document structure analyser function, it gives back the main document properties.
static 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.
static 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).
static 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).
static 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).
static int pr_getfieldimage (gxHANDLE handle, gxVARIANT doc, int field_code, int index, gxVARIANT *img)
 Returns a variant image from the document structure.
static int pr_getgximagefromdoc (gxHANDLE handle, gxVARIANT doc, int field_code, gxIMAGE **img)
 Returns a gxIMAGE from the document structure.
static 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.
static 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.
static 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).
static 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).
static int pr_savedocumenttomem (gxHANDLE handle, gxVARIANT pdoc, gxu8 **buffer, int *buflen, int filetype)
 Saves a document to memory in the specific file format.
static int pr_getdocumentroot (gxHANDLE handle, gxVARIANT *pdoc)
 Returns the root document of the PR system.
static 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.
static 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).
static int pr_resolvemagstripea (gxHANDLE handle, const char **tracks, int ntracks, gxVARIANT *doc)
 Separates the data fields in the given magnetic stripe text (ASCII version).
static int pr_mergedocument (gxHANDLE handle, gxVARIANT doc1, gxVARIANT doc2, gxVARIANT *pdoc)
 Merges two documents.
static int pr_getrfidcardlist (gxHANDLE handle, wchar_t ***cards, int *ncards)
 Gets the list of cards in the range of the contactless reader (Unicode version).
static int pr_getrfidcardlista (gxHANDLE handle, char ***cards, int *ncards)
 Gets the list of cards in the range of the contactless reader (ASCII version).
static int pr_getrfidfile (gxHANDLE handle, const wchar_t *card, int fileid, void **data, int *sdata)
 Reads files from the RFID card (Unicode version).
static int pr_getrfidfilea (gxHANDLE handle, const char *card, int fileid, void **data, int *sdata)
 Reads files from the RFID card (ASCII version).
static int pr_getrfidfile_start (gxHANDLE handle, const wchar_t *card, int fileid, int *reqid)
 Starts reading files from the RFID card in asynchronous mode.
static int pr_getrfidfile_starta (gxHANDLE handle, const char *card, int fileid, int *reqid)
 Starts reading files from the RFID card in asynchronous mode.
static 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.
static 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.
static int pr_getrfidfile_stop (gxHANDLE handle)
 Cancel the rfid reading process started with the pr_getrfidfile_start() function.
static 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.
static int pr_getapplications (gxHANDLE handle, const wchar_t *card, int **apps, int *napps)
 Get applications supported by the card.
static int pr_getapplicationsa (gxHANDLE handle, const char *card, int **apps, int *napps)
 Get applications supported by the card.
static int pr_selectapplication (gxHANDLE handle, const wchar_t *card, int application)
 Select the chip application.
static int pr_selectapplicationa (gxHANDLE handle, const char *card, int application)
 Select the chip application.
static 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).
static int pr_makebaca (gxHANDLE handle, const char *card, const char **lines, int nlines)
 Switches to secure messaging by making Basic Access Control (ASCII version).
static 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).
static 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).
static int pr_makepassiveauth (gxHANDLE handle, const wchar_t *card)
 Makes the Passive Authentication of the RFID chip (Unicode version).
static int pr_makepassiveautha (gxHANDLE handle, const char *card)
 Makes the Passive Authentication of the RFID chip (ASCII version).
static int pr_makeactiveauth (gxHANDLE handle, const wchar_t *card)
 Makes the Active Authentication of the RFID chip (Unicode version).
static int pr_makeactiveautha (gxHANDLE handle, const char *card)
 Makes the Active Authentication of the RFID chip (ASCII version).
static int pr_makechipauth (gxHANDLE handle, const wchar_t *card)
 Makes the Chip Authentication of the RFID chip (Unicode version).
static int pr_makechipautha (gxHANDLE handle, const char *card)
 Makes the Chip Authentication of the RFID chip (ASCII version).
static int pr_maketerminalauth (gxHANDLE handle, const wchar_t *card)
 Makes the Terminal Authentication of the RFID chip (Unicode version).
static int pr_maketerminalautha (gxHANDLE handle, const char *card)
 Makes the Terminal Authentication of the RFID chip (ASCII version).
static int pr_initta (gxHANDLE handle, const wchar_t *card, void **data, int *sdata)
 Initiates the Terminal Authentication of the RFID chip (Unicode version).
static int pr_inittaa (gxHANDLE handle, const char *card, void **data, int *sdata)
 Initiates the Terminal Authentication of the RFID chip (ASCII version).
static int pr_completeta (gxHANDLE handle, const wchar_t *card, const void *data, int sdata)
 Completes the Terminal Authentication of the RFID chip (Unicode version).
static int pr_completetaa (gxHANDLE handle, const char *card, const void *data, int sdata)
 Completes the Terminal Authentication of the RFID chip (ASCII version).
static int pr_loadcertfile (gxHANDLE handle, const wchar_t *certificate, const wchar_t *privateKey)
 Loads a certificate and a private key from file (Unicode version).
static int pr_loadcertfilea (gxHANDLE handle, const char *certificate, const char *privateKey)
 Loads a certificate and a private key from file (ASCII version).
static int pr_loadcertfromstore (gxHANDLE handle, const wchar_t *storename)
 Loads certificates and CRLs from store (Unicode version).
static int pr_loadcertfromstorea (gxHANDLE handle, const char *storename)
 Loads certificates and CRLs from store (ASCII version).
static int pr_loadcertfrommem (gxHANDLE handle, void *certificate_data, unsigned int certificate_length, void *privateKey_data, unsigned int privateKey_length)
 Loads a certificate and a private key from memory.
static int pr_clearcertlist (gxHANDLE handle, int sel)
 Clears the internal certificate list.
static int pr_connectrfidcard (gxHANDLE handle, const wchar_t *card)
 Connects to an RFID card (Unicode version).
static int pr_connectrfidcarda (gxHANDLE handle, const char *card)
 Connects to an RFID card (ASCII version).
static int pr_disconnectrfidcard (gxHANDLE handle, const wchar_t *card)
 Disconnects from RFID card (Unicode version).
static int pr_disconnectrfidcarda (gxHANDLE handle, const char *card)
 Disconnects from an RFID card (ASCII version).
static int pr_checkrfidfilehash (gxHANDLE handle, const wchar_t *card, int fileid)
 Checks the hash of the file read from the RFID card (Unicode version).
static int pr_checkrfidfilehasha (gxHANDLE handle, const char *card, int fileid)
 Checks the hash of the file read from the RFID card (ASCII version).
static int pr_getrfidcardinfo (gxHANDLE handle, const wchar_t *card, gxVARIANT *cardinfo)
 Gets information about the rfid card (Unicode version).
static int pr_getrfidcardinfoa (gxHANDLE handle, const char *card, gxVARIANT *cardinfo)
 Gets information about the rfid card (ASCII version).
static int pr_getcertificateid (gxHANDLE handle, const wchar_t *card, int Authentication, gxVARIANT *CertificateId)
 Gets information about certificate (Unicode version).
static int pr_getcertificateida (gxHANDLE handle, const char *card, int Authentication, gxVARIANT *CertificateId)
 Gets information about certificate (ASCII version).
static int pr_getnextauthentication (gxHANDLE handle, const wchar_t *card, int *Authentication, int ForceNext)
 Gets information about the next suggested authentication process (Unicode version).
static int pr_getnextauthenticationa (gxHANDLE handle, const char *card, int *Authentication, int ForceNext)
 Gets information about the next suggested authentication process (Unicode version).
static int pr_doauthentication (gxHANDLE handle, const wchar_t *card, int Authentication, const wchar_t **AuthData, int Lines, int PasswordType)
 Making authentication process (ASCII version).
static int pr_doauthenticationa (gxHANDLE handle, const char *card, int Authentication, const char **AuthData, int Lines, int PasswordType)
 Making authentication process (Unicode version).
static int pr_getrfidfilelist (gxHANDLE handle, const wchar_t *card, int **files, int *nfiles)
 Gets a list of available rfid files.
static int pr_convertfid (gxHANDLE handle, const wchar_t *card, int *file_id)
 Converts rfid file ids between general id and data group number form.
static int pr_getrfidauthresult (gxHANDLE handle, const wchar_t *card, gxVARIANT *pdoc)
 Returns the rfid authentication results in document form.


Function Documentation

static int pr_seteventfunction ( gxHANDLE  handle,
PR_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 PR_EVENT enumeration. The invoked event types can be set through the event_types property.

Parameters:
handle Handle of the prapi module.
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 gx_call().

static int pr_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 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.

Parameters:
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.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_endwindowmessaging ( gxHANDLE  handle  )  [static]

Ends window messaging process (WIN32 function).

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

Parameters:
handle Handle of the prapi 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().

static int pr_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 pr_stopbgprocesses() function.

Parameters:
handle Handle of the prapi 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().

static int pr_stopbgprocesses ( gxHANDLE  handle  )  [static]

Ends the automated background process (Linux function).

After calling this function no further freerun events will arrive.

Parameters:
handle Handle of the prapi 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().

static int pr_getdataformat ( gxHANDLE  handle,
const gxu8 *  databuf,
int  buflen,
wchar_t *  format,
int  fmtlen 
) [static]

Returns the file format type of a given binary data.

Parameters:
handle Handle of the prapi module.
databuf Input buffer.
buflen Number of bytes in the buffer.
format File format buffer.
fmtlen Size of the format buffer in characters.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_fingertonist ( gxHANDLE  handle,
const wchar_t *  filename,
gxVARIANT  fields 
) [static]

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

Parameters:
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.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_fingertonista ( gxHANDLE  handle,
const char *  filename,
gxVARIANT  fields 
) [static]

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

Parameters:
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.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_fingertonistmem ( gxHANDLE  handle,
void **  buffer,
int *  buflen,
gxVARIANT  fields 
) [static]

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

Parameters:
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.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_resetdocument ( gxHANDLE  handle,
int  lastpage 
) [static]

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.

Parameters:
handle Handle of the prapi module.
lastpage Set it to true for reset only the last captured page.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_loaddocument ( gxHANDLE  handle,
const wchar_t *  filename,
gxVARIANT pdoc 
) [static]

Loads a document from the mass storage device in the specific file format (Unicode version).

Parameters:
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.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_loaddocumenta ( gxHANDLE  handle,
const char *  filename,
gxVARIANT pdoc 
) [static]

Loads a document from the mass storage device in the specific file format (ASCII version).

Parameters:
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.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_loaddocumentfrommem ( gxHANDLE  handle,
const gxu8 *  buffer,
int  buflen,
gxVARIANT pdoc 
) [static]

Loads a document from the memory in the specific file format.

Parameters:
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.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().


Generated  for Passport Reader
(c) ADAPTIVE RECOGNITION