PrApi |
The PR Api Control is a control without display window. To visualize the captured images the best way is to connect a GxImage ActiveX control to the PR Api Control. In this case the PR Api Control operates as an Image source for the GxImage control.
The available values for the GxImage Controls ImageSrcParam property are the folowings:
These values can be feed to the GxImage Control in case insensitive and without order restrictions separated by commas. If any of the values are absent the control chooses the best case.
From version 2.1.0 preliminary support is added for handling multitag RFID documents. The ConnectRfidCard and DisconnectRfidCard functions must be called for proper RFID reading session handling.
From version 2.1.0.1 a new property is available to specify the runtime configuration. By default it is set to 0. If it is set to 1 the ActiveX component is capable of handling the calling convention differences introduced by the JavaScript scripting language. So, in case of using the scripting programming language, for example embedding your application in HTML framework viewed in Internet Explorer, this property must be set to 1.
As it is not possible to call functions having reference parameters in JavaScript language, small compatibility modifications were necessary on the interface. New functions were added as counterpart to the critical functions using reference values as function parameters.
Name | Description |
---|---|
![]() | Blinks status outputs (led or buzzer). |
![]() | Calibrates the object window of the opened device. |
![]() | Captures an image sequence from the object window of the PR device. |
![]() | Starts the image capturing process in asynchronous mode. |
![]() | Returns the state of an image capture process started with the CaptureStart() method. |
![]() | Ends the capture process started with the CaptureStart() method. |
![]() | Checks the hash of the file read from the RFID card. |
![]() | Clears the internal certificate list. |
![]() | Closes a previously opened device. |
![]() | Compares a captured face photo with one that is stored in rfid chip. |
![]() | Completes the Terminal Authentication for the RFID chip. |
![]() | Connects to the RFID card. |
![]() | Converts rfid file ids between general id and data group number form. |
![]() | Decodes a latent image from a stored image. |
![]() | Disconnects from the RFID card. |
![]() | Making authentication process. |
![]() | [Obsolete] Scan fingers from captured images. |
![]() | [Obsolete] Starts the finger image capturing process in asynchronous mode. |
![]() | Saves the fingers to an nist file. |
![]() | Saves the fingers to a memory area as a nist file. |
![]() | Get applications supported by the card. |
![]() | Returns the rfid authentication results in document form. |
![]() | Reads the barcode from an unknown document. |
![]() | Returns the certificate identifier for the given authentication. |
![]() | Returns the name of a device in the device list. |
![]() | Returns the information about the opened device. |
![]() | Creates a list of the available Passport Reader devices. |
![]() | Returns the quad of the document. |
![]() | Returns the root document of the PR system. |
![]() | Returns information about the used engine. |
![]() | Get enhanced UV. |
![]() | [Obsolete] Returns the error code and string of the control. |
![]() | Returns the error code of the control. |
![]() | Returns the error string of the control. |
![]() | Returns a binary value representing the control's class as an image source. |
![]() | Gets the integer value of a property of the prapi module. |
![]() | Returns the engine acceptance date of a license. |
![]() | Returns a list of available licenses. |
![]() | Returns a light mask for a given light and window. |
![]() | Reads the MRZ from an unknown document. |
![]() | Returns the next suggested authentication process. |
![]() | Reads the OCR from an unknown document. |
![]() | Reads the OCR from an unknown document. |
![]() | Gets the text value of a property of the prapi module. |
![]() | Returns the ID of an RFID card in the card list. |
![]() | Returns the ID of the RFID card. |
![]() | Returns information about the rfid card. |
![]() | Returns the number of the available RFID cards. |
![]() | Reads files from the RFID card and processes automatically. |
![]() | Reads files from the RFID card. |
![]() | Gets a list of available rfid files. |
![]() | Reads files from the RFID card. |
![]() | Returns a binary value representing the control's object as a source handle. |
![]() | Gets the text value of a property of the prapi module. |
![]() | Initiates the Terminal Authentication of the RFID chip. |
![]() | Tests the calibrated state of the device. |
![]() | Returns the id of the light specified by the index. |
![]() | Loads the certificate file. |
![]() | Loads the certificate file from memory. |
![]() | Loads certificates and CRLs from a store. |
![]() | [Obsolete] Loads the CV certificate file. |
![]() | Loads a document from the mass storage device. |
![]() | [Obsolete] Loads the private key file. |
![]() | Makes the Active Authentication of the RFID chip. |
![]() | Switches to secure messaging by making Basic Access Control. |
![]() | Switches to secure messaging by making Basic Access Control. |
![]() | Makes the Chip Authentication of the RFID chip. |
![]() | Switches to secure messaging by making Password Authenticated Connection Establishment. |
![]() | Switches to secure messaging by making Password Authenticated Connection Establishment. |
![]() | Makes the Passive Authentication of the RFID chip. |
![]() | Makes the Terminal Authentication of the RFID chip. |
![]() | Reads data from a magnetic stripe device. |
![]() | Reads the user data from the device. |
![]() | Reads all of the data from a known document type. |
![]() | Clears the internal structure of the control. |
![]() | [Obsolete] Clears the internal finger image structures of the control. |
![]() | Separates the data fields in the given magnetic stripe tracks. |
![]() | Separates the data fields in the given MRZ text. |
![]() | Separates the data fields in the given MRZ text. |
![]() | Processes RFID data previously read with the GetRfidFileB() method. |
![]() | Select the chip application. |
![]() | Performs device self test. |
![]() | Sets the integer value of a property of the prapi module. |
![]() | Sets the number of document pages to capture and the needed lights for each page. |
![]() | Sets the number of document pages to capture and the needed lights for each page. |
![]() | Sets the text value of a property of the prapi module. |
![]() | Turns on/off the status leds. |
![]() | Suspends the Passport Reader system. |
![]() | Gets the devices button state. |
![]() | Returns the document state. |
![]() | Opens a PR device. |
![]() | Opens a PR device. |
![]() | Wakes up the previously suspended Passport Reader system. |
![]() | Writes the user data to the opened device. |
Name | Description |
---|---|
![]() | Occurs when a button is pressed or released on the device. |
![]() | Occurs when a device is connected/disconnected. |
![]() | Occurs when the power state or the power level is changed. |
![]() | General PR event. |
![]() | Occurs when a preview image is captured. |
![]() | Occurs when the state of the document has changed. |
Name | Description |
---|---|
![]() | Enables the automatic image capture on motion detection event. |
![]() | Bitmask for specifying the event types that invoke the PREvent event. |
![]() | Represents the light and camera control modes between two capture processes. |
![]() | [Read only] The number of the usable lights of the used device. |
![]() | [Read only] The number of object windows of the device. |
![]() | [Read only] The power level of devices capable of working without external power supply. |
![]() | [Read only] The power state of the device. |
![]() | The preview light for preview capture. |
![]() | Runtime configuration of the ActiveX component. |
![]() | [Read only] The block size of the user data space of the device. |
![]() | [Read only] The number of blocks available in the user data space of the device. |
![]() | [Read only] The version of the PrApi ActiveX control. |