Header Header

PassportReader Class Reference

Inheritance diagram for PassportReader:

gxHandle gxHANDLE

List of all members.

Detailed Description

This class contains functions that contol the Passport Reader system.

Public Member Functions

 PassportReader () throw (gxError)
 Class initialization.
 PassportReader (const wchar_t *proppath) throw (gxError)
 Class initialization.
 PassportReader (const char *proppath) throw (gxError)
 Class initialization.
 PassportReader (gxInStr proppath) throw (gxError)
 Class initialization.
 PassportReader (gxInAStr proppath) 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 Passport Reader devices (Unicode version).
bool GetDeviceList (char ***devices, int *ndevices) throw (gxError)
 Returns a list of the available Passport Reader devices (ASCII version).
gxOutStrArray GetDeviceList (void) throw (gxError)
 Returns a list of the available Passport Reader devices (Unicode version).
gxOutAStrArray GetDeviceListA (void) throw (gxError)
 Returns a list of the available Passport Reader devices (ASCII version).
bool UseDevice (wchar_t *device, int mode) throw (gxError)
 Connects a PR device (Unicode version).
bool UseDevice (char *device, int mode) throw (gxError)
 Conects to a PR device (ASCII version).
bool UseDevice (gxInStr device, int mode) throw (gxError)
 Conects to a PR device (Unicode version).
bool UseDevice (gxInAStr device, int mode) throw (gxError)
 Conects to a PR device (ASCII version).
bool UseDevice (int devno, int mode) throw (gxError)
 Conects to a PR device.
bool CloseDevice (void) throw (gxError)
 Disconnects the connected device.
gxHANDLE * GetDeviceHandle (void)
 Returns the handle of the capturing device (Obsolete).
bool Calibrate (int windowid=0) throw (gxError)
 Calibrates the used device.
bool IsCalibrated (int windowid=0)
 Tests the calibrated state of the device.
int TestDocument (int windowid=0)
 Returns the result of the document (motion) detection module.
int Lights (void)
 Returns the number of usable lights of the device.
int LightListItem (int itemno)
 Returns the id of the light specified by the index.
int LightMask (int lightid, int windowid)
 Returns a light mask for a given light and window.
int ObjectWindows (void)
 Returns the number of object windows of the device.
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) throw (gxError)
 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 () throw (gxError)
 Suspends the Passport Reader system.
bool WakeUp () throw (gxError)
 Wakes up the previously suspended Passport Reader 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.
gxVariant * SelfTest (int condition) throw (gxError)
 Performs device self test.
bool ReadMagstripe (wchar_t ***tracks, int *ntracks) throw (gxError)
 Reads magnetic stripe (Unicode version).
bool ReadMagstripe (char ***tracks, int *ntracks) throw (gxError)
 Reads magnetic stripe (ASCII version).
gxOutStrArray ReadMagstripe (void) throw (gxError)
 Reads magnetic stripe (Unicode version).
gxOutAStrArray ReadMagstripeA (void) throw (gxError)
 Reads magnetic stripe (ASCII version).
bool SetEventFunction (PR_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) throw (gxError)
 Starts window messaging process (WIN32 function).
bool EndWindowMessaging () throw (gxError)
 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 SetPageLight (int pages, unsigned int *lights) throw (gxError)
 Sets the number of document pages to capture and the needed lights for each page.
bool SetPageLight (gxInIntArray lights) throw (gxError)
 Sets the number of document pages to capture and the needed lights for each page.
bool Capture (void) throw (gxError)
 Captures an image sequence from the object window of the PR device.
int CaptureStart () throw (gxError)
 Starts the 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 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.
prImage * GetImage (int page, int light, int type) throw (gxError)
 The Passport Reader system has several functions for working with the captured images.
gxVariant * GetEnhancedUV (int page, int imgtype) throw (gxError)
 Get enhanced UV.
bool SaveImage (int page, int light, int type, const wchar_t *filename, int filetype) throw (gxError)
 Saves an image to a file (Unicode version).
bool SaveImage (int page, int light, int type, const char *filename, int filetype) throw (gxError)
 Saves an image to a file (ASCII version).
bool SaveImage (int page, int light, int type, gxInStr filename, int filetype) throw (gxError)
 Saves an image to a file (Unicode version).
bool SaveImage (int page, int light, int type, gxInAStr filename, int filetype) throw (gxError)
 Saves an image to a file (ASCII version).
bool DisplayImage (int page, int light, 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).
bool ResetDocument (int lastpage=0) throw (gxError)
 Clears all the image and document buffers and deletes the internal image and document structures.
prDoc * GetOcr (int page, int light, int type) throw (gxError)
 Reads the OCR from an unknown document.
prDoc * GetOcr (int page, int light, int type, gxVariant *ocrparams) throw (gxError)
 Reads the OCR from an unknown document.
prDoc * GetMrz (int page, int light, int type) throw (gxError)
 Reads the MRZ lines from the document.
prDoc * GetBarcode (int page, int light, int type, int bctype, int index) throw (gxError)
 Reads the barcodes from an unknown document.
prDoc * GetDocumentRect (int page, int light, int type) throw (gxError)
 Returns the quad of the document.
prDoc * Recognize (int page) throw (gxError)
 Reads all of the known data from a known document type.
prDoc * Analyze (gxVariant *page, int tasklen, int *task) throw (gxError)
 Reads the data specified in task array from the document.
prDoc * Analyze (gxu8 *buffer, int buflen) throw (gxError)
 Separates and processes the data fields in a given binary data array.
prDoc * Analyze (gxVariant *page, gxInIntArray task) throw (gxError)
 Reads the data specified in task array from the document.
prDoc * ResolveMrzText (const wchar_t **lines, int nlines) throw (gxError)
 Separates the data fields in the given MRZ text (Unicode version).
prDoc * ResolveMrzText (const char **lines, int nlines) throw (gxError)
 Separates the data fields in the given MRZ text (ASCII version).
prDoc * ResolveMrzText (gxInStrArray lines) throw (gxError)
 Separates the data fields in the given MRZ text (Unicode version).
prDoc * ResolveMrzText (gxInAStrArray lines) throw (gxError)
 Separates the data fields in the given MRZ text (ASCII version).
prDoc * ResolveMagstripe (const wchar_t **tracks, int ntracks) throw (gxError)
 Separates the data fields in the given magnetic stripe text (Unicode version).
prDoc * ResolveMagstripe (const char **tracks, int ntracks) throw (gxError)
 Separates the data fields in the given magnetic stripe text (ASCII version).
prDoc * ResolveMagstripe (gxInStrArray tracks) throw (gxError)
 Separates the data fields in the given magnetic stripe text (Unicode version).
prDoc * ResolveMagstripe (gxInAStrArray tracks) throw (gxError)
 Separates the data fields in the given magnetic stripe text (ASCII version).
bool GetRfidCardList (wchar_t ***cards, int *ncards) throw (gxError)
 Gets the list of cards in the range of the contactless reader (Unicode version).
bool GetRfidCardList (char ***cards, int *ncards) throw (gxError)
 Gets the list of cards in the range of the contactless reader (ASCII version).
gxOutStrArray GetRfidCardList (void) throw (gxError)
 Gets the list of cards in the range of the contactless reader (Unicode version).
gxOutAStrArray GetRfidCardListA (void) throw (gxError)
 Gets the list of cards in the range of the contactless reader (ASCII version).
bool ConnectRfidCard (const wchar_t *card) throw (gxError)
 Connects to an RFID chip (Unicode version).
bool ConnectRfidCard (const char *card) throw (gxError)
 Connects to an RFID chip (ASCII version).
bool DisconnectRfidCard (const wchar_t *card) throw (gxError)
 Disconnects from an RFID chip (Unicode version).
bool DisconnectRfidCard (const char *card) throw (gxError)
 Disconnects from an RFID chip (ASCII version).
bool ConnectRfidCard (gxInStr card) throw (gxError)
 Connects to an RFID chip (Unicode version).
bool DisconnectRfidCard (gxInStr card) throw (gxError)
 Disconnects from an RFID chip (Unicode version).
bool ConnectRfidCard (gxInAStr card) throw (gxError)
 Connects to an RFID chip (ASCII version).
bool DisconnectRfidCard (gxInAStr card) throw (gxError)
 Disconnects from an RFID chip (ASCII version).
bool GetRfidFile (const wchar_t *card, int fileid, void **data, int *sdata) throw (gxError)
 Reads files from the RFID card (Unicode version).
bool CheckRfidFileHash (const wchar_t *card, int fileid) throw (gxError)
 Checks the hash of the file read from the RFID card (Unicode version).
bool GetRfidFile (const char *card, int fileid, void **data, int *sdata) throw (gxError)
 Reads files from the RFID card (ASCII version).
bool CheckRfidFileHash (const char *card, int fileid) throw (gxError)
 Checks the hash of the file read from the RFID card (ASCII version).
int GetRfidFileStart (const wchar_t *card, int fileid) throw (gxError)
 Starts reading files from the RFID card in asynchronous mode.
int GetRfidFileStart (const char *card, int fileid) throw (gxError)
 Starts reading files from the RFID card in asynchronous mode.
int GetRfidFileStart (gxInStr card, int fileid) throw (gxError)
 Starts reading files from the RFID card in asynchronous mode.
int GetRfidFileStart (gxInAStr card, int fileid) throw (gxError)
 Starts reading files from the RFID card in asynchronous mode.
int GetRfidFileGetStatus (int reqid) throw (gxError)
 Returns the state of an rfid reading process started with the GetRfidFileStart() method.
bool GetRfidFileWait (int reqid, void **data, int *sdata) throw (gxError)
 Waits for the finish of the rfid reading process started with the GetRfidFileStart() method.
bool GetRfidFileStop () throw (gxError)
 Cancel the rfid reading process started with the GetRfidFileStart() method.
bool CheckRfidFileHash (gxInStr card, int fileid) throw (gxError)
 Checks the hash of the file read from the RFID card (Unicode version).
bool CheckRfidFileHash (gxInAStr card, int fileid) throw (gxError)
 Checks the hash of the file read from the RFID card (ASCII version).
prDoc * ResolveRfidData (const void *data, int sdata) throw (gxError)
 Resolves a composite RFID data.
bool GetApplications (const wchar_t *card, int **apps, int *napps) throw (gxError)
 Get applications supported by the card.
bool GetApplications (const char *card, int **apps, int *napps) throw (gxError)
 Get applications supported by the card.
bool SelectApplication (const wchar_t *card, PR_APP_TYPE Application) throw (gxError)
 Select the chip application.
bool SelectApplication (const char *card, PR_APP_TYPE Application) throw (gxError)
 Select the chip application.
bool SelectApplication (gxInStr card, PR_APP_TYPE Application) throw (gxError)
 Select the chip application.
bool SelectApplication (gxInAStr card, PR_APP_TYPE Application) throw (gxError)
 Select the chip application.
bool MakeBAC (const wchar_t *card, const wchar_t **lines, int nlines) throw (gxError)
 Switches to secure messaging by making Basic Access Control (Unicode version).
bool MakeBAC (const char *card, const char **lines, int nlines) throw (gxError)
 Switches to secure messaging by making Basic Access Control (ASCII version).
bool MakeBAC (gxInStr card, gxInStrArray lines) throw (gxError)
 Switches to secure messaging by making Basic Access Control (Unicode version).
bool MakeBAC (gxInAStr card, gxInAStrArray lines) throw (gxError)
 Switches to secure messaging by making Basic Access Control (ASCII version).
bool MakePACE (const wchar_t *card, const wchar_t **lines, int nlines, int PasswordType) throw (gxError)
 Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (Unicode version).
bool MakePACE (const char *card, const char **lines, int nlines, int PasswordType) throw (gxError)
 Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (ASCII version).
bool MakePACE (gxInStr card, gxInStrArray lines, int PasswordType) throw (gxError)
 Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (Unicode version).
bool MakePACE (gxInAStr card, gxInAStrArray lines, int PasswordType) throw (gxError)
 Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (ASCII version).
int GetNextAuthentication (const wchar_t *card, int ForceNext=false) throw (gxError)
 Returns the next suggested authentication process (Unicode version).
int GetNextAuthentication (const char *card, int ForceNext=false) throw (gxError)
 Returns the next suggested authentication process (ASCII version).
int DoAuthentication (const wchar_t *card, int Authentication, const wchar_t **AuthData=0, int Lines=0, int PasswordType=PR_PACE_PW_MRZ) throw (gxError)
 Making authentication process (Unicode version).
int DoAuthentication (const char *card, int Authentication, const char **AuthData=0, int Lines=0, int PasswordType=PR_PACE_PW_MRZ) throw (gxError)
 Making authentication process (ASCII version).
bool MakePassiveAuth (const wchar_t *card) throw (gxError)
 Makes the Passive Authentication of the RFID chip (Unicode version).
bool MakePassiveAuth (const char *card) throw (gxError)
 Makes the Passive Authentication of the RFID chip (ASCII version).
bool MakeActiveAuth (const wchar_t *card) throw (gxError)
 Makes the Active Authentication of the RFID chip (Unicode version).
bool MakeActiveAuth (const char *card) throw (gxError)
 Makes the Active Authentication of the RFID chip (ASCII version).
bool MakeChipAuth (const wchar_t *card) throw (gxError)
 Makes the Chip Authentication of the RFID chip (Unicode version).
bool MakeChipAuth (const char *card) throw (gxError)
 Makes the Chip Authentication of the RFID chip (ASCII version).
bool MakeTerminalAuth (const wchar_t *card) throw (gxError)
 Makes the Terminal Authentication of the RFID chip (Unicode version).
bool MakeTerminalAuth (const char *card) throw (gxError)
 Makes the Terminal Authentication of the RFID chip (ASCII version).
bool InitTerminalAuth (const wchar_t *card, void **data, int *sdata) throw (gxError)
 Initiates the Terminal Authentication of the RFID chip (Unicode version).
bool InitTerminalAuth (const char *card, void **data, int *sdata) throw (gxError)
 Initiates the Terminal Authentication of the RFID chip (ASCII version).
bool CompleteTerminalAuth (const wchar_t *card, const void *data, int sdata) throw (gxError)
 Completes the Terminal Authentication of the RFID chip (Unicode version).
bool CompleteTerminalAuth (const char *card, const void *data, int sdata) throw (gxError)
 Completes the Terminal Authentication of the RFID chip (ASCII version).
bool LoadCertFile (const wchar_t *certificate, const wchar_t *privateKey=NULL) throw (gxError)
 Loads a certificate and a private key from file (Unicode version).
bool LoadCertFile (const char *certificate, const char *privateKey=NULL) throw (gxError)
 Loads a certificate and a private key from file (ASCII version).
bool LoadCertFromStore (const wchar_t *storename) throw (gxError)
 Loads certificates and CRLs from store (Unicode version).
bool LoadCertFromStore (const char *storename) throw (gxError)
 Loads certificates and CRLs from store (ASCII version).
bool LoadCertFileFromMem (void *certificate_data, unsigned int certificate_length, void *privateKey_data=NULL, unsigned int privateKey_length=0) throw (gxError)
 Loads a certificate and a private key from memory.
int GetNextAuthentication (gxInStr card, int ForceNext=false) throw (gxError)
 Returns the next suggested authentication process (Unicode version).
int DoAuthentication (gxInStr card, int Authentication, gxInStrArray AuthData, int PasswordType=PR_PACE_PW_MRZ) throw (gxError)
 Making authentication process (Unicode version).
int DoAuthentication (gxInStr card, int Authentication) throw (gxError)
 Making authentication process (Unicode version).
bool MakePassiveAuth (gxInStr card) throw (gxError)
 Makes the Passive Authentication of the RFID chip (Unicode version).
bool MakeActiveAuth (gxInStr card) throw (gxError)
 Makes the Active Authentication of the RFID chip (Unicode version).
bool MakeChipAuth (gxInStr card) throw (gxError)
 Makes the Chip Authentication of the RFID chip (Unicode version).
bool MakeTerminalAuth (gxInStr card) throw (gxError)
 Makes the Terminal Authentication of the RFID chip (Unicode version).
bool LoadCertFile (gxInStr certificate, gxInStr privateKey) throw (gxError)
 Loads a certificate and a private key from file (Unicode version).
bool LoadCertFromStore (gxInStr storename) throw (gxError)
 Loads certificates and CRLs from store (Unicode version).
int GetNextAuthentication (gxInAStr card, int ForceNext=false) throw (gxError)
 Returns the next suggested authentication process (ASCII version).
int DoAuthentication (gxInAStr card, int Authentication, gxInAStrArray AuthData, int PasswordType=PR_PACE_PW_MRZ) throw (gxError)
 Making authentication process (ASCII version).
int DoAuthentication (gxInAStr card, int Authentication) throw (gxError)
 Making authentication process (ASCII version).
bool MakePassiveAuth (gxInAStr card) throw (gxError)
 Makes the Passive Authentication of the RFID chip (ASCII version).
bool MakeActiveAuth (gxInAStr card) throw (gxError)
 Makes the Active Authentication of the RFID chip (ASCII version).
bool MakeChipAuth (gxInAStr card) throw (gxError)
 Makes the Chip Authentication of the RFID chip (ASCII version).
bool MakeTerminalAuth (gxInAStr card) throw (gxError)
 Makes the Terminal Authentication of the RFID chip (ASCII version).
bool LoadCertFile (gxInAStr certificate, gxInAStr privateKey) throw (gxError)
 Loads a certificate and a private key from file (ASCII version).
bool LoadCertFromStore (gxInAStr storename) throw (gxError)
 Loads certificates and CRLs from store (ASCII version).
bool ClearCertList (int sel) throw (gxError)
 Clears the internal certificate list.
gxVariant * GetRfidCardInfo (const wchar_t *card) throw (gxError)
 Returns information about the rfid card (Unicode version).
gxVariant * GetRfidCardInfo (const char *card) throw (gxError)
 Returns information about the rfid card (ASCII version).
gxVariant * GetCertificateId (const char *card, int Authentication) throw (gxError)
 Returns information about the necessary certificate (ASCII version).
gxVariant * GetCertificateId (const wchar_t *card, int Authentication) throw (gxError)
 Returns information about the necessary certificate (Unicode version).
gxVariant * GetRfidCardInfo (gxInStr card) throw (gxError)
 Returns information about the rfid card (Unicode version).
gxVariant * GetCertificateId (gxInStr card, int Authentication) throw (gxError)
 Returns information about the necessary certificate (Unicode version).
gxVariant * GetRfidCardInfo (gxInAStr card) throw (gxError)
 Returns information about the rfid card (ASCII version).
gxVariant * GetCertificateId (gxInAStr card, int Authentication) throw (gxError)
 Returns information about the necessary certificate (ASCII version).
prDoc * CompareFace (int page, int face_no) throw (gxError)
 Compares a captured face photo with one that is stored in rfid chip.
gxVariant * DecodeLatentImage (int page, int light, int type, const wchar_t *decpar) throw (gxError)
 Decodes a latent image from a stored image.
gxVariant * DecodeLatentImage (int page, int light, int type, gxInStr decpar) throw (gxError)
 Decodes a latent image from a stored image.
prDoc * LoadDocument (const wchar_t *filename) throw (gxError)
 Loads a document from the mass storage device (Unicode version).
prDoc * LoadDocument (const char *filename) throw (gxError)
 Loads a document from the mass storage device (ASCII version).
prDoc * LoadDocumentFromMem (const gxu8 *buffer, gxi32 buflen) throw (gxError)
 Loads a document from the memory.
prDoc * LoadDocument (gxInStr filename) throw (gxError)
 Loads a document from the mass storage device (Unicode version).
prDoc * LoadDocument (gxInAStr filename) throw (gxError)
 Loads a document from the mass storage device (ASCII version).
prDoc * GetDocumentRoot () throw (gxError)
 Returns the root document of the PR system.
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

PassportReader (  )  throw (gxError) [inline]

Class initialization.

References gx_openmodule().

PassportReader ( const wchar_t *  proppath  )  throw (gxError) [inline]

Class initialization.

Parameters:
proppath Root node in the property tree.

References gx_openmodule().

PassportReader ( const char *  proppath  )  throw (gxError) [inline]

Class initialization.

Parameters:
proppath Root node in the property tree.

References gx_openmodule().

PassportReader ( gxInStr  proppath  )  throw (gxError) [inline]

Class initialization.

Parameters:
proppath Root node in the property tree.

References gx_openmodule().

PassportReader ( gxInAStr  proppath  )  throw (gxError) [inline]

Class initialization.

Parameters:
proppath Root node in the property tree.

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 Passport Reader 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 pr_getdevicelist().

bool GetDeviceList ( char ***  devices,
int *  ndevices 
) throw (gxError) [inline]

Returns a list of the available Passport Reader 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 pr_getdevicelist().

gxOutStrArray GetDeviceList ( void   )  throw (gxError) [inline]

Returns a list of the available Passport Reader devices (Unicode version).

Returns:
The list of the available Passport Reader devices.

References pr_getdevicelist().

gxOutAStrArray GetDeviceListA ( void   )  throw (gxError) [inline]

Returns a list of the available Passport Reader devices (ASCII version).

Returns:
The list of the available Passport Reader devices.

References pr_getdevicelist().

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

Connects a PR 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 PR_USAGEMODE enumeration. Generally the PR_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 pr_usedevice().

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

Conects to a PR 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 PR_USAGEMODE enumeration. Generally the PR_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 pr_usedevice().

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

Conects to a PR 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 PR_USAGEMODE enumeration. Generally the PR_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 pr_usedevice().

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

Conects to a PR 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 PR_USAGEMODE enumeration. Generally the PR_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 pr_usedevice().

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

Conects to a PR device.

Parameters:
devno Ordinal number of the device to connect to.
mode Connection mode. The possible values are defined in the PR_USAGEMODE enumeration. Generally the PR_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 pr_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 pr_closedevice().

gxHANDLE* GetDeviceHandle ( void   )  [inline]

Returns the handle of the capturing device (Obsolete).

Returns:
The handle of the used device. On error 0 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getctrlhandle().

bool Calibrate ( int  windowid = 0  )  throw (gxError) [inline]

Calibrates the used device.

This method generates data for correcting the geometrical and colour distortions of the capturing system. This process can take up to 30-60 seconds according to the computer's speed. For this method to work the calibration image is needed.

Parameters:
windowid Id of the used window. The possible values are defined in the PR_WINDOW_ID enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_calibrate().

bool IsCalibrated ( int  windowid = 0  )  [inline]

Tests the calibrated state of the device.

Parameters:
windowid Id of the used window. The possible values are defined in the PR_WINDOW_ID enumeration.
Returns:
If the device is calibrated the method returns true. Otherwise it returns false and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_iscalibrated().

int TestDocument ( int  windowid = 0  )  [inline]

Returns the result of the document (motion) detection module.

The possible result values are defined in the PR_TESTDOC enumeration. Call this method 2-3 times in every second. When the result is PR_TD_IN the document is ready for capturing. The document detection is working only when the freerun_mode property contains the PR_FRMODE_TESTDOCUMENT value.

Parameters:
windowid Id of the used window. The possible values are defined in PR_WINDOW_ID enumeration.
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 pr_testdocument().

int Lights ( void   )  [inline]

Returns the number of usable lights of the device.

Returns:
The number of the usable lights. On error 0 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getlightnumber().

int LightListItem ( int  itemno  )  [inline]

Returns the id of the light specified by the index.

Parameters:
itemno The index of the light.
Returns:
The id of the light. On error 0 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getlightlist().

int LightMask ( int  lightid,
int  windowid 
) [inline]

Returns a light mask for a given light and window.

It is usable to test if the a light is available for the device or one of its object windows. It can return a whole light mask for a given object window if the lightid is null. Light masks are used by the SetPageLight() function.

Parameters:
lightid The id of the interesting light. The possible values are defined in the PR_LIGHT enumeration. If this value is null the fuction returns the whole light mask of the given object window.
windowid The id of the interesting object window. The possible values are defined in the PR_WINDOW_ID enumeration. If the value is PR_OW_DEFAULT (null) the fuction returns the light mask of the device.
Returns:
The light mask. On error 0 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getlightmask().

int ObjectWindows ( void   )  [inline]

Returns the number of object windows of the device.

Returns:
The number of the usable lights. On error 0 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getwindownumber().

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 PR_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 pr_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 PR_STATUS_LED_COLOR and PR_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 pr_blinkstatus().

bool BlinkStatus ( int  coding,
int  mask,
int  type,
int  iteration,
gxInIntArray  data 
) 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 PR_STATUS_LED_COLOR and PR_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 pr_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 pr_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 pr_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 pr_testbutton().

bool Suspend (  )  throw (gxError) [inline]

Suspends the Passport Reader 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 pr_suspend().

bool WakeUp (  )  throw (gxError) [inline]

Wakes up the previously suspended Passport Reader system.

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

References pr_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 pr_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 pr_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 pr_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 pr_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 pr_getudinfo().

gxVariant* GetDeviceInfo (  )  throw (gxError) [inline]

Returns the information about the used device.

Returns:
The device info in variant data type.

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

gxVariant* SelfTest ( int  condition  )  throw (gxError) [inline]

Performs device self test.

Parameters:
condition Test control condition that declares the type of object which is placed on the document window (0: unknown/nothing, 1: white image, 2: calibration image, 3: document with MRZ line)
Returns:
A list of partial test results. The test element ids are defined in PR_SELFTEST_ELEMENTS enumeration, and the result values are defined in PR_SELFTEST_RESULT enumeration.

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

bool ReadMagstripe ( wchar_t ***  tracks,
int *  ntracks 
) throw (gxError) [inline]

Reads magnetic stripe (Unicode version).

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

Parameters:
tracks Buffer for a pointer to the list of tracks.
ntracks Buffer for the number of tracks.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_readmagstripe().

bool ReadMagstripe ( char ***  tracks,
int *  ntracks 
) throw (gxError) [inline]

Reads magnetic stripe (ASCII version).

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

Parameters:
tracks Buffer for a pointer to the list of tracks.
ntracks Buffer for the number of tracks.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_readmagstripe().

gxOutStrArray ReadMagstripe ( void   )  throw (gxError) [inline]

Reads magnetic stripe (Unicode version).

Returns:
The list of the read tracks.

References pr_readmagstripe().

gxOutAStrArray ReadMagstripeA ( void   )  throw (gxError) [inline]

Reads magnetic stripe (ASCII version).

Returns:
The list of the read tracks.

References pr_readmagstripe().

bool SetEventFunction ( PR_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 PR_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 pr_seteventfunction().

bool BeginWindowMessaging ( HWND  hwnd,
UINT  base_msg = WM_USER 
) throw (gxError) [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 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 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 pr_beginwindowmessaging().

bool EndWindowMessaging (  )  throw (gxError) [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 pr_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 pr_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 pr_stopbgprocesses().

bool SetPageLight ( int  pages,
unsigned int *  lights 
) throw (gxError) [inline]

Sets the number of document pages to capture and the needed lights for each page.

More than one page is usable when visa is needed for a passport or when both sides of an Id card is needed to be read.

Parameters:
pages Number of document pages to read.
lights Array of light masks where each integer represents a page. Each lower bit of them represents a light mask bit. The upper 8 bits represent the id of the object window. The light mask bits can be tested by the LightMask() function. The object window ids are defined in the PR_WINDOW_ID enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_setpagelight().

bool SetPageLight ( gxInIntArray  lights  )  throw (gxError) [inline]

Sets the number of document pages to capture and the needed lights for each page.

More than one page is usable when visa is needed for a passport or when both sides of an Id card is needed to be read. The dimensions of the lights array parameter gives the number of document pages.

Parameters:
lights Array of light masks where each integer represents a page. Each lower bit of them represents a light mask bit. The upper 8 bits represent the id of the object window. The light mask bits can be tested by the LightMask() function. The object window ids are defined in the PR_WINDOW_ID enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_setpagelight().

bool Capture ( void   )  throw (gxError) [inline]

Captures an image sequence from the object window of the PR device.

To set the lights needed for capture call the SetPageLight() method. 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, recognize...).

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

References pr_capture().

int CaptureStart (  )  throw (gxError) [inline]

Starts the image capturing process in asynchronous mode.

See Capture() 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() )

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 pr_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 in percent, 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 pr_capture_getstatus().

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 pr_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. The lights for preview capture can be set through the preview_light property. For preview light control the freerun_mode property must contain the PR_FRMODE_PREVIEWLIGHT value.

Parameters:
windowid Id of the used window. The possible values are defined in PR_WINDOW_ID enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_capture_preview().

prImage* GetImage ( int  page,
int  light,
int  type 
) throw (gxError) [inline]

The Passport Reader 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 a prImage object. The image data can be accessed throught this object.

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. The possible values are defined in the PR_IMAGE_TYPE enumeration. If the type is PR_IT_PREVIEW the page and light parameters have no meanings.
Returns:
A prImage 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(), GX_ENOMEM, gx_unrefvariant(), pr_getimage(), and gxSystem::SetError().

gxVariant* GetEnhancedUV ( int  page,
int  imgtype 
) throw (gxError) [inline]

Get enhanced UV.

Make enhanced UV image from the captured UV and white image. The Passport Reader system going to remove white backlight from UV.

Parameters:
page The actual page of the image.
imgtype The type of the image. The possible values are defined in the PR_IMAGE_TYPE enumeration.
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 GX_ENOMEM, gx_unrefvariant(), pr_getenhanceduv(), and gxSystem::SetError().

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

Saves an image to a file (Unicode version).

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. The possible values are defined in the PR_IMAGE_TYPE enumeration. If the type is PR_IT_PREVIEW the page and light 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 pr_saveimage().

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

Saves an image to a file (ASCII version).

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. The possible values are defined in the PR_IMAGE_TYPE enumeration. If the type is PR_IT_PREVIEW the page and light 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 pr_saveimage().

bool SaveImage ( int  page,
int  light,
int  type,
gxInStr  filename,
int  filetype 
) throw (gxError) [inline]

Saves an image to a file (Unicode version).

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. The possible values are defined in the PR_IMAGE_TYPE enumeration. If the type is PR_IT_PREVIEW the page and light 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 pr_saveimage().

bool SaveImage ( int  page,
int  light,
int  type,
gxInAStr  filename,
int  filetype 
) throw (gxError) [inline]

Saves an image to a file (ASCII version).

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. The possible values are defined in the PR_IMAGE_TYPE enumeration. If the type is PR_IT_PREVIEW the page and light 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 pr_saveimage().

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

Displays an image (WIN32 function).

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. The possible values are defined in the PR_IMAGE_TYPE enumeration. If the type is PR_IT_PREVIEW the page and light parameters have no meaning.
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 pr_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 pr_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 pr_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 pr_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 pr_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 pr_fingertonist().

bool ResetDocument ( int  lastpage = 0  )  throw (gxError) [inline]

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

This method 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:
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 pr_resetdocument().

prDoc* GetOcr ( int  page,
int  light,
int  type 
) throw (gxError) [inline]

Reads the OCR from an unknown document.

The returned document structure will contain just the recognized rows without additional details, even when the type of the document is known.

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. It must be PR_IT_ORIGINAL.
Returns:
A prDoc object contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* GetOcr ( int  page,
int  light,
int  type,
gxVariant *  ocrparams 
) throw (gxError) [inline]

Reads the OCR from an unknown document.

The returned document structure will contain just the recognized rows without additional details, even when the type of the document is known.

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. It must be PR_IT_ORIGINAL.
ocrparams Ocr parameters.
Returns:
A prDoc object contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* GetMrz ( int  page,
int  light,
int  type 
) throw (gxError) [inline]

Reads the MRZ lines from the document.

This method is for compatibility reasons with the old system. The Recognize() method should be called instead, except when the speed is important.

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. It must be PR_IT_ORIGINAL.
Returns:
A prDoc object contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* GetBarcode ( int  page,
int  light,
int  type,
int  bctype,
int  index 
) throw (gxError) [inline]

Reads the barcodes from an unknown document.

The returned document structure will contain just the barcode data without additional information, even when the type of the document is known.

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. It must be PR_IT_ORIGINAL.
bctype The needed barcode type. The possible values are defined in PR_BCTYPE enumeration. If this parameter is NULL any type of barcode can be returned.
index The ordinal number of the barcode. If more barcodes found.
Returns:
A prDoc object contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* GetDocumentRect ( int  page,
int  light,
int  type 
) throw (gxError) [inline]

Returns the quad of the document.

This method is retained for compatibility reasons with the old system. This quad was used to produce the document view.

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. It must be PR_IT_ORIGINAL.
Returns:
A prDoc object contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* Recognize ( int  page  )  throw (gxError) [inline]

Reads all of the known data from a known document type.

The method finds the quad of the document, recognizes it's type and reads MRZ, VIZ and BC fields from it.

Parameters:
page The actual page of the image.
Returns:
A prDoc object contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* Analyze ( gxVariant *  page,
int  tasklen,
int *  task 
) throw (gxError) [inline]

Reads the data specified in task array from the document.

Parameters:
page List of images to read from.
tasklen Size of the task array.
task Int array specifies the reading task.
Returns:
A prDoc object contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* Analyze ( gxu8 *  buffer,
int  buflen 
) throw (gxError) [inline]

Separates and processes the data fields in a given binary data array.

Parameters:
page List of images to read from.
buffer Input buffer.
buflen Number of bytes in the buffer.
Returns:
A prDoc object contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* Analyze ( gxVariant *  page,
gxInIntArray  task 
) throw (gxError) [inline]

Reads the data specified in task array from the document.

Parameters:
page List of images to read from.
task Int array specifies the reading task.
Returns:
A prDoc object contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* ResolveMrzText ( const wchar_t **  lines,
int  nlines 
) throw (gxError) [inline]

Separates the data fields in the given MRZ text (Unicode version).

It can be used to separate user defined MRZ in appropriate document fields.

Parameters:
lines Array of row strings.
nlines Number of rows.
Returns:
A prDoc object that contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* ResolveMrzText ( const char **  lines,
int  nlines 
) throw (gxError) [inline]

Separates the data fields in the given MRZ text (ASCII version).

It can be used to separate user defined MRZ in appropriate document fields.

Parameters:
lines Array of row strings.
nlines Number of rows.
Returns:
A prDoc object that contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* ResolveMrzText ( gxInStrArray  lines  )  throw (gxError) [inline]

Separates the data fields in the given MRZ text (Unicode version).

It can be used to separate user defined MRZ in appropriate document fields.

Parameters:
lines Array of row strings.
Returns:
A prDoc object that contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* ResolveMrzText ( gxInAStrArray  lines  )  throw (gxError) [inline]

Separates the data fields in the given MRZ text (ASCII version).

It can be used to separate user defined MRZ in appropriate document fields.

Parameters:
lines Array of row strings.
Returns:
A prDoc object that contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* ResolveMagstripe ( const wchar_t **  tracks,
int  ntracks 
) throw (gxError) [inline]

Separates the data fields in the given magnetic stripe text (Unicode version).

Parameters:
tracks Array of row strings.
ntracks Number of rows.
Returns:
A prDoc object that contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* ResolveMagstripe ( const char **  tracks,
int  ntracks 
) throw (gxError) [inline]

Separates the data fields in the given magnetic stripe text (ASCII version).

Parameters:
tracks Array of row strings.
ntracks Number of rows.
Returns:
A prDoc object that contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* ResolveMagstripe ( gxInStrArray  tracks  )  throw (gxError) [inline]

Separates the data fields in the given magnetic stripe text (Unicode version).

Parameters:
tracks Array of row strings.
Returns:
A prDoc object that contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* ResolveMagstripe ( gxInAStrArray  tracks  )  throw (gxError) [inline]

Separates the data fields in the given magnetic stripe text (ASCII version).

Parameters:
tracks Array of row strings.
Returns:
A prDoc object that contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

bool GetRfidCardList ( wchar_t ***  cards,
int *  ncards 
) throw (gxError) [inline]

Gets the list of cards in the range of the contactless reader (Unicode version).

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

Parameters:
cards List of card serial numbers.
ncards Number of cards in list.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getrfidcardlist().

bool GetRfidCardList ( char ***  cards,
int *  ncards 
) throw (gxError) [inline]

Gets the list of cards in the range of the contactless reader (ASCII version).

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

Parameters:
cards List of card serial numbers.
ncards Number of cards in list.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getrfidcardlist().

gxOutStrArray GetRfidCardList ( void   )  throw (gxError) [inline]

Gets the list of cards in the range of the contactless reader (Unicode version).

Returns:
The list of cards.

References pr_getrfidcardlist().

gxOutAStrArray GetRfidCardListA ( void   )  throw (gxError) [inline]

Gets the list of cards in the range of the contactless reader (ASCII version).

Returns:
The list of cards.

References pr_getrfidcardlist().

bool ConnectRfidCard ( const wchar_t *  card  )  throw (gxError) [inline]

Connects to an RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_connectrfidcard().

bool ConnectRfidCard ( const char *  card  )  throw (gxError) [inline]

Connects to an RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_connectrfidcard().

bool DisconnectRfidCard ( const wchar_t *  card  )  throw (gxError) [inline]

Disconnects from an RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_disconnectrfidcard().

bool DisconnectRfidCard ( const char *  card  )  throw (gxError) [inline]

Disconnects from an RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_disconnectrfidcard().

bool ConnectRfidCard ( gxInStr  card  )  throw (gxError) [inline]

Connects to an RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_connectrfidcard().

bool DisconnectRfidCard ( gxInStr  card  )  throw (gxError) [inline]

Disconnects from an RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_disconnectrfidcard().

bool ConnectRfidCard ( gxInAStr  card  )  throw (gxError) [inline]

Connects to an RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_connectrfidcard().

bool DisconnectRfidCard ( gxInAStr  card  )  throw (gxError) [inline]

Disconnects from an RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_disconnectrfidcard().

bool GetRfidFile ( const wchar_t *  card,
int  fileid,
void **  data,
int *  sdata 
) throw (gxError) [inline]

Reads files from the RFID card (Unicode version).

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

Parameters:
card Serial number of the selected card.
fileid Identifier of the requested file. The possible values are defined in the PR_RFID_FILES enumeration.
data File contents returned by the card.
sdata Size of the returned data block.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getrfidfile().

bool CheckRfidFileHash ( const wchar_t *  card,
int  fileid 
) throw (gxError) [inline]

Checks the hash of the file read from the RFID card (Unicode version).

Parameters:
card Serial number of the selected card.
fileid Identifier of the requested file. The possible values are defined in the PR_RFID_FILES enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_checkrfidfilehash().

bool GetRfidFile ( const char *  card,
int  fileid,
void **  data,
int *  sdata 
) throw (gxError) [inline]

Reads files from the RFID card (ASCII version).

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

Parameters:
card Serial number of the selected card.
fileid Identifier of the requested file. The possible values are defined in the PR_RFID_FILES enumeration.
data File contents returned by the card.
sdata Size of the returned data block.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getrfidfile().

bool CheckRfidFileHash ( const char *  card,
int  fileid 
) throw (gxError) [inline]

Checks the hash of the file read from the RFID card (ASCII version).

Parameters:
card Serial number of the selected card.
fileid Identifier of the requested file. The possible values are defined in the PR_RFID_FILES enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_checkrfidfilehash().

int GetRfidFileStart ( const wchar_t *  card,
int  fileid 
) throw (gxError) [inline]

Starts reading files from the RFID card in asynchronous mode.

(Unicode version)

Parameters:
card Serial number of the selected card.
fileid Identifier of the requested file (see the PR_RFID_FILES enumeration).
Returns:
Id for the getstatus and the wait methods. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getrfidfile_start().

int GetRfidFileStart ( const char *  card,
int  fileid 
) throw (gxError) [inline]

Starts reading files from the RFID card in asynchronous mode.

(ASCII version)

Parameters:
card Serial number of the selected card.
fileid Identifier of the requested file (see the PR_RFID_FILES enumeration).
Returns:
Id for the getstatus and the wait methods. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getrfidfile_start().

int GetRfidFileStart ( gxInStr  card,
int  fileid 
) throw (gxError) [inline]

Starts reading files from the RFID card in asynchronous mode.

(Unicode version)

Parameters:
card Serial number of the selected card.
fileid Identifier of the requested file (see the PR_RFID_FILES enumeration).
Returns:
Id for the getstatus and the wait methods. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getrfidfile_start().

int GetRfidFileStart ( gxInAStr  card,
int  fileid 
) throw (gxError) [inline]

Starts reading files from the RFID card in asynchronous mode.

(ASCII version)

Parameters:
card Serial number of the selected card.
fileid Identifier of the requested file (see the PR_RFID_FILES enumeration).
Returns:
Id for the getstatus and the wait methods. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getrfidfile_start().

int GetRfidFileGetStatus ( int  reqid  )  throw (gxError) [inline]

Returns the state of an rfid reading process started with the GetRfidFileStart() method.

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

Parameters:
reqid Id for the process. The GetRfidFileStart() returned this value.
Returns:
The value of the result is in percent. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getrfidfile_getstatus().

bool GetRfidFileWait ( int  reqid,
void **  data,
int *  sdata 
) throw (gxError) [inline]

Waits for the finish of the rfid reading process started with the GetRfidFileStart() method.

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

Parameters:
reqid Id of the capture returned by the GetRfidFileStart().
data File contents returned by the card.
sdata Size of the returned data block.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getrfidfile_wait().

bool GetRfidFileStop (  )  throw (gxError) [inline]

Cancel the rfid reading process started with the GetRfidFileStart() method.

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

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

References pr_getrfidfile_stop().

bool CheckRfidFileHash ( gxInStr  card,
int  fileid 
) throw (gxError) [inline]

Checks the hash of the file read from the RFID card (Unicode version).

Parameters:
card Serial number of the selected card.
fileid Identifier of the requested file. The possible values are defined in the PR_RFID_FILES enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_checkrfidfilehash().

bool CheckRfidFileHash ( gxInAStr  card,
int  fileid 
) throw (gxError) [inline]

Checks the hash of the file read from the RFID card (ASCII version).

Parameters:
card Serial number of the selected card.
fileid Identifier of the requested file. The possible values are defined in the PR_RFID_FILES enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_checkrfidfilehash().

prDoc* ResolveRfidData ( const void *  data,
int  sdata 
) throw (gxError) [inline]

Resolves a composite RFID data.

Parameters:
data Composite RFID data read from the chip.
sdata The size of the data.
Returns:
A prDoc object containing the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

bool GetApplications ( const wchar_t *  card,
int **  apps,
int *  napps 
) throw (gxError) [inline]

Get applications supported by the card.

(Unicode version).

Parameters:
card The id of the RFID card.
apps Array of supported applications. The possible values are defined in the PR_APP_TYPE enumeration.
napps Number of items in the application array.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getapplications().

bool GetApplications ( const char *  card,
int **  apps,
int *  napps 
) throw (gxError) [inline]

Get applications supported by the card.

(ASCII version).

Parameters:
card The id of the RFID card.
apps Array of supported applications. The possible values are defined in the PR_APP_TYPE enumeration.
napps Number of items in the application array.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getapplicationsa().

bool SelectApplication ( const wchar_t *  card,
PR_APP_TYPE  Application 
) throw (gxError) [inline]

Select the chip application.

(Unicode version).

Parameters:
card The id of the RFID card.
Application Type of the application.The possible values are defined in the PR_APP_TYPE enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_selectapplication().

bool SelectApplication ( const char *  card,
PR_APP_TYPE  Application 
) throw (gxError) [inline]

Select the chip application.

(ASCII version).

Parameters:
card The id of the RFID card.
Application Type of the application.The possible values are defined in the PR_APP_TYPE enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_selectapplicationa().

bool SelectApplication ( gxInStr  card,
PR_APP_TYPE  Application 
) throw (gxError) [inline]

Select the chip application.

(Unicode version).

Parameters:
card The id of the RFID card.
Application Type of the application.The possible values are defined in the PR_APP_TYPE enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_selectapplication().

bool SelectApplication ( gxInAStr  card,
PR_APP_TYPE  Application 
) throw (gxError) [inline]

Select the chip application.

(ASCII version).

Parameters:
card The id of the RFID card.
Application Type of the application.The possible values are defined in the PR_APP_TYPE enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_selectapplication().

bool MakeBAC ( const wchar_t *  card,
const wchar_t **  lines,
int  nlines 
) throw (gxError) [inline]

Switches to secure messaging by making Basic Access Control (Unicode version).

Parameters:
card The id of the RFID card.
lines The MRZ lines printed on the MRTD (array of strings).
nlines The number of lines printed on the MRTD.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makebac().

bool MakeBAC ( const char *  card,
const char **  lines,
int  nlines 
) throw (gxError) [inline]

Switches to secure messaging by making Basic Access Control (ASCII version).

Parameters:
card The id of the RFID card.
lines The MRZ lines printed on the MRTD (array of strings).
nlines The number of lines printed on the MRTD.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makebac().

bool MakeBAC ( gxInStr  card,
gxInStrArray  lines 
) throw (gxError) [inline]

Switches to secure messaging by making Basic Access Control (Unicode version).

Parameters:
card The id of the RFID card.
lines The MRZ lines printed on the MRTD (array of strings).
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makebac().

bool MakeBAC ( gxInAStr  card,
gxInAStrArray  lines 
) throw (gxError) [inline]

Switches to secure messaging by making Basic Access Control (ASCII version).

Parameters:
card The id of the RFID card.
lines The MRZ lines printed on the MRTD (array of strings).
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makebac().

bool MakePACE ( const wchar_t *  card,
const wchar_t **  lines,
int  nlines,
int  PasswordType 
) throw (gxError) [inline]

Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (Unicode version).

Parameters:
card The id of the RFID card.
lines The MRZ or CAN(Card Access Number) lines printed on the MRTD (array of strings).
nlines The number of lines printed on the MRTD.
PasswordType The type of the password. The possible values are defined in the PR_PACE_PASSWORD enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makepace().

bool MakePACE ( const char *  card,
const char **  lines,
int  nlines,
int  PasswordType 
) throw (gxError) [inline]

Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (ASCII version).

Parameters:
card The id of the RFID card.
lines The MRZ or CAN(Card Access Number) lines printed on the MRTD (array of strings).
nlines The number of lines printed on the MRTD.
PasswordType The type of the password. The possible values are defined in the PR_PACE_PASSWORD enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makepace().

bool MakePACE ( gxInStr  card,
gxInStrArray  lines,
int  PasswordType 
) throw (gxError) [inline]

Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (Unicode version).

Parameters:
card The id of the RFID card.
lines The MRZ or CAN(Card Access Number) lines printed on the MRTD (array of strings).
PasswordType The type of the password. The possible values are defined in the PR_PACE_PASSWORD enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makepace().

bool MakePACE ( gxInAStr  card,
gxInAStrArray  lines,
int  PasswordType 
) throw (gxError) [inline]

Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (ASCII version).

Parameters:
card The id of the RFID card.
lines The MRZ or CAN(Card Access Number) lines printed on the MRTD (array of strings).
PasswordType The type of the password. The possible values are defined in the PR_PACE_PASSWORD enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makepace().

int GetNextAuthentication ( const wchar_t *  card,
int  ForceNext = false 
) throw (gxError) [inline]

Returns the next suggested authentication process (Unicode version).

Parameters:
card Serial number of the selected card.
ForceNext Skips the actual authentication.
Returns:
Next authentication process id. The possible values are defined in the PR_AUTH_PROC enumeration. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getnextauthentication().

int GetNextAuthentication ( const char *  card,
int  ForceNext = false 
) throw (gxError) [inline]

Returns the next suggested authentication process (ASCII version).

Parameters:
card Serial number of the selected card.
ForceNext Skips the actual authentication.
Returns:
Next authentication process id. The possible values are defined in the PR_AUTH_PROC enumeration. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getnextauthentication().

int DoAuthentication ( const wchar_t *  card,
int  Authentication,
const wchar_t **  AuthData = 0,
int  Lines = 0,
int  PasswordType = PR_PACE_PW_MRZ 
) throw (gxError) [inline]

Making authentication process (Unicode version).

Parameters:
card Serial number of the selected card.
Authentication Authentication process id. The possible values are defined in the PR_AUTH_PROC enumeration.
AuthData MRZ,PIN,CAN data for BAC and PACE authentications.
Lines Number of rows in AuthData.
PasswordType The type of the PACE password. The possible values are defined in the PR_PACE_PASSWORD enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_doauthentication().

int DoAuthentication ( const char *  card,
int  Authentication,
const char **  AuthData = 0,
int  Lines = 0,
int  PasswordType = PR_PACE_PW_MRZ 
) throw (gxError) [inline]

Making authentication process (ASCII version).

Parameters:
card Serial number of the selected card.
Authentication Authentication process id. The possible values are defined in the PR_AUTH_PROC enumeration.
AuthData MRZ,PIN,CAN data for BAC and PACE authentications.
Lines Number of rows in AuthData.
PasswordType The type of the PACE password. The possible values are defined in the PR_PACE_PASSWORD enumeration.
Returns:
On error false is returned and the error code/string in the GX syste is set appropriately. ( see gx_geterror() )

References pr_doauthenticationa().

bool MakePassiveAuth ( const wchar_t *  card  )  throw (gxError) [inline]

Makes the Passive Authentication of the RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makepassiveauth().

bool MakePassiveAuth ( const char *  card  )  throw (gxError) [inline]

Makes the Passive Authentication of the RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makepassiveauth().

bool MakeActiveAuth ( const wchar_t *  card  )  throw (gxError) [inline]

Makes the Active Authentication of the RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )
Note:
Comparation of the MRZ read visually from the MRTD's data page and the MRZ value in Data Group 1 is skipped.

References pr_makeactiveauth().

bool MakeActiveAuth ( const char *  card  )  throw (gxError) [inline]

Makes the Active Authentication of the RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )
Note:
Comparation of the MRZ read visually from the MRTD's data page and the MRZ value in Data Group 1 is skipped.

References pr_makeactiveauth().

bool MakeChipAuth ( const wchar_t *  card  )  throw (gxError) [inline]

Makes the Chip Authentication of the RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makechipauth().

bool MakeChipAuth ( const char *  card  )  throw (gxError) [inline]

Makes the Chip Authentication of the RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makechipauth().

bool MakeTerminalAuth ( const wchar_t *  card  )  throw (gxError) [inline]

Makes the Terminal Authentication of the RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_maketerminalauth().

bool MakeTerminalAuth ( const char *  card  )  throw (gxError) [inline]

Makes the Terminal Authentication of the RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_maketerminalauth().

bool InitTerminalAuth ( const wchar_t *  card,
void **  data,
int *  sdata 
) throw (gxError) [inline]

Initiates the Terminal Authentication of the RFID chip (Unicode version).

Parameters:
card Serial number of the selected card.
data Data to sign.
sdata Size of the data.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_initta().

bool InitTerminalAuth ( const char *  card,
void **  data,
int *  sdata 
) throw (gxError) [inline]

Initiates the Terminal Authentication of the RFID chip (ASCII version).

Parameters:
card Serial number of the selected card.
data Data to sign.
sdata Size of the data.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_initta().

bool CompleteTerminalAuth ( const wchar_t *  card,
const void *  data,
int  sdata 
) throw (gxError) [inline]

Completes the Terminal Authentication of the RFID chip (Unicode version).

Parameters:
card Serial number of the selected card.
data Signature.
sdata Size of the signature.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_completeta().

bool CompleteTerminalAuth ( const char *  card,
const void *  data,
int  sdata 
) throw (gxError) [inline]

Completes the Terminal Authentication of the RFID chip (ASCII version).

Parameters:
card Serial number of the selected card.
data Signature.
sdata Size of the signature.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_completeta().

bool LoadCertFile ( const wchar_t *  certificate,
const wchar_t *  privateKey = NULL 
) throw (gxError) [inline]

Loads a certificate and a private key from file (Unicode version).

Parameters:
certificate The name of the certificate file.
privateKey The name of the private key file connected to the certificate. This can be NULL.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_loadcertfile().

bool LoadCertFile ( const char *  certificate,
const char *  privateKey = NULL 
) throw (gxError) [inline]

Loads a certificate and a private key from file (ASCII version).

Parameters:
certificate The name of the certificate file.
privateKey The name of the private key file connected to the certificate. This can be NULL.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_loadcertfile().

bool LoadCertFromStore ( const wchar_t *  storename  )  throw (gxError) [inline]

Loads certificates and CRLs from store (Unicode version).

Parameters:
storename The name of the store.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_loadcertfromstore().

bool LoadCertFromStore ( const char *  storename  )  throw (gxError) [inline]

Loads certificates and CRLs from store (ASCII version).

Parameters:
storename The name of the store.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_loadcertfromstore().

bool LoadCertFileFromMem ( void *  certificate_data,
unsigned int  certificate_length,
void *  privateKey_data = NULL,
unsigned int  privateKey_length = 0 
) throw (gxError) [inline]

Loads a certificate and a private key from memory.

Parameters:
certificate_data Pointer to the certificate memory area.
certificate_length Length of certificate_data [byte].
privateKey_data Pointer to the private key memory area. This can be NULL.
privateKey_length Length of privateKey_data [byte]. This can be 0.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_loadcertfrommem().

int GetNextAuthentication ( gxInStr  card,
int  ForceNext = false 
) throw (gxError) [inline]

Returns the next suggested authentication process (Unicode version).

Parameters:
card Serial number of the selected card.
ForceNext Skips the actual authentication.
Returns:
Next authentication process id. The possible values are defined in the PR_AUTH_PROC enumeration. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getnextauthentication().

int DoAuthentication ( gxInStr  card,
int  Authentication,
gxInStrArray  AuthData,
int  PasswordType = PR_PACE_PW_MRZ 
) throw (gxError) [inline]

Making authentication process (Unicode version).

Parameters:
card Serial number of the selected card.
Authentication Authentication process id. The possible values are defined in the PR_AUTH_PROC enumeration.
AuthData MRZ,PIN,CAN data for BAC and PACE authentications.
PasswordType The type of the PACE password. The possible values are defined in the PR_PACE_PASSWORD enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_doauthentication().

int DoAuthentication ( gxInStr  card,
int  Authentication 
) throw (gxError) [inline]

Making authentication process (Unicode version).

Parameters:
card Serial number of the selected card.
Authentication Authentication process id. The possible values are defined in the PR_AUTH_PROC enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_doauthentication().

bool MakePassiveAuth ( gxInStr  card  )  throw (gxError) [inline]

Makes the Passive Authentication of the RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makepassiveauth().

bool MakeActiveAuth ( gxInStr  card  )  throw (gxError) [inline]

Makes the Active Authentication of the RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )
Note:
Comparation of the MRZ read visually from the MRTD's data page and the MRZ value in Data Group 1 is skipped.

References pr_makeactiveauth().

bool MakeChipAuth ( gxInStr  card  )  throw (gxError) [inline]

Makes the Chip Authentication of the RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makechipauth().

bool MakeTerminalAuth ( gxInStr  card  )  throw (gxError) [inline]

Makes the Terminal Authentication of the RFID chip (Unicode version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_maketerminalauth().

bool LoadCertFile ( gxInStr  certificate,
gxInStr  privateKey 
) throw (gxError) [inline]

Loads a certificate and a private key from file (Unicode version).

Parameters:
certificate The name of the certificate file.
privateKey The name of the private key file connected to the certificate. This can be NULL.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_loadcertfile().

bool LoadCertFromStore ( gxInStr  storename  )  throw (gxError) [inline]

Loads certificates and CRLs from store (Unicode version).

Parameters:
storename The name of the store.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_loadcertfromstore().

int GetNextAuthentication ( gxInAStr  card,
int  ForceNext = false 
) throw (gxError) [inline]

Returns the next suggested authentication process (ASCII version).

Parameters:
card Serial number of the selected card.
ForceNext Skips the actual authentication.
Returns:
Next authentication process id. The possible values are defined in the PR_AUTH_PROC enumeration. On error -1 is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_getnextauthentication().

int DoAuthentication ( gxInAStr  card,
int  Authentication,
gxInAStrArray  AuthData,
int  PasswordType = PR_PACE_PW_MRZ 
) throw (gxError) [inline]

Making authentication process (ASCII version).

Parameters:
card Serial number of the selected card.
Authentication Authentication process id. The possible values are defined in the PR_AUTH_PROC enumeration.
AuthData MRZ,PIN,CAN data for BAC and PACE authentications.
PasswordType The type of the PACE password. The possible values are defined in the PR_PACE_PASSWORD enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_doauthenticationa().

int DoAuthentication ( gxInAStr  card,
int  Authentication 
) throw (gxError) [inline]

Making authentication process (ASCII version).

Parameters:
card Serial number of the selected card.
Authentication Authentication process id. The possible values are defined in the PR_AUTH_PROC enumeration.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_doauthenticationa().

bool MakePassiveAuth ( gxInAStr  card  )  throw (gxError) [inline]

Makes the Passive Authentication of the RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makepassiveauth().

bool MakeActiveAuth ( gxInAStr  card  )  throw (gxError) [inline]

Makes the Active Authentication of the RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )
Note:
Comparation of the MRZ read visually from the MRTD's data page and the MRZ value in Data Group 1 is skipped.

References pr_makeactiveauth().

bool MakeChipAuth ( gxInAStr  card  )  throw (gxError) [inline]

Makes the Chip Authentication of the RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_makechipauth().

bool MakeTerminalAuth ( gxInAStr  card  )  throw (gxError) [inline]

Makes the Terminal Authentication of the RFID chip (ASCII version).

Parameters:
card The id of the RFID card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_maketerminalauth().

bool LoadCertFile ( gxInAStr  certificate,
gxInAStr  privateKey 
) throw (gxError) [inline]

Loads a certificate and a private key from file (ASCII version).

Parameters:
certificate The name of the certificate file.
privateKey The name of the private key file connected to the certificate. This can be NULL.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_loadcertfile().

bool LoadCertFromStore ( gxInAStr  storename  )  throw (gxError) [inline]

Loads certificates and CRLs from store (ASCII version).

Parameters:
storename The name of the store.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_loadcertfromstore().

bool ClearCertList ( int  sel  )  throw (gxError) [inline]

Clears the internal certificate list.

Parameters:
sel List selector. Set 0 to clear all the certificate lists, set to 1 to clear PA certificate list, set to 2 to clear TA certificate list.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References pr_clearcertlist().

gxVariant* GetRfidCardInfo ( const wchar_t *  card  )  throw (gxError) [inline]

Returns information about the rfid card (Unicode version).

Parameters:
card Serial number of the selected card.
Returns:
The Rfid card info in variant data type.

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

gxVariant* GetRfidCardInfo ( const char *  card  )  throw (gxError) [inline]

Returns information about the rfid card (ASCII version).

Parameters:
card Serial number of the selected card.
Returns:
The Rfid card info in variant data type.

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

gxVariant* GetCertificateId ( const char *  card,
int  Authentication 
) throw (gxError) [inline]

Returns information about the necessary certificate (ASCII version).

Parameters:
card Serial number of the selected card.
Authentication Authentication Id. The possible values are defined in the PR_AUTH_PROC enumeration.
Returns:
The certificate Id info in variant data type.

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

gxVariant* GetCertificateId ( const wchar_t *  card,
int  Authentication 
) throw (gxError) [inline]

Returns information about the necessary certificate (Unicode version).

Parameters:
card Serial number of the selected card.
Authentication Authentication Id. The possible values are defined in the PR_AUTH_PROC enumeration.
Returns:
The certificate Id info in variant data type.

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

gxVariant* GetRfidCardInfo ( gxInStr  card  )  throw (gxError) [inline]

Returns information about the rfid card (Unicode version).

Parameters:
card Serial number of the selected card.
Returns:
The Rfid card info in variant data type.

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

gxVariant* GetCertificateId ( gxInStr  card,
int  Authentication 
) throw (gxError) [inline]

Returns information about the necessary certificate (Unicode version).

Parameters:
card Serial number of the selected card.
Authentication Authentication Id. The possible values are defined in the PR_AUTH_PROC enumeration.
Returns:
The certificate Id info in variant data type.

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

gxVariant* GetRfidCardInfo ( gxInAStr  card  )  throw (gxError) [inline]

Returns information about the rfid card (ASCII version).

Parameters:
card Serial number of the selected card.
Returns:
The Rfid card info in variant data type.

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

gxVariant* GetCertificateId ( gxInAStr  card,
int  Authentication 
) throw (gxError) [inline]

Returns information about the necessary certificate (ASCII version).

Parameters:
card Serial number of the selected card.
Authentication Authentication Id. The possible values are defined in the PR_AUTH_PROC enumeration.
Returns:
The certificate Id info in variant data type.

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

prDoc* CompareFace ( int  page,
int  face_no 
) throw (gxError) [inline]

Compares a captured face photo with one that is stored in rfid chip.

The application must call ResolveRfidData() function first.

Parameters:
page The actual page of the image.
face_no The ordinal number of the face image in rfid data.
Returns:
A prDoc object contains the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

gxVariant* DecodeLatentImage ( int  page,
int  light,
int  type,
const wchar_t *  decpar 
) throw (gxError) [inline]

Decodes a latent image from a stored image.

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. The possible values are defined in the PR_IMAGE_TYPE enumeration.
decpar Decoding parameter.
Returns:
The latent image.

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

gxVariant* DecodeLatentImage ( int  page,
int  light,
int  type,
gxInStr  decpar 
) throw (gxError) [inline]

Decodes a latent image from a stored image.

Parameters:
page The actual page of the image.
light The light settings. The possible values are defined in the PR_LIGHT enumeration.
type The type of the image. The possible values are defined in the PR_IMAGE_TYPE enumeration.
decpar Decoding parameter.
Returns:
The latent image.

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

prDoc* LoadDocument ( const wchar_t *  filename  )  throw (gxError) [inline]

Loads a document from the mass storage device (Unicode version).

Parameters:
filename Name of the file to load the document from.
Returns:
A prDoc object containing the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* LoadDocument ( const char *  filename  )  throw (gxError) [inline]

Loads a document from the mass storage device (ASCII version).

Parameters:
filename Name of the file to load the document from.
Returns:
A prDoc object containing the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* LoadDocumentFromMem ( const gxu8 *  buffer,
gxi32  buflen 
) throw (gxError) [inline]

Loads a document from the memory.

Parameters:
buffer Pointer to the data.
buflen Length of data in bytes.
Returns:
A prDoc object containing the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* LoadDocument ( gxInStr  filename  )  throw (gxError) [inline]

Loads a document from the mass storage device (Unicode version).

Parameters:
filename Name of the file to load the document from.
Returns:
A prDoc object containing the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* LoadDocument ( gxInAStr  filename  )  throw (gxError) [inline]

Loads a document from the mass storage device (ASCII version).

Parameters:
filename Name of the file to load the document from.
Returns:
A prDoc object containing the data of the document. On error an empty object is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

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

prDoc* GetDocumentRoot (  )  throw (gxError) [inline]

Returns the root document of the PR system.

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

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

Generated  for Passport Reader
(c) ARH Inc.