Manifest.getDocumentName Method

Module: Manifest

Definition

Gets the name of the document.

get_document_name(self, language: str) -> str

Parameters

language str
in The expected language.

Returns

str
The name of the document.

Exceptions

BiosealException
An error has occurred during Bioseal Library execution.
String getDocumentName(String? language)

Parameters

language String
in The expected language.

Returns

String
The name of the document.

Exceptions

BiosealException
An error has occurred during Bioseal Library execution.
public string GetDocumentName(string language)

Parameters

language string
in The expected language.

Returns

string
The name of the document.

Exceptions

BiosealException
An error has occurred during Bioseal Library execution.
public String getDocumentName(String language) throws BiosealException

Parameters

language String
in The expected language.

Returns

String
The name of the document.

Exceptions

BiosealException
An error has occurred during Bioseal Library execution.
public func getDocumentName(language: String) throws -> String

Parameters

language String
in The expected language.

Returns

String
The name of the document.

Exceptions

BiosealException
An error has occurred during Bioseal Library execution.
int id3BiosealManifest_GetDocumentName (
    ID3_BIOSEAL_MANIFEST hManifest,
    const char * language,
    char * documentName,
    int * documentNameSize)

Parameters

hManifest ID3_BIOSEAL_MANIFEST
in Handle to the Manifest object.

language const char *
in The expected language.

documentName char *
out The name of the document.

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

Returns

int
An error code.
See id3BiosealError file for the list of possible error codes.