PrApi

PrApi


The PR Api Control is a dedicated ActiveX control for controlling the document capture devices and for managing document recognition.

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:

  • Views: Original, Document, Preview, Available
  • Lights: White, Infra, UV, Coaxial, Kinegram, Photo, CleanOVD, CleanUV
  • in case of preview the window id of the object window, and
  • the page number in other cases

    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.

    Class Diagram

    PrApi

    Public:

    Methods:

    NameDescription
     BlinkStatusBlinks status outputs (led or buzzer).  
     CalibrateCalibrates the object window of the opened device.  
     CaptureCaptures an image sequence from the object window of the PR device.  
     CaptureStartStarts the image capturing process in asynchronous mode.  
     CaptureStatusReturns the state of an image capture process started with the CaptureStart() method.  
     CaptureWaitEnds the capture process started with the CaptureStart() method.  
     CheckRfidFileHashChecks the hash of the file read from the RFID card.  
     ClearCertListClears the internal certificate list.  
     CloseDeviceCloses a previously opened device.  
     CompareFaceCompares a captured face photo with one that is stored in rfid chip.  
     CompleteTerminalAuthCompletes the Terminal Authentication for the RFID chip.  
     ConnectRfidCardConnects to the RFID card.  
     ConvertRfFileIdConverts rfid file ids between general id and data group number form.  
     DecodeLatentImageDecodes a latent image from a stored image.  
     DisconnectRfidCardDisconnects from the RFID card.  
     DoAuthenticationMaking authentication process.  
     FingerCapture[Obsolete] Scan fingers from captured images.  
     FingerCaptureStart[Obsolete] Starts the finger image capturing process in asynchronous mode.  
     FingerToNistSaves the fingers to an nist file.  
     FingerToNistVSaves the fingers to a memory area as a nist file.  
     GetApplicationsGet applications supported by the card.  
     GetAuthResultReturns the rfid authentication results in document form.  
     GetBarcodeReads the barcode from an unknown document.  
     GetCertificateIdReturns the certificate identifier for the given authentication.  
     GetDeviceReturns the name of a device in the device list.  
     GetDeviceInfoReturns the information about the opened device.  
     GetDeviceListCreates a list of the available Passport Reader devices.  
     GetDocumentRectReturns the quad of the document.  
     GetDocumentRootReturns the root document of the PR system.  
     GetEngineInfoReturns information about the used engine.  
     GetEnhancedUVGet enhanced UV.  
     GetError[Obsolete] Returns the error code and string of the control.  
     GetErrorCodeReturns the error code of the control.  
     GetErrorStringReturns the error string of the control.  
     GetImageSourceReturns a binary value representing the control's class as an image source.  
     GetIntPropertyGets the integer value of a property of the prapi module.  
     GetLicenseDateReturns the engine acceptance date of a license.  
     GetLicensesReturns a list of available licenses.  
     GetLightMaskReturns a light mask for a given light and window.  
     GetMrzReads the MRZ from an unknown document.  
     GetNextAuthenticationReturns the next suggested authentication process.  
     GetOcrReads the OCR from an unknown document.  
     GetOcrVReads the OCR from an unknown document.  
     GetPropertyGets the text value of a property of the prapi module.  
     GetRfidCardReturns the ID of an RFID card in the card list.  
     GetRfidCardIdReturns the ID of the RFID card.  
     GetRfidCardInfoReturns information about the rfid card.  
     GetRfidCardListReturns the number of the available RFID cards.  
     GetRfidFileReads files from the RFID card and processes automatically.  
     GetRfidFileBReads files from the RFID card.  
     GetRfidFileListGets a list of available rfid files.  
     GetRfidFileVReads files from the RFID card.  
     GetSourceHandleReturns a binary value representing the control's object as a source handle.  
     GetStringPropertyGets the text value of a property of the prapi module.  
     InitTerminalAuthInitiates the Terminal Authentication of the RFID chip.  
     IsCalibratedTests the calibrated state of the device.  
     LightListItemReturns the id of the light specified by the index.  
     LoadCertFileLoads the certificate file.  
     LoadCertFileFromMemLoads the certificate file from memory.  
     LoadCertFromStoreLoads certificates and CRLs from a store.  
     LoadCVCertFile[Obsolete] Loads the CV certificate file.  
     LoadDocumentLoads a document from the mass storage device.  
     LoadPrivKeyFile[Obsolete] Loads the private key file.  
     MakeActiveAuthMakes the Active Authentication of the RFID chip.  
     MakeBACSwitches to secure messaging by making Basic Access Control.  
     MakeBACASwitches to secure messaging by making Basic Access Control.  
     MakeChipAuthMakes the Chip Authentication of the RFID chip.  
     MakePACESwitches to secure messaging by making Password Authenticated Connection Establishment.  
     MakePACEASwitches to secure messaging by making Password Authenticated Connection Establishment.  
     MakePassiveAuthMakes the Passive Authentication of the RFID chip.  
     MakeTerminalAuthMakes the Terminal Authentication of the RFID chip.  
     ReadMagstripeReads data from a magnetic stripe device.  
     ReadUDataReads the user data from the device.  
     RecognizeReads all of the data from a known document type.  
     ResetDocumentClears the internal structure of the control.  
     ResetFingerList[Obsolete] Clears the internal finger image structures of the control.  
     ResolveMagstripeSeparates the data fields in the given magnetic stripe tracks.  
     ResolveMrzASeparates the data fields in the given MRZ text.  
     ResolveMrzTextSeparates the data fields in the given MRZ text.  
     ResolveRfidDataProcesses RFID data previously read with the GetRfidFileB() method.  
     SelectApplicationSelect the chip application.  
     SelfTestPerforms device self test.  
     SetIntPropertySets the integer value of a property of the prapi module.  
     SetPageLightSets the number of document pages to capture and the needed lights for each page.  
     SetPageLightVSets the number of document pages to capture and the needed lights for each page.  
     SetPropertySets the text value of a property of the prapi module.  
     SetStatusLedTurns on/off the status leds.  
     SuspendSuspends the Passport Reader system.  
     TestButtonGets the devices button state.  
     TestDocumentReturns the document state.  
     UseDeviceOpens a PR device.  
     UseDeviceNOpens a PR device.  
     WakeUpWakes up the previously suspended Passport Reader system.  
     WriteUDataWrites the user data to the opened device.  

    Events:

    NameDescription
     ButtonEventOccurs when a button is pressed or released on the device.  
     ConnectionEventOccurs when a device is connected/disconnected.  
     PowerEventOccurs when the power state or the power level is changed.  
     PREventGeneral PR event.  
     PreviewEventOccurs when a preview image is captured.  
     TestDocEventOccurs when the state of the document has changed.  

    Private:

    Properties:

    NameDescription
     CaptureOnMotDetEnables the automatic image capture on motion detection event.  
     EventTypesBitmask for specifying the event types that invoke the PREvent event.  
     FreerunModeRepresents the light and camera control modes between two capture processes.  
     Lights[Read only] The number of the usable lights of the used device.  
     ObjectWindows[Read only] The number of object windows of the device.  
     PowerLevel[Read only] The power level of devices capable of working without external power supply.  
     PowerState[Read only] The power state of the device.  
     PreviewLightThe preview light for preview capture.  
     RuntimeConfigRuntime configuration of the ActiveX component.  
     UDBlockSize[Read only] The block size of the user data space of the device.  
     UDNumberOfBlocks[Read only] The number of blocks available in the user data space of the device.  
     Version[Read only] The version of the PrApi ActiveX control.  
    History