Skip to main content
This object represents the data extracted from a machine-readable zone (MRZ). It also provides the methods for exporting it to a file and getting information about each MRZ component.

Properties

NameTypeDescription
ApplicationEngine, read-onlyReturns the Engine object.
ChecksumBSTRSpecifies the checksum of the MRZ. <Note> This property makes sense only if the HasChecksum property is TRUE. If the HasChecksum property is FALSE, an error will be returned. </Note>
FieldsCountint, read-onlyReturns the number of fields in MRZ.
HasChecksumVARIANT\_BOOL, read-onlyReturns TRUE if MRZ has a checksum.
IsChecksumVerifiedVARIANT\_BOOL, read-onlyReturns TRUE if the checksum is verified. <Note> This property makes sense only if the HasChecksum property is TRUE. If the HasChecksum property is FALSE, an error will be returned. </Note>
LinesCountint, read-onlyReturns the number of lines in MRZ.

Methods

NameDescription
ExportToFileExports the extracted data to an XML or JSON file with the default parameters.
ExportToFileExExports the extracted data to an XML or JSON file with the user-defined parameters.
GetFieldReturns a field by its index.
GetFieldByTypeReturns a field by its type.
GetLineReturns a line by its index.
MrzData Object Diagram

Output parameter

This object is the output parameter of the ExtractMrz method of the FRPage object.

Samples

The object is used in the MRZExtraction code sample for Linux and Windows.

See also

Machine-Readable Zone Capture
Working with Properties