PIBIO_ENGINE_QUERY_EXTENDED_ENROLLMENT_STATUS_FN コールバック関数 (winbio_adapter.h)

  • [アーティクル]

クライアント アプリケーションが WINBIO_PROPERTY_EXTENDED_ENROLLMENT_STATUS プロパティに対してクエリを実行すると、Windows 生体認証フレームワークによって呼び出されます。

構文

PIBIO_ENGINE_QUERY_EXTENDED_ENROLLMENT_STATUS_FN PibioEngineQueryExtendedEnrollmentStatusFn;

HRESULT PibioEngineQueryExtendedEnrollmentStatusFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [out]     PWINBIO_EXTENDED_ENROLLMENT_STATUS EnrollmentStatus,
  [in]      SIZE_T EnrollmentStatusSize
)
{...}

パラメーター

[in, out] Pipeline

操作を実行する生体認証ユニットに関連付けられている WINBIO_PIPELINE 構造体へのポインター。

[out] EnrollmentStatus

この関数によって返される拡張登録状態情報を含む WINBIO_EXTENDED_ENROLLMENT_STATUS 構造体へのポインター。

[in] EnrollmentStatusSize

拡張登録ステータス情報の指定されたサイズ (バイト単位)。

戻り値

関数が成功した場合は、S_OK を返します。 関数が失敗した場合は、次のいずれかの HRESULT 値を返してエラーを示す必要があります。

リターン コード 説明
E_POINTER
 Pipeline パラメーターを NULL にすることはできません。
E_INVALIDARG
EnrollmentStatusSize パラメーターは、出力バッファーが小さすぎることを示します。

注釈

登録アプリケーションは、 WinBioEnrollCapture 関数を呼び出すたびに、拡張登録状態情報を要求できます。

このルーチンが呼び出されたときに生体認証ユニットが現在登録テンプレートでない場合、エンジン アダプターは EnrollmentStatus.TemplateStatus フィールドを WINBIO_E_INVALID_OPERATION に設定し、関数の値として S_OK を返す必要があります。

要件

要件 値
サポートされている最小のクライアント Windows 10 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2016 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winbio_adapter.h (Winbio_adapter.h を含む)