Header

RFID handling


Detailed Description

Functions for managing e-Passports.


Modules

 Examples
 RFID example

Functions

static int pr_getrfidcardlist (gxHANDLE handle, wchar_t ***cards, int *ncards)
 Gets the list of cards in the range of the contactless reader (Unicode version).
static int pr_getrfidcardlista (gxHANDLE handle, char ***cards, int *ncards)
 Gets the list of cards in the range of the contactless reader (ASCII version).
static int pr_getrfidfile (gxHANDLE handle, const wchar_t *card, int fileid, void **data, int *sdata)
 Reads files from the RFID card (Unicode version).
static int pr_getrfidfilea (gxHANDLE handle, const char *card, int fileid, void **data, int *sdata)
 Reads files from the RFID card (ASCII version).
static int pr_getrfidfile_start (gxHANDLE handle, const wchar_t *card, int fileid, int *reqid)
 Starts reading files from the RFID card in asynchronous mode.
static int pr_getrfidfile_starta (gxHANDLE handle, const char *card, int fileid, int *reqid)
 Starts reading files from the RFID card in asynchronous mode.
static int pr_getrfidfile_getstatus (gxHANDLE handle, int reqid, int *status)
 Returns the state of a rfid reading process started with the pr_getrfidfile_start() function.
static int pr_getrfidfile_wait (gxHANDLE handle, int reqid, void **data, int *sdata)
 Wait for the finish of the rfid reading process started with the pr_getrfidfile_start() function.
static int pr_getrfidfile_stop (gxHANDLE handle)
 Cancel the rfid reading process started with the pr_getrfidfile_start() function.
static int pr_resolverfiddata (gxHANDLE handle, const void *data, int sdata, gxVARIANT *doc)
 Resolves a composite RFID data and fills a document structure with the descompounded data.
static int pr_getapplications (gxHANDLE handle, const wchar_t *card, int **apps, int *napps)
 Get applications supported by the card.
static int pr_getapplicationsa (gxHANDLE handle, const char *card, int **apps, int *napps)
 Get applications supported by the card.
static int pr_selectapplication (gxHANDLE handle, const wchar_t *card, int application)
 Select the chip application.
static int pr_selectapplicationa (gxHANDLE handle, const char *card, int application)
 Select the chip application.
static int pr_makebac (gxHANDLE handle, const wchar_t *card, const wchar_t **lines, int nlines)
 Switches to secure messaging by making Basic Access Control (Unicode version).
static int pr_makebaca (gxHANDLE handle, const char *card, const char **lines, int nlines)
 Switches to secure messaging by making Basic Access Control (ASCII version).
static int pr_makepace (gxHANDLE handle, const wchar_t *card, const wchar_t **lines, int nlines, int PasswordType)
 Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (Unicode version).
static int pr_makepacea (gxHANDLE handle, const char *card, const char **lines, int nlines, int PasswordType)
 Switches to secure messaging by making Password Authenticated Connection Establishment (PACE) (ASCII version).
static int pr_makepassiveauth (gxHANDLE handle, const wchar_t *card)
 Makes the Passive Authentication of the RFID chip (Unicode version).
static int pr_makepassiveautha (gxHANDLE handle, const char *card)
 Makes the Passive Authentication of the RFID chip (ASCII version).
static int pr_makeactiveauth (gxHANDLE handle, const wchar_t *card)
 Makes the Active Authentication of the RFID chip (Unicode version).
static int pr_makeactiveautha (gxHANDLE handle, const char *card)
 Makes the Active Authentication of the RFID chip (ASCII version).
static int pr_makechipauth (gxHANDLE handle, const wchar_t *card)
 Makes the Chip Authentication of the RFID chip (Unicode version).
static int pr_makechipautha (gxHANDLE handle, const char *card)
 Makes the Chip Authentication of the RFID chip (ASCII version).
static int pr_maketerminalauth (gxHANDLE handle, const wchar_t *card)
 Makes the Terminal Authentication of the RFID chip (Unicode version).
static int pr_maketerminalautha (gxHANDLE handle, const char *card)
 Makes the Terminal Authentication of the RFID chip (ASCII version).
static int pr_initta (gxHANDLE handle, const wchar_t *card, void **data, int *sdata)
 Initiates the Terminal Authentication of the RFID chip (Unicode version).
static int pr_inittaa (gxHANDLE handle, const char *card, void **data, int *sdata)
 Initiates the Terminal Authentication of the RFID chip (ASCII version).
static int pr_completeta (gxHANDLE handle, const wchar_t *card, const void *data, int sdata)
 Completes the Terminal Authentication of the RFID chip (Unicode version).
static int pr_completetaa (gxHANDLE handle, const char *card, const void *data, int sdata)
 Completes the Terminal Authentication of the RFID chip (ASCII version).
static int pr_loadcertfile (gxHANDLE handle, const wchar_t *certificate, const wchar_t *privateKey)
 Loads a certificate and a private key from file (Unicode version).
static int pr_loadcertfilea (gxHANDLE handle, const char *certificate, const char *privateKey)
 Loads a certificate and a private key from file (ASCII version).
static int pr_loadcertfromstore (gxHANDLE handle, const wchar_t *storename)
 Loads certificates and CRLs from store (Unicode version).
static int pr_loadcertfromstorea (gxHANDLE handle, const char *storename)
 Loads certificates and CRLs from store (ASCII version).
static int pr_loadcertfrommem (gxHANDLE handle, void *certificate_data, unsigned int certificate_length, void *privateKey_data, unsigned int privateKey_length)
 Loads a certificate and a private key from memory.
static int pr_clearcertlist (gxHANDLE handle, int sel)
 Clears the internal certificate list.
static int pr_connectrfidcard (gxHANDLE handle, const wchar_t *card)
 Connects to an RFID card (Unicode version).
static int pr_connectrfidcarda (gxHANDLE handle, const char *card)
 Connects to an RFID card (ASCII version).
static int pr_disconnectrfidcard (gxHANDLE handle, const wchar_t *card)
 Disconnects from RFID card (Unicode version).
static int pr_disconnectrfidcarda (gxHANDLE handle, const char *card)
 Disconnects from an RFID card (ASCII version).
static int pr_checkrfidfilehash (gxHANDLE handle, const wchar_t *card, int fileid)
 Checks the hash of the file read from the RFID card (Unicode version).
static int pr_checkrfidfilehasha (gxHANDLE handle, const char *card, int fileid)
 Checks the hash of the file read from the RFID card (ASCII version).
static int pr_getrfidcardinfo (gxHANDLE handle, const wchar_t *card, gxVARIANT *cardinfo)
 Gets information about the rfid card (Unicode version).
static int pr_getrfidcardinfoa (gxHANDLE handle, const char *card, gxVARIANT *cardinfo)
 Gets information about the rfid card (ASCII version).
static int pr_getcertificateid (gxHANDLE handle, const wchar_t *card, int Authentication, gxVARIANT *CertificateId)
 Gets information about certificate (Unicode version).
static int pr_getcertificateida (gxHANDLE handle, const char *card, int Authentication, gxVARIANT *CertificateId)
 Gets information about certificate (ASCII version).
static int pr_getnextauthentication (gxHANDLE handle, const wchar_t *card, int *Authentication, int ForceNext)
 Gets information about the next suggested authentication process (Unicode version).
static int pr_getnextauthenticationa (gxHANDLE handle, const char *card, int *Authentication, int ForceNext)
 Gets information about the next suggested authentication process (Unicode version).
static int pr_doauthentication (gxHANDLE handle, const wchar_t *card, int Authentication, const wchar_t **AuthData, int Lines, int PasswordType)
 Making authentication process (ASCII version).
static int pr_doauthenticationa (gxHANDLE handle, const char *card, int Authentication, const char **AuthData, int Lines, int PasswordType)
 Making authentication process (Unicode version).
static int pr_getrfidfilelist (gxHANDLE handle, const wchar_t *card, int **files, int *nfiles)
 Gets a list of available rfid files.
static int pr_convertfid (gxHANDLE handle, const wchar_t *card, int *file_id)
 Converts rfid file ids between general id and data group number form.
static int pr_getrfidauthresult (gxHANDLE handle, const wchar_t *card, gxVARIANT *pdoc)
 Returns the rfid authentication results in document form.


Function Documentation

static int pr_getrfidcardlist ( gxHANDLE  handle,
wchar_t ***  cards,
int *  ncards 
) [static]

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

static int pr_getrfidcardlista ( gxHANDLE  handle,
char ***  cards,
int *  ncards 
) [static]

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

static int pr_getrfidfile ( gxHANDLE  handle,
const wchar_t *  card,
int  fileid,
void **  data,
int *  sdata 
) [static]

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

static int pr_getrfidfilea ( gxHANDLE  handle,
const char *  card,
int  fileid,
void **  data,
int *  sdata 
) [static]

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

static int pr_getrfidfile_start ( gxHANDLE  handle,
const wchar_t *  card,
int  fileid,
int *  reqid 
) [static]

Starts reading files from the RFID card in asynchronous mode.

(Unicode version)

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
fileid Identifier of the requested file (see the PR_RFID_FILES enumeration).
reqid Id for the getstatus and the wait functions.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_getrfidfile_starta ( gxHANDLE  handle,
const char *  card,
int  fileid,
int *  reqid 
) [static]

Starts reading files from the RFID card in asynchronous mode.

(ASCII version)

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
fileid Identifier of the requested file (see the PR_RFID_FILES enumeration).
reqid Id for the getstatus and the wait functions.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_getrfidfile_getstatus ( gxHANDLE  handle,
int  reqid,
int *  status 
) [static]

Returns the state of a rfid reading process started with the pr_getrfidfile_start() function.

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

Parameters:
handle Handle of the prapi module.
reqid Id for the process. The pr_getrfidfile_start() returned this value.
status Buffer for the result. The value of the result is in percent, it can be negative when the capture is in preprocess state.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_getrfidfile_wait ( gxHANDLE  handle,
int  reqid,
void **  data,
int *  sdata 
) [static]

Wait for the finish of the rfid reading process started with the pr_getrfidfile_start() function.

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

Parameters:
handle Handle of the prapi module.
reqid Id of the capture returned by the pr_getrfidfile_start().
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 gx_call().

static int pr_getrfidfile_stop ( gxHANDLE  handle  )  [static]

Cancel the rfid reading process started with the pr_getrfidfile_start() function.

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

Parameters:
handle Handle of the prapi module.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_resolverfiddata ( gxHANDLE  handle,
const void *  data,
int  sdata,
gxVARIANT doc 
) [static]

Resolves a composite RFID data and fills a document structure with the descompounded data.

Parameters:
handle Handle of the prapi module.
data Composite RFID data read from the chip.
sdata The size of the data.
doc Document structure filled with the descompounded rfid data.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_getapplications ( gxHANDLE  handle,
const wchar_t *  card,
int **  apps,
int *  napps 
) [static]

Get applications supported by the card.

(Unicode version).

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

static int pr_getapplicationsa ( gxHANDLE  handle,
const char *  card,
int **  apps,
int *  napps 
) [static]

Get applications supported by the card.

(ASCII version).

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

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

static int pr_selectapplication ( gxHANDLE  handle,
const wchar_t *  card,
int  application 
) [static]

Select the chip application.

(Unicode version).

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

static int pr_selectapplicationa ( gxHANDLE  handle,
const char *  card,
int  application 
) [static]

Select the chip application.

(ASCII version).

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

static int pr_makebac ( gxHANDLE  handle,
const wchar_t *  card,
const wchar_t **  lines,
int  nlines 
) [static]

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

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
lines MRZ lines in array of row strings.
nlines Number of MRZ lines supplied.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_makebaca ( gxHANDLE  handle,
const char *  card,
const char **  lines,
int  nlines 
) [static]

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

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
lines MRZ lines in array of row strings.
nlines Number of MRZ lines supplied.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_makepace ( gxHANDLE  handle,
const wchar_t *  card,
const wchar_t **  lines,
int  nlines,
int  PasswordType 
) [static]

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

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
lines MRZ lines in array of row strings.
nlines Number of MRZ lines supplied.
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 gx_call().

static int pr_makepacea ( gxHANDLE  handle,
const char *  card,
const char **  lines,
int  nlines,
int  PasswordType 
) [static]

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

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
lines MRZ lines in array of row strings.
nlines Number of MRZ lines supplied.
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 gx_call().

static int pr_makepassiveauth ( gxHANDLE  handle,
const wchar_t *  card 
) [static]

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

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_makepassiveautha ( gxHANDLE  handle,
const char *  card 
) [static]

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

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_makeactiveauth ( gxHANDLE  handle,
const wchar_t *  card 
) [static]

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

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

static int pr_makeactiveautha ( gxHANDLE  handle,
const char *  card 
) [static]

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

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

static int pr_makechipauth ( gxHANDLE  handle,
const wchar_t *  card 
) [static]

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

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_makechipautha ( gxHANDLE  handle,
const char *  card 
) [static]

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

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_maketerminalauth ( gxHANDLE  handle,
const wchar_t *  card 
) [static]

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

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_maketerminalautha ( gxHANDLE  handle,
const char *  card 
) [static]

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

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_initta ( gxHANDLE  handle,
const wchar_t *  card,
void **  data,
int *  sdata 
) [static]

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

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

static int pr_inittaa ( gxHANDLE  handle,
const char *  card,
void **  data,
int *  sdata 
) [static]

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

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

static int pr_completeta ( gxHANDLE  handle,
const wchar_t *  card,
const void *  data,
int  sdata 
) [static]

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

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

static int pr_completetaa ( gxHANDLE  handle,
const char *  card,
const void *  data,
int  sdata 
) [static]

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

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

static int pr_loadcertfile ( gxHANDLE  handle,
const wchar_t *  certificate,
const wchar_t *  privateKey 
) [static]

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

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

static int pr_loadcertfilea ( gxHANDLE  handle,
const char *  certificate,
const char *  privateKey 
) [static]

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

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

static int pr_loadcertfromstore ( gxHANDLE  handle,
const wchar_t *  storename 
) [static]

Loads certificates and CRLs from store (Unicode version).

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

static int pr_loadcertfromstorea ( gxHANDLE  handle,
const char *  storename 
) [static]

Loads certificates and CRLs from store (ASCII version).

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

static int pr_loadcertfrommem ( gxHANDLE  handle,
void *  certificate_data,
unsigned int  certificate_length,
void *  privateKey_data,
unsigned int  privateKey_length 
) [static]

Loads a certificate and a private key from memory.

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

static int pr_clearcertlist ( gxHANDLE  handle,
int  sel 
) [static]

Clears the internal certificate list.

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

static int pr_connectrfidcard ( gxHANDLE  handle,
const wchar_t *  card 
) [static]

Connects to an RFID card (Unicode version).

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_connectrfidcarda ( gxHANDLE  handle,
const char *  card 
) [static]

Connects to an RFID card (ASCII version).

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_disconnectrfidcard ( gxHANDLE  handle,
const wchar_t *  card 
) [static]

Disconnects from RFID card (Unicode version).

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_disconnectrfidcarda ( gxHANDLE  handle,
const char *  card 
) [static]

Disconnects from an RFID card (ASCII version).

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_checkrfidfilehash ( gxHANDLE  handle,
const wchar_t *  card,
int  fileid 
) [static]

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

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

static int pr_checkrfidfilehasha ( gxHANDLE  handle,
const char *  card,
int  fileid 
) [static]

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

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

static int pr_getrfidcardinfo ( gxHANDLE  handle,
const wchar_t *  card,
gxVARIANT cardinfo 
) [static]

Gets information about the rfid card (Unicode version).

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
cardinfo Variant structure for card information.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_getrfidcardinfoa ( gxHANDLE  handle,
const char *  card,
gxVARIANT cardinfo 
) [static]

Gets information about the rfid card (ASCII version).

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
cardinfo Variant structure for card information.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_getcertificateid ( gxHANDLE  handle,
const wchar_t *  card,
int  Authentication,
gxVARIANT CertificateId 
) [static]

Gets information about certificate (Unicode version).

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

References gx_call().

static int pr_getcertificateida ( gxHANDLE  handle,
const char *  card,
int  Authentication,
gxVARIANT CertificateId 
) [static]

Gets information about certificate (ASCII version).

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

References gx_call().

static int pr_getnextauthentication ( gxHANDLE  handle,
const wchar_t *  card,
int *  Authentication,
int  ForceNext 
) [static]

Gets information about the next suggested authentication process (Unicode version).

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

References gx_call().

static int pr_getnextauthenticationa ( gxHANDLE  handle,
const char *  card,
int *  Authentication,
int  ForceNext 
) [static]

Gets information about the next suggested authentication process (Unicode version).

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

References gx_call().

static int pr_doauthentication ( gxHANDLE  handle,
const wchar_t *  card,
int  Authentication,
const wchar_t **  AuthData,
int  Lines,
int  PasswordType 
) [static]

Making authentication process (ASCII version).

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

static int pr_doauthenticationa ( gxHANDLE  handle,
const char *  card,
int  Authentication,
const char **  AuthData,
int  Lines,
int  PasswordType 
) [static]

Making authentication process (Unicode version).

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

static int pr_getrfidfilelist ( gxHANDLE  handle,
const wchar_t *  card,
int **  files,
int *  nfiles 
) [static]

Gets a list of available rfid files.

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

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
files Array of supported files. The possible values are defined in the PR_RFID_FILES enumeration.
nfiles Number of items in the file array.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_convertfid ( gxHANDLE  handle,
const wchar_t *  card,
int *  file_id 
) [static]

Converts rfid file ids between general id and data group number form.

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
file_id Buffer for file id.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().

static int pr_getrfidauthresult ( gxHANDLE  handle,
const wchar_t *  card,
gxVARIANT pdoc 
) [static]

Returns the rfid authentication results in document form.

Parameters:
handle Handle of the prapi module.
card Serial number of the selected card.
pdoc Buffer for the result document structure.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately. ( see gx_geterror() )

References gx_call().


Generated  for Passport Reader
(c) ADAPTIVE RECOGNITION