StringList.get Method¶

Definition¶

Gets an item of the StringList object.

Python

get(self, index: int) -> str

Parameters

index int

in Index of the item to get.

Returns

str

item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

String get(int index)

Parameters

index int

in Index of the item to get.

Returns

String

item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

public string Get(int index)

Parameters

index int

in Index of the item to get.

Returns

string

item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public String get(int index) throws DocumentException

Parameters

index int

in Index of the item to get.

Returns

String

item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public func get(index: Int32) throws -> String

Parameters

index Int32

in Index of the item to get.

Returns

String

item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

int id3DocumentStringList_Get (
    ID3_DOCUMENT_STRING_LIST hStringList,
    int index,
    char * item,
    int * itemSize)

Parameters

hStringList ID3_DOCUMENT_STRING_LIST

in Handle to the StringList object.

index int

in Index of the item to get.

item char *

out item to get.

itemSize int *

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

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.