StringDict.remove Method

Module: StringDict

Definition

Removes an element of the StringDict object.

Python

remove(self, key: str) -> None

Parameters

key str

in Unique key of the item to remove.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

void remove(String? key)

Parameters

key String

in Unique key of the item to remove.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public void Remove(string key)

Parameters

key string

in Unique key of the item to remove.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public void remove(String key) throws DocumentException

Parameters

key String

in Unique key of the item to remove.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public func remove(key: String) throws

Parameters

key String

in Unique key of the item to remove.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentStringDict_Remove (
    ID3_DOCUMENT_STRING_DICT hStringDict,
    const char * key)

Parameters

hStringDict ID3_DOCUMENT_STRING_DICT

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.