StringDict.remove Method

Module: StringDict

Definition

Removes an element of the StringDict object.

remove(self, key: str) -> None

Parameters

key str
in Unique key of the item to remove.

Exceptions

An error has occurred during Document Library execution.
void remove(String? key)

Parameters

key String
in Unique key of the item to remove.

Exceptions

An error has occurred during Document Library execution.
public void Remove(string key)

Parameters

key string
in Unique key of the item to remove.

Exceptions

An error has occurred during Document Library execution.
public void remove(String key) throws DocumentException

Parameters

key String
in Unique key of the item to remove.

Exceptions

An error has occurred during Document Library execution.
public func remove(key: String) throws

Parameters

key String
in Unique key of the item to remove.

Exceptions

An error has occurred during Document Library execution.
int id3DocumentStringDict_Remove (
    ID3_DOCUMENT_STRING_DICT hStringDict,
    const char * key)

Parameters

in Handle to the StringDict object.

key const char *
in Unique key of the item to remove.

Returns

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