Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# DocumentInfo.format Property

Module: DocumentInfo

Type: DocumentFormat

## Definition

The document format.

Python

    format: DocumentFormat

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Dart

    DocumentFormat get format => getFormat();

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C#

    public DocumentFormat format
    {
        get => Getformat();
    }

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Java

    public DocumentFormat getFormat() throws DocumentException

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Swift

    public var format: DocumentFormat
        get {
            return try! getFormat()
        }
    }

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C

    int id3DocumentInfo_GetFormat (ID3_DOCUMENT_INFO hDocumentInfo, id3DocumentFormat * eFormat)

Returns

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