MrzData Object (IMrzData interface)

MrzData object (IMrzData interface) in the ABBYY FineReader Engine API — Represents data extracted from a machine-readable zone (MRZ); exposes checksum, export methods, and accessors for fields and lines.

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

Name	Type	Description
Application	Engine, read-only	Returns the Engine object.
Checksum	BSTR	Specifies 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.
FieldsCount	int, read-only	Returns the number of fields in MRZ.
HasChecksum	VARIANT_BOOL, read-only	Returns TRUE if MRZ has a checksum.
IsChecksumVerified	VARIANT_BOOL, read-only	Returns 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.
LinesCount	int, read-only	Returns the number of lines in MRZ.

Methods

Name	Description
ExportToFile	Exports the extracted data to an XML or JSON file with the default parameters.
ExportToFileEx	Exports the extracted data to an XML or JSON file with the user-defined parameters.
GetField	Returns a field by its index.
GetFieldByType	Returns a field by its type.
GetLine	Returns a line by its index.

Related objects

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