ExportToFileEx Method of the MrzData Object

ExportToFileEx method of the MrzData Object in the ABBYY FineReader Engine API — Exports the extracted MRZ data to a JSON or XML file with user-defined parameters.

This method exports the extracted data to a file in JSON/XML format with the user-defined parameters.

Syntax

C++

HRESULT ExportToFileEx(
  BSTR                 FileName,
  MrzExportFormatEnum  Format,
  IUnknown*            ExportParams
);

C#

void ExportToFileEx(
  string               FileName,
  MrzExportFormatEnum  Format,
  object               ExportParams
);

Visual Basic .NET

Sub ExportToFileEx( _
  FileName As String, _
  Format As MrzExportFormatEnum, _
  ExportParams As Object _
)

Parameters

FileName

[in] This variable contains the full path to the output file in XML/JSON format (see the description of formats in XML Schema for MRZ and JSON file for MRZ). If this file already exists, it is overwritten without prompt.

Format

[in] This variable specifies the format of the output file. See the MrzExportFormatEnum description for the supported file formats.

ExportParams

[in] This variable may refer to a MrzJsonExportParams or MrzXmlExportParams object that defines parameters for saving the data captured from MRZ to JSON or XML format, respectively. This parameter is optional and may be 0, in which case the parameters of export have default values, or, if a profile has been loaded, the parameters set by this profile are used.

In Linux, if you are working with ABBYY FineReader Engine loaded out-of-process, you must pass NULL for this parameter. If you want to pass the export parameters, create a user profile with the desired settings.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

MrzData

Machine-Readable Zone Capture