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

# DocumentInfo.description Property

Module: DocumentInfo

Type: string

## Definition

The document description.

Python

    description: str

Exceptions

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

Dart

    String get description => getDescription();

Exceptions

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

C#

    public string description
    {
        get => Getdescription();
    }

Exceptions

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

Java

    public String getDescription() throws DocumentException

Exceptions

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

Swift

    public var description: String
        get {
            return try! getDescription()
        }
    }

Exceptions

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

C

    int id3DocumentInfo_GetDescription (ID3_DOCUMENT_INFO hDocumentInfo, char * description, int * descriptionSize)

Returns

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