MrzHelper.decode Method

Module: MrzHelper

Definition

Decodes an MRZ of a given type and returns the values of the various fields.

@staticmethod
decode(text: str, type: MrzType) -> StringDict

Parameters

text str
in The input MRZ.

type MrzType
in The input MRZ type according to ICAO-9303 standard.

Returns

A dictionary containing the fields and values decoded in the MRZ.

Exceptions

An error has occurred during Document Library execution.
static StringDict decode(String? text, MrzType type)

Parameters

text String
in The input MRZ.

type MrzType
in The input MRZ type according to ICAO-9303 standard.

Returns

A dictionary containing the fields and values decoded in the MRZ.

Exceptions

An error has occurred during Document Library execution.
public static StringDict Decode(string text, MrzType type)

Parameters

text string
in The input MRZ.

type MrzType
in The input MRZ type according to ICAO-9303 standard.

Returns

A dictionary containing the fields and values decoded in the MRZ.

Exceptions

An error has occurred during Document Library execution.
public static StringDict decode(String text, MrzType type) throws DocumentException

Parameters

text String
in The input MRZ.

type MrzType
in The input MRZ type according to ICAO-9303 standard.

Returns

A dictionary containing the fields and values decoded in the MRZ.

Exceptions

An error has occurred during Document Library execution.
public static func decode(text: String, type: MrzType) throws -> StringDict

Parameters

text String
in The input MRZ.

type MrzType
in The input MRZ type according to ICAO-9303 standard.

Returns

A dictionary containing the fields and values decoded in the MRZ.

Exceptions

An error has occurred during Document Library execution.
int id3DocumentMrzHelper_Decode (
    const char * text,
    id3DocumentMrzType eType,
    ID3_DOCUMENT_STRING_DICT hFields)

Parameters

text const char *
in The input MRZ.

in The input MRZ type according to ICAO-9303 standard.

out A dictionary containing the fields and values decoded in the MRZ.

Returns

int
An error code.
See id3DocumentError file for the list of possible error codes.