StringArray.get Method¶

Definition¶

Gets an item of the StringArray object.

Python

get(self, index: int) -> str

Parameters

index int

in Index of the item to get.

Returns

str

item to get.

Exceptions

BiosealException

An error has occurred during Bioseal Library execution.

Dart

String get(int index)

Parameters

index int

in Index of the item to get.

Returns

String

item to get.

Exceptions

BiosealException

An error has occurred during Bioseal Library execution.

public string Get(int index)

Parameters

index int

in Index of the item to get.

Returns

string

item to get.

Exceptions

BiosealException

An error has occurred during Bioseal Library execution.

Java

public String get(int index) throws BiosealException

Parameters

index int

in Index of the item to get.

Returns

String

item to get.

Exceptions

BiosealException

An error has occurred during Bioseal 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

BiosealException

An error has occurred during Bioseal Library execution.

int id3BiosealStringArray_Get (
    ID3_BIOSEAL_STRING_ARRAY hStringArray,
    int index,
    char * item,
    int * itemSize)

Parameters

hStringArray ID3_BIOSEAL_STRING_ARRAY

in Handle to the StringArray 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 id3BiosealError file for the list of possible error codes.