WinBioOpenSession 関数 (winbio.h)

  • [アーティクル]

生体認証サービス プロバイダーと 1 つ以上の生体認証ユニットに接続します。

構文

HRESULT WinBioOpenSession(
  [in]  WINBIO_BIOMETRIC_TYPE Factor,
  [in]  WINBIO_POOL_TYPE      PoolType,
  [in]  WINBIO_SESSION_FLAGS  Flags,
  [in]  WINBIO_UNIT_ID        *UnitArray,
  [in]  SIZE_T                UnitCount,
  [in]  GUID                  *DatabaseId,
  [out] WINBIO_SESSION_HANDLE *SessionHandle
);

パラメーター

[in] Factor

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

[in] PoolType

セッションで使用される生体認証ユニットの種類を指定する ULONG 値。 次のいずれかの値を指定できます。

値 説明
WINBIO_POOL_SYSTEM
 セッションは、サービス プロバイダーによって管理される生体認証ユニットの共有コレクションに接続します。
WINBIO_POOL_PRIVATE
 セッションは、呼び出し元によって管理される生体認証ユニットのコレクションに接続します。

[in] Flags

新しいセッションの生体認証ユニットの構成とアクセス特性を指定する ULONG 値。 構成フラグは、セッション内のユニットの一般的な構成を指定します。 アクセス フラグは、アプリケーションで生体認証ユニットを使用する方法を指定します。 1 つの構成フラグを指定する必要がありますが、そのフラグを任意のアクセス フラグと組み合わせることができます。

値 説明
WINBIO_FLAG_DEFAULT
 グループ: 構成

生体認証ユニットは、インストール時に指定された方法で動作します。 PoolType パラメーターがWINBIO_POOL_SYSTEM場合は、この値を使用する必要があります。
WINBIO_FLAG_BASIC
 グループ: 構成

生体認証ユニットは、基本的なキャプチャ デバイスとしてのみ動作します。 すべての処理、照合、およびストレージ操作は、ソフトウェア プラグインによって実行されます。
WINBIO_FLAG_ADVANCED
 グループ: 構成

生体認証ユニットでは、内部処理とストレージ機能が使用されます。
WINBIO_FLAG_RAW
 グループ: アクセス

クライアント アプリケーションは 、WinBioCaptureSample を使用して生の生体認証データをキャプチャします。
WINBIO_FLAG_MAINTENANCE
 グループ: アクセス

クライアントは、 WinBioControlUnitPrivileged を呼び出すことによって、生体認証ユニットに対してベンダー定義の制御操作を実行します。

[in] UnitArray

セッションに含める生体認証ユニット識別子の配列へのポインター。 WinBioEnumBiometricUnits を呼び出して生体認証ユニットを列挙できます。 PoolType パラメーターがWINBIO_POOL_SYSTEM場合は、この値を NULL に設定します。

[in] UnitCount

UnitArray パラメーターが指す配列内の要素の数を示す 値です。 PoolType パラメーターがWINBIO_POOL_SYSTEM場合は、この値を 0 に設定します。

[in] DatabaseId

セッションで使用されるデータベースを示す 値。 PoolType パラメーターがWINBIO_POOL_PRIVATE場合は、インストールされているデータベースの GUID を指定する必要があります。 PoolType パラメーターがWINBIO_POOL_PRIVATEされていない場合は、次のいずれかの共通値を指定できます。

値 説明
WINBIO_DB_DEFAULT
 センサー プール内の各生体認証ユニットは、既定の生体認証ユニット構成で指定された既定のデータベースを使用します。 PoolType パラメーターがWINBIO_POOL_SYSTEM場合は、この値を指定する必要があります。 PoolType パラメーターがWINBIO_POOL_PRIVATE場合は、この値を使用できません。
WINBIO_DB_BOOTSTRAP
 この値は、Windows を起動する前のシナリオで使用するように指定できます。 通常、データベースはセンサー チップの一部であるか、BIOS の一部であり、テンプレートの登録と削除にのみ使用できます。
WINBIO_DB_ONCHIP
 データベースはセンサー チップ上にあり、登録と照合に使用できます。

[out] SessionHandle

新しいセッション ハンドルへのポインター。 関数が成功しない場合、ハンドルは 0 に設定されます。

戻り値

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

リターン コード 説明
E_INVALIDARG
 1 つ以上の引数の値が正しくないか、他の引数と互換性がありません。
E_POINTER
 SessionHandle パラメーターのセッション ハンドル ポインターを NULL にすることはできません。
E_ACCESSDENIED
 Flags パラメーターには、WINBIO_FLAG_RAWまたはWINBIO_FLAG_MAINTENANCE フラグが含まれており、呼び出し元にどちらのアクセス許可も付与されていません。
WINBIO_E_INVALID_UNIT
 UnitArray パラメーターで指定された 1 つ以上の生体認証ユニット番号が無効です。
WINBIO_E_NOT_ACTIVE_CONSOLE
 クライアント アプリケーションがリモート デスクトップ クライアントで実行されており、システム プール セッションを開こうとしています。
WINBIO_E_SENSOR_UNAVAILABLE
 PoolType パラメーターは WINBIO_POOL_PRIVATE に設定されており、そのプール内の 1 つ以上の要求されたセンサーは使用できません。
WINBIO_E_DISABLED
 現在の管理ポリシーでは、Windows 生体認証フレームワーク API の使用は禁止されています。

要件

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

関連項目

WinBioCloseSession