WinBioEnrollSelect 関数 (winbio.h)

複数の個人を表すデータがサンプルバッファーに存在する場合に登録する個人を指定します。 Windows 10 ビルド 1607 以降では、この関数はモバイルイメージで使用できます。

構文

HRESULT WinBioEnrollSelect(
  [in] WINBIO_SESSION_HANDLE SessionHandle,
  [in] ULONGLONG             SelectorValue
);

パラメーター

[in] SessionHandle

開いている生体認証セッションを識別する WINBIO_SESSION_HANDLE 値。 WinBioOpenSession を呼び出して同期セッションハンドルを開きます。 WinBioAsyncOpenSession を呼び出して非同期セッションハンドルを開きます。

顔認識に登録するには、PoolType パラメーターを WINBIO_POOL_SYSTEM に設定した WinBioAsyncOpenSession を使用してハンドルを取得します。

[in] SelectorValue

登録用に選択する個人を識別する値。

戻り値

関数が成功すると、S_OKが返されます。関数が失敗した場合は、エラーを示す HRESULT 値を返します。使用できる値には、次の表に示す値が含まれますが、これらに限定されません。一般的なエラーコードの一覧については、「共通 HRESULT 値」を参照してください。

リターンコード	Description
E_HANDLE	セッションハンドルが無効です。
E_INVALIDARG	SelectorValue パラメーターは 0 に等しいことはできません。
WINBIO_E_INCORRECT_SESSION_TYPE	セッションハンドルは生体認証セッションに対応していません。

注釈

顔認識に登録する場合は、次の 2 つの方法のいずれかで正しいセレクター値を見つけることができます。

以前に送信されたWINBIO_PRESENCE構造体の Id メンバーの値。
NUI 顔追跡 API によって生成されるデータ。

WinBioEnrollBegin を呼び出して登録シーケンスを開始した後、WinBioEnrollSelect を呼び出してセレクター値を設定します。セレクター値は、後続のすべての WinBioEnrollCapture 呼び出しに適用されます。選択設定は一時的であり、 WinBioEnrollCommit または WinBioEnrollDiscard を呼び出して登録シーケンスを完了すると自動的にクリアされます。

指紋などのあいまいさを必要としない生体認証要素に 対して WinBioEnrollSelect を呼び出すと、関数の戻り値は成功を示しますが、関数はセレクター値を無視します。

関数を呼び出す必要がある生体認証要素に 対して WinBioEnrollSelect を呼び出さない場合、後続の WinBioEnrollCapture の呼び出しは 、WINBIO_E_SELECTION_REQUIRED エラーで失敗します。

Windows 10 の場合、 WinBioEnrollSelect を呼び出すために必要な要因は、顔の特徴と虹彩です。

WinBioEnrollSelect は、同期または非同期のセッションハンドルを使用して呼び出すことができます。 Windows 生体認証フレームワーク API 関数の他の呼び出しと同様に、非同期セッションハンドルを使用して WinBioEnrollSelect を 呼び出すと、戻り値は関数パラメーターが許容されたことを示すだけです。操作自体の実際の成功または失敗は、 WINBIO_ASYNC_RESULT 構造体の通知ルーチンに返されます。

Requirements

Requirement	価値
サポートされる最小クライアント	Windows 10 [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2016 [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
Header	winbio.h
Library	Winbio.lib
DLL	Winbio.dll