Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# ImageDict.remove Method

Module: ImageDict

## Definition

Removes an element of the ImageDict object.

Python

    remove(self, key: str) -> None

Parameters

> `key` str
> in Unique key of the Image item to remove.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Dart

    void remove(String? key)

Parameters

> `key` String
> in Unique key of the Image item to remove.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C#

    public void Remove(string key)

Parameters

> `key` string
> in Unique key of the Image item to remove.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Java

    public void remove(String key) throws FaceException

Parameters

> `key` String
> in Unique key of the Image item to remove.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Swift

    public func remove(key: String) throws

Parameters

> `key` String
> in Unique key of the Image item to remove.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C

    int id3FaceImageDict_Remove (
        ID3_FACE_IMAGE_DICT hImageDict,
        const char * key)

Parameters

> `hImageDict` ID3_FACE_IMAGE_DICT
> in Handle to the ImageDict object.
> `key` const char *
> in Unique key of the Image item to remove.

Returns

> `int`
> An error code.
> See id3FaceError file for the list of possible error codes.