DocumentInfoDictionary.add Method

Module: DocumentInfoDictionary

Definition

Adds an item to the DocumentInfoDictionary object.

Python

add(self, key: str, document_info_item: DocumentInfo) -> None

Parameters

key str

in Unique key of the DocumentInfo item to add.

document_info_item DocumentInfo

in DocumentInfo item to add.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

void add(String? key, DocumentInfo documentInfoItem)

Parameters

key String

in Unique key of the DocumentInfo item to add.

documentInfoItem DocumentInfo

in DocumentInfo item to add.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public void Add(string key, DocumentInfo documentInfoItem)

Parameters

key string

in Unique key of the DocumentInfo item to add.

documentInfoItem DocumentInfo

in DocumentInfo item to add.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public void add(String key, DocumentInfo documentInfoItem) throws DocumentException

Parameters

key String

in Unique key of the DocumentInfo item to add.

documentInfoItem DocumentInfo

in DocumentInfo item to add.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public func add(key: String, documentInfoItem: DocumentInfo) throws

Parameters

key String

in Unique key of the DocumentInfo item to add.

documentInfoItem DocumentInfo

in DocumentInfo item to add.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentInfoDictionary_Add (
    ID3_DOCUMENT_INFO_DICTIONARY hDocumentInfoDictionary,
    const char * key,
    ID3_DOCUMENT_INFO hDocumentInfoItem)

Parameters

hDocumentInfoDictionary ID3_DOCUMENT_INFO_DICTIONARY

in Handle to the DocumentInfoDictionary object.

key const char *

in Unique key of the DocumentInfo item to add.

hDocumentInfoItem ID3_DOCUMENT_INFO

in DocumentInfo item to add.

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.