WinBioAsyncMonitorFrameworkChanges 関数 (winbio.h)

  • [アーティクル]

生体認証フレームワークへの変更の非同期モニターを開始します。 現在、サポートされている監視対象の変更は、生体認証ユニットがコンピューターに接続されているか、コンピューターからデタッチされている場合にのみ発生します。

構文

HRESULT WinBioAsyncMonitorFrameworkChanges(
  [in] WINBIO_FRAMEWORK_HANDLE      FrameworkHandle,
  [in] WINBIO_FRAMEWORK_CHANGE_TYPE ChangeTypes
);

パラメーター

[in] FrameworkHandle

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

[in] ChangeTypes

型のビットマスク WINBIO_FRAMEWORK_CHANGE_TYPE 、非同期通知を生成する必要があるイベントの種類を示すフラグです。 Windows 8以降、次のフラグを使用できます。

値 意味
WINBIO_FRAMEWORK_CHANGE_UNIT
 生体認証ユニットがコンピューターにアタッチされているか、コンピューターからデタッチされています。

戻り値

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

リターン コード 説明
E_HANDLE
 FrameworkHandle 引数を設定する必要があります。
E_INVALIDARG
 ChangeTypes パラメーターに含まれるビットマスクには、無効な型ビットが 1 つ以上含まれています。 現在、使用可能な値は WINBIO_FRAMEWORK_CHANGE_UNITのみです。
WINBIO_E_INCORRECT_SESSION_TYPE
 FrameworkHandle 引数は、非同期フレームワーク セッションを表す必要があります。

注釈

開始されると、クライアント アプリケーションが WinBioCancel または WinBioCloseFramework を呼び出すまで、このモニターはイベントの生成を続けます。 WINBIO_FRAMEWORK_CHANGE_UNIT イベントのモニターを作成すると、次の 2 種類の非同期通知が生成されます。

値 意味
WINBIO_OPERATION_UNIT_ARRIVAL 生体認証ユニットが接続されています。
WINBIO_OPERATION_UNIT_REMOVAL 生体認証ユニットがデタッチされます。
 

WinBioAsyncMonitorFrameworkChanges 関数は、WinBioAsyncOpenFramework を呼び出して開いたフレームワーク セッションへのハンドルを使用します。 フレームワークは 、WINBIO_ASYNC_RESULT 構造体を割り当て、それを使用して操作の成功または失敗に関する情報を返します。 生体認証ユニットがコンピューターにアタッチされているか、コンピューターからデタッチされている場合、フレームワークは構造体の Operation メンバーを設定します。 操作中に問題が発生した場合、フレームワークは 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構造体内に入れ子になった EnumServiceProviders 構造体で返されます。 使用が完了したら、 WinBioFree を呼び出して WINBIO_ASYNC_RESULT 構造体を解放する必要があります。

要件

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

こちらもご覧ください

WinBioAsyncOpenFramework