WinBioAsyncEnumBiometricUnits 関数 (winbio.h)

  • [アーティクル]

入力要素の種類に一致するすべての添付生体認証ユニットを非同期的に列挙します。 この関数の同期バージョンについては、「 WinBioEnumBiometricUnits」を参照してください。 Windows 10 ビルド 1607 以降では、この関数をモバイル イメージで使用できます。

構文

HRESULT WinBioAsyncEnumBiometricUnits(
  [in] WINBIO_FRAMEWORK_HANDLE FrameworkHandle,
  [in] WINBIO_BIOMETRIC_TYPE   Factor
);

パラメーター

[in] FrameworkHandle

WinBioAsyncOpenFramework を呼び出して開いたフレームワーク セッションを処理します。

[in] Factor

列挙 する 生体認証ユニットの種類を指定するWINBIO_BIOMETRIC_TYPE フラグのビットマスク。 現在、 WINBIO_TYPE_FINGERPRINT のみがサポートされています。

戻り値

関数は、成功または失敗を示す HRESULT を返します。 成功は、引数が有効であることを示すだけであることに注意してください。 操作の実行中に発生したエラーは、WinBioAsyncOpenFramework の呼び出しで指定された通知メソッドを使用して、WINBIO_ASYNC_RESULT構造体に非同期的に返されます。

リターン コード 説明
E_HANDLE
 FrameworkHandle 引数を設定する必要があります。
E_INVALIDARG
 Factor パラメーターに含まれるビットマスクには、無効な型ビットが 1 つ以上含まれています。
E_OUTOFMEMORY
 要求を完了するためのメモリが不足していました。
WINBIO_E_DISABLED
 現在の管理ポリシーでは、Windows 生体認証フレームワーク API の使用は禁止されています。
WINBIO_E_INCORRECT_SESSION_TYPE
 FrameworkHandle 引数は、非同期フレームワーク セッションを表す必要があります。
WINBIO_E_SESSION_HANDLE_CLOSED
 セッション ハンドルがクローズ用にマークされています。

解説

WinBioAsyncEnumBiometricUnits 関数は、WinBioAsyncOpenFramework を呼び出して開いたフレームワーク セッションへのハンドルを使用します。 フレームワークは 、WINBIO_ASYNC_RESULT 構造体を割り当て、それを使用して操作の成功または失敗に関する情報を返します。 列挙操作が成功した場合、フレームワークは、列挙された各生体認証ユニットに関する情報を含むスキーマの配列を返します。 操作が失敗した場合、フレームワークは WINBIO_ASYNC_RESULT 構造体を使用してエラー情報を返します。 構造体は、WinBioAsyncOpenFramework 関数の NotificationMethod パラメーターで設定した値に応じて、アプリケーション コールバックまたはアプリケーション メッセージ キューに返されます。

  • コールバックを使用して完了通知を受け取る場合は、 PWINBIO_ASYNC_COMPLETION_CALLBACK 関数を実装し、 NotificationMethod パラメーターを WINBIO_ASYNC_NOTIFY_CALLBACK に設定する必要があります。
  • アプリケーション メッセージ キューを使用して完了通知を受け取る場合は、 NotificationMethod パラメーターを WINBIO_ASYNC_NOTIFY_MESSAGE に設定する必要があります。 フレームワークは、ウィンドウ メッセージの LPARAM フィールドへのWINBIO_ASYNC_RESULT ポインターを返します。
スキーマの配列は、WINBIO_ASYNC_RESULT構造体内に入れ子になった EnumBiometricUnits 構造体で返されます。 使用が完了したら、 WinBioFree を呼び出して WINBIO_ASYNC_RESULT 構造体を解放する必要があります。

WinBioAsyncEnumBiometricUnits を呼び出すと、1 つの通知がクライアント アプリケーションに送信されます。

要件

   
サポートされている最小のクライアント Windows 8 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2012 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winbio.h (Winbio.h を含む)
Library Winbio.lib
[DLL] Winbio.dll

関連項目

WinBioAsyncOpenFramework