StringDict.get Method¶

Definition¶

Gets an item of the StringDict object.

Python

get(self, key: str) -> str

Parameters

key str

in Unique key of the item to get.

Returns

str

item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

String get(String? key)

Parameters

key String

in Unique key of the item to get.

Returns

String

item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

public string Get(string key)

Parameters

key string

in Unique key of the item to get.

Returns

string

item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public String get(String key) throws DocumentException

Parameters

key String

in Unique key of the item to get.

Returns

String

item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public func get(key: String) throws -> String

Parameters

key String

in Unique key of the item to get.

Returns

String

item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

int id3DocumentStringDict_Get (
    ID3_DOCUMENT_STRING_DICT hStringDict,
    const char * key,
    char * item,
    int * itemSize)

Parameters

hStringDict ID3_DOCUMENT_STRING_DICT

in Handle to the StringDict object.

key const char *

in Unique key 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.