RFID handling

---

Detailed Description

Functions for managing e-Passports.

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

---

Function Documentation

int pr_getrfidcardlist	(	gxHANDLE	handle,
		wchar_t ***	cards,
		int *	ncards
	)			[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:

	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().

Referenced by PassportReader::GetRfidCardList(), and PassportReader::GetRfidCardListA().

int pr_getrfidcardlista	(	gxHANDLE	handle,
		char ***	cards,
		int *	ncards
	)			[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:

	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().

Referenced by pr_getrfidcardlist().

int pr_getrfidcardlist	(	gxHANDLE	handle,
		char ***	cards,
		int *	ncards
	)			[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:

	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 pr_getrfidcardlista().

int pr_getrfidfile	(	gxHANDLE	handle,
		const wchar_t *	card,
		int	fileid,
		void **	data,
		int *	sdata
	)			[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:

	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().

Referenced by PassportReader::GetRfidFile().

int pr_getrfidfilea	(	gxHANDLE	handle,
		const char *	card,
		int	fileid,
		void **	data,
		int *	sdata
	)			[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:

	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().

Referenced by pr_getrfidfile().

int pr_getrfidfile	(	gxHANDLE	handle,
		const char *	card,
		int	fileid,
		void **	data,
		int *	sdata
	)			[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:

	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 pr_getrfidfilea().

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

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().

Referenced by PassportReader::GetRfidFileStart().

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

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().

Referenced by pr_getrfidfile_start().

int pr_getrfidfile_start	(	gxHANDLE	handle,
		const char *	card,
		int	fileid,
		int *	reqid
	)			[inline]

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 pr_getrfidfile_starta().

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

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().

Referenced by PassportReader::GetRfidFileGetStatus().

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

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().

Referenced by PassportReader::GetRfidFileWait().

int pr_getrfidfile_stop

(

gxHANDLE

handle

)

[inline]

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().

Referenced by PassportReader::GetRfidFileStop().

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

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().

Referenced by PassportReader::ResolveRfidData().

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

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().

Referenced by PassportReader::GetApplications().

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

Get applications supported by the card.

(ASCII 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().

Referenced by PassportReader::GetApplications(), and pr_getapplications().

int pr_getapplications	(	gxHANDLE	handle,
		const char *	card,
		int **	apps,
		int *	napps
	)			[inline]

Get applications supported by the card.

(ASCII 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 pr_getapplicationsa().

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

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().

Referenced by PassportReader::SelectApplication().

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

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().

Referenced by pr_selectapplication(), and PassportReader::SelectApplication().

int pr_selectapplication	(	gxHANDLE	handle,
		const char *	card,
		int	application
	)			[inline]

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 pr_selectapplicationa().

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

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().

Referenced by PassportReader::MakeBAC().

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

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().

Referenced by pr_makebac().

int pr_makebac	(	gxHANDLE	handle,
		const char *	card,
		const char **	lines,
		int	nlines
	)			[inline]

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 pr_makebaca().

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

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().

Referenced by PassportReader::MakePACE().

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

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().

Referenced by pr_makepace().

int pr_makepace	(	gxHANDLE	handle,
		const char *	card,
		const char **	lines,
		int	nlines,
		int	PasswordType
	)			[inline]

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 pr_makepacea().

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

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().

Referenced by PassportReader::MakePassiveAuth().

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

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().

Referenced by pr_makepassiveauth().

int pr_makepassiveauth	(	gxHANDLE	handle,
		const char *	card
	)			[inline]

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 pr_makepassiveautha().

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

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().

Referenced by PassportReader::MakeActiveAuth().

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

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().

Referenced by pr_makeactiveauth().

int pr_makeactiveauth	(	gxHANDLE	handle,
		const char *	card
	)			[inline]

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 pr_makeactiveautha().

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

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().

Referenced by PassportReader::MakeChipAuth().

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

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().

Referenced by pr_makechipauth().

int pr_makechipauth	(	gxHANDLE	handle,
		const char *	card
	)			[inline]

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 pr_makechipautha().

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

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().

Referenced by PassportReader::MakeTerminalAuth().

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

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().

Referenced by pr_maketerminalauth().

int pr_maketerminalauth	(	gxHANDLE	handle,
		const char *	card
	)			[inline]

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 pr_maketerminalautha().

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

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().

Referenced by PassportReader::InitTerminalAuth().

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

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().

Referenced by pr_initta().

int pr_initta	(	gxHANDLE	handle,
		const char *	card,
		void **	data,
		int *	sdata
	)			[inline]

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 pr_inittaa().

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

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().

Referenced by PassportReader::CompleteTerminalAuth().

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

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().

Referenced by pr_completeta().

int pr_completeta	(	gxHANDLE	handle,
		const char *	card,
		const void *	data,
		int	sdata
	)			[inline]

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 pr_completetaa().

int pr_loadcertfile	(	gxHANDLE	handle,
		const wchar_t *	certificate,
		const wchar_t *	privateKey = NULL
	)			[inline]

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().

Referenced by PassportReader::LoadCertFile().

int pr_loadcertfilea	(	gxHANDLE	handle,
		const char *	certificate,
		const char *	privateKey = NULL
	)			[inline]

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().

Referenced by pr_loadcertfile().

int pr_loadcertfile	(	gxHANDLE	handle,
		const char *	certificate,
		const char *	privateKey = NULL
	)			[inline]

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 pr_loadcertfilea().

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

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().

Referenced by PassportReader::LoadCertFromStore().

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

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().

Referenced by pr_loadcertfromstore().

int pr_loadcertfromstore	(	gxHANDLE	handle,
		const char *	storename
	)			[inline]

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 pr_loadcertfromstorea().

int pr_loadcertfrommem	(	gxHANDLE	handle,
		void *	certificate_data,
		unsigned int	certificate_length,
		void *	privateKey_data = NULL,
		unsigned int	privateKey_length = 0
	)			[inline]

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().

Referenced by PassportReader::LoadCertFileFromMem().

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

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().

Referenced by PassportReader::ClearCertList().

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

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().

Referenced by PassportReader::ConnectRfidCard().

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

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().

Referenced by pr_connectrfidcard().

int pr_connectrfidcard	(	gxHANDLE	handle,
		const char *	card
	)			[inline]

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 pr_connectrfidcarda().

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

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().

Referenced by PassportReader::DisconnectRfidCard().

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

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().

Referenced by pr_disconnectrfidcard().

int pr_disconnectrfidcard	(	gxHANDLE	handle,
		const char *	card
	)			[inline]

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 pr_disconnectrfidcarda().

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

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().

Referenced by PassportReader::CheckRfidFileHash().

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

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().

Referenced by pr_checkrfidfilehash().

int pr_checkrfidfilehash	(	gxHANDLE	handle,
		const char *	card,
		int	fileid
	)			[inline]

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 pr_checkrfidfilehasha().

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

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().

Referenced by PassportReader::GetRfidCardInfo().

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

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().

Referenced by pr_getrfidcardinfo().

int pr_getrfidcardinfo	(	gxHANDLE	handle,
		const char *	card,
		gxVARIANT *	cardinfo
	)			[inline]

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 pr_getrfidcardinfoa().

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

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().

Referenced by PassportReader::GetCertificateId().

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

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().

Referenced by pr_getcertificateid().

int pr_getcertificateid	(	gxHANDLE	handle,
		const char *	card,
		int	Authentication,
		gxVARIANT *	CertificateId
	)			[inline]

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 pr_getcertificateida().

int pr_getnextauthentication	(	gxHANDLE	handle,
		const wchar_t *	card,
		int *	Authentication,
		int	ForceNext = false
	)			[inline]

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().

Referenced by PassportReader::GetNextAuthentication().

int pr_getnextauthenticationa	(	gxHANDLE	handle,
		const char *	card,
		int *	Authentication,
		int	ForceNext = false
	)			[inline]

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().

Referenced by pr_getnextauthentication().

int pr_getnextauthentication	(	gxHANDLE	handle,
		const char *	card,
		int *	Authentication,
		int	ForceNext = false
	)			[inline]

Gets information about the next suggested authentication process (ASCII 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 pr_getnextauthenticationa().

int pr_doauthentication	(	gxHANDLE	handle,
		const wchar_t *	card,
		int	Authentication,
		const wchar_t **	AuthData = 0,
		int	Lines = 0,
		int	PasswordType = PR_PACE_PW_MRZ
	)			[inline]

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().

Referenced by PassportReader::DoAuthentication().

int pr_doauthenticationa	(	gxHANDLE	handle,
		const char *	card,
		int	Authentication,
		const char **	AuthData = 0,
		int	Lines = 0,
		int	PasswordType = PR_PACE_PW_MRZ
	)			[inline]

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().

Referenced by PassportReader::DoAuthentication(), and pr_doauthentication().

int pr_doauthentication	(	gxHANDLE	handle,
		const char *	card,
		int	Authentication,
		const char **	AuthData = 0,
		int	Lines = 0,
		int	PasswordType = PR_PACE_PW_MRZ
	)			[inline]

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 pr_doauthenticationa().