DocumentInfoDictionary.get Method

Module: DocumentInfoDictionary

Definition

Gets an item of the DocumentInfoDictionary object.

Python

get(self, key: str) -> DocumentInfo

Parameters

key str

in Unique key of the DocumentInfo item to get.

Returns

DocumentInfo

DocumentInfo item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

DocumentInfo get(String? key)

Parameters

key String

in Unique key of the DocumentInfo item to get.

Returns

DocumentInfo

DocumentInfo item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public DocumentInfo Get(string key)

Parameters

key string

in Unique key of the DocumentInfo item to get.

Returns

DocumentInfo

DocumentInfo item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public DocumentInfo get(String key) throws DocumentException

Parameters

key String

in Unique key of the DocumentInfo item to get.

Returns

DocumentInfo

DocumentInfo item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public func get(key: String) throws -> DocumentInfo

Parameters

key String

in Unique key of the DocumentInfo item to get.

Returns

DocumentInfo

DocumentInfo item to get.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentInfoDictionary_Get (
    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 get.

hDocumentInfoItem ID3_DOCUMENT_INFO

out DocumentInfo item to get.

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.