WinBioGetEnrolledFactors 関数 (winbio.h)

指定したユーザーがコンピューター上に持っている生体認証登録に関する情報を取得します。 生体認証登録には、顔認識、指紋スキャン、虹彩スキャンなどの登録が含まれます。

構文

HRESULT WinBioGetEnrolledFactors(
  [in]  WINBIO_IDENTITY       *AccountOwner,
  [out] WINBIO_BIOMETRIC_TYPE *EnrolledFactors
);

パラメーター

[in] AccountOwner

生体認証登録を取得するユーザーの WINBIO_IDENTITY 構造。 例:

WINBIO_IDENTITY identity = {};
identity.Type = WINBIO_ID_TYPE_SID;

// Move an account SID into identity.Value.AccountSid.Data.
// For example, CopySid(...)

コンピューター上のすべてのユーザーの登録を表示するには、AccountOwner パラメーターに指定するWINBIO_IDENTITY構造のWINBIO_ID_TYPE_WILDCARD ID の種類を指定します。 例:

WINBIO_IDENTITY identity = {};
identity.Type = WINBIO_ID_TYPE_WILDCARD;

[out] EnrolledFactors

指定したユーザーがコンピューター上に持っている生体認証登録を示す一連の WINBIO_BIOMETRIC_TYPE フラグ。 値 0 は、ユーザーに生体認証登録がないことを示します。

これらの登録は、サインイン、ロック解除などのユーザーの認証に使用できる登録など、システム プールの登録のみを表します。 この値には、プライベート プールの登録は含まれません。

AccountOwner パラメーターに使用するWINBIO_IDENTITY構造体にワイルドカード ID の種類を指定した場合、このフラグのセットは、コンピューター上のアカウントを持つすべてのユーザーの登録の組み合わせセットを表します。

戻り値

関数が成功した場合は、S_OK を返します。 関数が失敗した場合は、エラーを示す HRESULT 値を返します。 有効な値を次の表に示しますが、これ以外にもあります。 一般的なエラー コードの一覧については、「 共通の HRESULT 値」を参照してください。

リターン コード	説明
E_POINTER	AccountOwner パラメーターと EnrolledFactors パラメーターをNULL にすることはできません。
E_INVALIDARG	AccountOnwer パラメーターが指定したWINBIO_IDENTITY構造体の Type メンバーがWINBIO_ID_TYPE_SIDまたはWINBIO_ID_TYPE_WILDCARDされていないか、WINBIO_IDENTITY構造体の AccountSid メンバーが無効でした。

注釈

WinBioGetEnrolledFactors は生体認証セッション ハンドルを必要とせず、生体認証サービスをアクティブ化しません。 そのため、 WinBioGetEnrolledFactors は迅速に実行され、実行する必要がある一連の操作に対して時間が重要な場合の進め方についてコードが迅速に決定する必要がある場合に役立ちます。

WinBioGetEnrolledFactors は、UI を適切に調整する方法を資格情報プロバイダーに提供します。 たとえば、ログイン画面は WinBioGetEnrolledFactors を呼び出して、指紋でログインするオプションを表示するかどうかを決定します。

例

WINBIO_BIOMETRIC_TYPE enrolledFactors = WINBIO_NO_TYPE_AVAILABLE;

WINBIO_IDENTITY identity = {};
identity.Type = WINBIO_ID_TYPE_SID;

// Move an account SID into identity.Value.AccountSid.Data.
// e.g., CopySid(...)

HRESULT hr = WinBioGetEnrolledFactors(&identity, &enrolledFactors);

要件

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

こちらもご覧ください

WINBIO_BIOMETRIC_TYPE

WINBIO_IDENTITY