DocumentInfoDictionary.set Method

Module: DocumentInfoDictionary

Definition

Sets an item of the DocumentInfoDictionary object.

Python

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

Parameters

key str

in Unique key of the DocumentInfo item to set.

document_info_item DocumentInfo

in DocumentInfo item to set.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

void set(String? key, DocumentInfo documentInfoItem)

Parameters

key String

in Unique key of the DocumentInfo item to set.

documentInfoItem DocumentInfo

in DocumentInfo item to set.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public void Set(string key, DocumentInfo documentInfoItem)

Parameters

key string

in Unique key of the DocumentInfo item to set.

documentInfoItem DocumentInfo

in DocumentInfo item to set.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

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

Parameters

key String

in Unique key of the DocumentInfo item to set.

documentInfoItem DocumentInfo

in DocumentInfo item to set.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

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

Parameters

key String

in Unique key of the DocumentInfo item to set.

documentInfoItem DocumentInfo

in DocumentInfo item to set.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentInfoDictionary_Set (
    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 set.

hDocumentInfoItem ID3_DOCUMENT_INFO

in DocumentInfo item to set.

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.