DocumentInfo Class

Namespace: id3.Document

Definition

Represents document information.
class DocumentInfo
class DocumentInfo implements Finalizable
public partial class DocumentInfo
public class DocumentInfo implements AutoCloseable, Serializable
public class DocumentInfo
typedef struct id3DocumentInfo *ID3_DOCUMENT_INFO;

Usage

documentInfoInstance = id3document.DocumentInfo()

Explicit destruction

# ...
del documentInfoInstance
final documentInfoInstance = sdk.DocumentInfo();
// ...

Explicit destruction

// ...
documentInfoInstance.dispose()
using (var documentInfoInstance = new DocumentInfo())
{
   // ...
}

Explicit destruction

var documentInfoInstance = new DocumentInfo()
// ...
documentInfoInstance.Dispose()
try (DocumentInfo documentInfoInstance = new DocumentInfo()) {
// ...
}

Explicit destruction

DocumentInfo documentInfoInstance = new DocumentInfo();
// ...
documentInfoInstance.close();
private var documentInfoInstance: DocumentInfo? = nil
documentInfoInstance = try DocumentInfo()
ID3_DOCUMENT_INFO hDocumentInfo{};
int err = id3DocumentInfo_Initialize(&hDocumentInfo);
if (err == ID3_SUCCESS) {
    // ...
    id3DocumentInfo_Dispose(&hDocumentInfo);
}

Properties

Name

Type

Description

category

DocumentCategory

The document category.

country

string

The ISO 3166-1 alpha-3 code identifying the country issuing the document.

date

string

The document’s date of first issue, in the form YYYY-MM-DD.

description

string

The document description.

format

DocumentFormat

The document format.

identifier

string

The document identifier.

mrzType

MrzType

The type of machine-readable zone (MRZ), if applicable.

name

string

The document type name.

pageNumber

int

The page number of the document.

Methods

Name

Description

clone

Clones the DocumentInfo object.