DocumentLibrary.getVersion Method

Module: DocumentLibrary

Definition

Retrieves the library version as a ‘X.Y.Z’ formatted string.

Python

@staticmethod
get_version() -> str

Returns

str

A string that identifies the library version.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

static String getVersion()

Returns

String

A string that identifies the library version.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public static string GetVersion()

Returns

string

A string that identifies the library version.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public static String getVersion() throws DocumentException

Returns

String

A string that identifies the library version.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public static func getVersion() throws -> String

Returns

String

A string that identifies the library version.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentLibrary_GetVersion (
    char * libraryVersion,
    int * libraryVersionSize)

Parameters

libraryVersion char *

out A string that identifies the library version.

libraryVersionSize int *

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

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.