DocumentInfoDictionary.remove Method

Module: DocumentInfoDictionary

Definition

Removes an element of the DocumentInfoDictionary object.

Python

remove(self, key: str) -> None

Parameters

key str

in Unique key of the DocumentInfo 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 DocumentInfo 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 DocumentInfo 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 DocumentInfo 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 DocumentInfo item to remove.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentInfoDictionary_Remove (
    ID3_DOCUMENT_INFO_DICTIONARY hDocumentInfoDictionary,
    const char * key)

Parameters

hDocumentInfoDictionary ID3_DOCUMENT_INFO_DICTIONARY

in Handle to the DocumentInfoDictionary object.

key const char *

in Unique key of the DocumentInfo item to remove.

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.