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

# FaceCandidateList.get Method

Module: FaceCandidateList

## Definition

Gets an item of the FaceCandidateList object.

Python

    get(self, index: int) -> FaceCandidate

Parameters

> `index` int
> in Index of the FaceCandidate item to get.

Returns

> FaceCandidate
> FaceCandidate item to get.

Exceptions

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

Dart

    FaceCandidate get(int index)

Parameters

> `index` int
> in Index of the FaceCandidate item to get.

Returns

> FaceCandidate
> FaceCandidate item to get.

Exceptions

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

C#

    public FaceCandidate Get(int index)

Parameters

> `index` int
> in Index of the FaceCandidate item to get.

Returns

> FaceCandidate
> FaceCandidate item to get.

Exceptions

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

Java

    public FaceCandidate get(int index) throws FaceException

Parameters

> `index` int
> in Index of the FaceCandidate item to get.

Returns

> FaceCandidate
> FaceCandidate item to get.

Exceptions

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

Swift

    public func get(index: Int32) throws -> FaceCandidate

Parameters

> `index` Int32
> in Index of the FaceCandidate item to get.

Returns

> FaceCandidate
> FaceCandidate item to get.

Exceptions

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

C

    int id3FaceCandidateList_Get (
        ID3_FACE_CANDIDATE_LIST hFaceCandidateList,
        int index,
        ID3_FACE_CANDIDATE hFaceCandidateItem)

Parameters

> `hFaceCandidateList` ID3_FACE_CANDIDATE_LIST
> in Handle to the FaceCandidateList object.
> `index` int
> in Index of the FaceCandidate item to get.
> `hFaceCandidateItem` ID3_FACE_CANDIDATE
> out FaceCandidate item to get.

Returns

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