Bioseal.getDocumentDescription Method

Module: Bioseal

Definition

Gets the description of the document.

Python

get_document_description(self, language: str) -> str

Parameters

language str

in The expected language.

Returns

str

The description of the document.

Exceptions

BiosealException

An error has occurred during Bioseal Library execution.

Dart

String? getDocumentDescription(String? language)

Parameters

language String

in The expected language.

Returns

String

The description of the document.

Exceptions

BiosealException

An error has occurred during Bioseal Library execution.

C#

public string GetDocumentDescription(string language)

Parameters

language string

in The expected language.

Returns

string

The description of the document.

Exceptions

BiosealException

An error has occurred during Bioseal Library execution.

Java

public String getDocumentDescription(String language) throws BiosealException

Parameters

language String

in The expected language.

Returns

String

The description of the document.

Exceptions

BiosealException

An error has occurred during Bioseal Library execution.

Swift

public func getDocumentDescription(language: String) throws -> String

Parameters

language String

in The expected language.

Returns

String

The description of the document.

Exceptions

BiosealException

An error has occurred during Bioseal Library execution.

C

int id3Bioseal_GetDocumentDescription (
    ID3_BIOSEAL hBioseal,
    const char * language,
    char * documentDescription,
    int * documentDescriptionSize)

Parameters

hBioseal ID3_BIOSEAL

in Handle to the Bioseal object.

language const char *

in The expected language.

documentDescription char *

out The description of the document.

documentDescriptionSize int *

in Size of the ‘documentDescription’ buffer. Receives the minimum required buffer size to hold the ‘documentDescription’ string if the given one is too small (including the terminating NULL character), otherwise receives the number of characters in ‘documentDescription’ (excluding terminating NULL character).

Returns

int

An error code.

See id3BiosealError file for the list of possible error codes.