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

# DocumentAuthenticator.documentName Property

Module: DocumentAuthenticator

Type: string

## Definition

Document type to authenticate.

Python

    document_name: str

Exceptions

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

Dart

    String get documentName => getDocumentName();
    set documentName(String value) => setDocumentName(value);

Exceptions

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

C#

    public string documentName
    {
        get => GetdocumentName();
        set => SetdocumentName(ref value);
    }

Exceptions

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

Java

    public String getDocumentName() throws DocumentException
    public void setDocumentName(String documentName) throws DocumentException

Exceptions

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

Swift

    public var documentName: String
        get {
            return try! getDocumentName()
        }
    }

Exceptions

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

C

    int id3DocumentAuthenticator_GetDocumentName (ID3_DOCUMENT_AUTHENTICATOR hDocumentAuthenticator, char * documentName, int * documentNameSize)
    int id3DocumentAuthenticator_SetDocumentName (ID3_DOCUMENT_AUTHENTICATOR hDocumentAuthenticator, const char * documentName)

Returns

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