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

# FaceCandidateList Class

Namespace: id3.Face

## Definition

Represents a candidate list in a one-to-many search.
Python

    class FaceCandidateList

Dart

    class FaceCandidateList implements Finalizable

C#

    public partial class FaceCandidateList

Java

    public class FaceCandidateList implements AutoCloseable, Serializable

Swift

    public class FaceCandidateList

C

    typedef struct id3FaceCandidateList *ID3_FACE_CANDIDATE_LIST;

## Usage

Python

    faceCandidateListInstance = id3face.FaceCandidateList()

Explicit destruction

    # ...
    del faceCandidateListInstance

Dart

    final faceCandidateListInstance = sdk.FaceCandidateList();
    // ...

Explicit destruction

    // ...
    faceCandidateListInstance.dispose()

C#

    using (var faceCandidateListInstance = new FaceCandidateList())
    {
       // ...
    }

Explicit destruction

    var faceCandidateListInstance = new FaceCandidateList()
    // ...
    faceCandidateListInstance.Dispose()

Java

    try (FaceCandidateList faceCandidateListInstance = new FaceCandidateList()) {
    // ...
    }

Explicit destruction

    FaceCandidateList faceCandidateListInstance = new FaceCandidateList();
    // ...
    faceCandidateListInstance.close();

Swift

    private var faceCandidateListInstance: FaceCandidateList? = nil
    faceCandidateListInstance = try FaceCandidateList()

C

    ID3_FACE_CANDIDATE_LIST hFaceCandidateList{};
    int err = id3FaceCandidateList_Initialize(&hFaceCandidateList);
    if (err == ID3_SUCCESS) {
        // ...
        id3FaceCandidateList_Dispose(&hFaceCandidateList);
    }

## Properties

Name | Type | Description
--- | --- | ---
count | int | Gets the number of elements contained in the list
operator [int index] | FaceCandidate | Gets or sets the element at the specified index in the list.

## Iteration

This class supports iteration in Dart, C#, Java and Python.

## Methods

Name | Description
--- | ---
add | Adds an item to the FaceCandidateList object.
clear | Clears the FaceCandidateList object.
clone | Clones the FaceCandidateList object.
get | Gets an item of the FaceCandidateList object.
getCount | Gets the number of elements in the FaceCandidateList object.
removeAt | Removes an element of the FaceCandidateList object.
resize | FaceCandidateList object.
set | Sets an item of the FaceCandidateList object.