ホーム › Devices.BiometricFramework › WinBioEnrollCommit

WinBioEnrollCommit

関数

採取した生体情報を登録テンプレートとして確定保存する。

DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

// winbio.dll
#include <windows.h>

HRESULT WinBioEnrollCommit(
    DWORD SessionHandle,
    WINBIO_IDENTITY* Identity,   // optional
    BYTE* IsNewTemplate   // optional
);

パラメーター

名前	型	方向	説明
SessionHandle	DWORD	in	オープンされている生体認証セッションを識別する WINBIO_SESSION_HANDLE 値です。同期セッションハンドルは WinBioOpenSession を呼び出して開きます。非同期セッションハンドルは WinBioAsyncOpenSession を呼び出して開きます。
Identity	WINBIO_IDENTITY*	outoptional	テンプレートの識別子 (GUID または SID) を受け取る WINBIO_IDENTITY 構造体へのポインターです。
IsNewTemplate	BYTE*	outoptional	データベースに追加されるテンプレートが新規かどうかを示すブール値へのポインターです。

戻り値の型: HRESULT

公式ドキュメント

保留中の生体認証テンプレートを確定し、登録に使用した生体認証ユニットに関連付けられたデータベースに保存します。Windows 10 ビルド 1607 以降、この関数はモバイルイメージで使用できます。

戻り値

関数が成功した場合は S_OK を返します。失敗した場合は、エラーを示す HRESULT 値を返します。返される可能性のある値には次の表のものが含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

リターンコード	説明
E_HANDLE	セッションハンドルが有効ではありません。
E_POINTER	Identity パラメーターおよび IsNewTemplate パラメーターで指定するポインターを NULL にすることはできません。
WINBIO_E_DATABASE_FULL	データベースにテンプレートを格納する空き領域がありません。
WINBIO_E_DUPLICATE_TEMPLATE	このテンプレートは、別の ID またはサブファクターでデータベースに既に保存されているテンプレートと一致します (システムプールのみ)。
WINBIO_E_LOCK_VIOLATION	生体認証ユニットが使用中でロックされています。

解説(Remarks)

保留中のテンプレートがデータベースに既に存在するテンプレートと重複している場合、Identity パラメーターは既存のテンプレートを指し、IsNewTemplate パラメーターが指す値は FALSE になります。

WinBioEnrollCommit 関数が成功すると、次のレジストリ値が 0x01 に設定されます。

HKEY_LOCAL_MACHINE
   System
      CurrentControlSet
         Services
            WbioSrvc
               Parameters
                  EnrollmentCommitted

注このレジストリ値が Windows Biometric Framework (WBF) によって削除されることはありません。

WinBioEnrollCommit を同期的に使用するには、WinBioOpenSession を呼び出して作成したセッションハンドルを指定して、この関数を呼び出します。関数は、操作が完了するかエラーが発生するまでブロックします。

WinBioEnrollCommit を非同期的に使用するには、WinBioAsyncOpenSession を呼び出して作成したセッションハンドルを指定して、この関数を呼び出します。フレームワークは WINBIO_ASYNC_RESULT 構造体を割り当て、それを使用して操作の成否に関する情報を返します。操作が成功した場合、フレームワークは入れ子になった EnrollCommit 構造体に WINBIO_IDENTITY 情報と、テンプレートが新規かどうかを示すフラグを格納して返します。操作が失敗した場合、フレームワークはエラー情報を返します。WINBIO_ASYNC_RESULT 構造体は、WinBioAsyncOpenSession 関数の NotificationMethod パラメーターに設定した値に応じて、アプリケーションのコールバックまたはアプリケーションのメッセージキューに返されます。

コールバックを使用して完了通知を受け取る場合は、PWINBIO_ASYNC_COMPLETION_CALLBACK 関数を実装し、NotificationMethod パラメーターに WINBIO_ASYNC_NOTIFY_CALLBACK を設定する必要があります。
アプリケーションのメッセージキューを使用して完了通知を受け取る場合は、NotificationMethod パラメーターに WINBIO_ASYNC_NOTIFY_MESSAGE を設定する必要があります。フレームワークは、ウィンドウメッセージの LPARAM フィールドに WINBIO_ASYNC_RESULT ポインターを返します。

メモリリークを防ぐため、WINBIO_ASYNC_RESULT 構造体の使用が終わったら、WinBioFree を呼び出して解放する必要があります。

例

次の関数は、WinBioEnrollCommit を呼び出して生体認証の登録をシステムプールにコミットします。Winbio.lib スタティックライブラリをリンクし、次のヘッダーファイルをインクルードしてください。

Windows.h
Stdio.h
Conio.h
Winbio.h

HRESULT EnrollSysPool(
                      BOOL discardEnrollment, 
                      WINBIO_BIOMETRIC_SUBTYPE subFactor)
{
    HRESULT hr = S_OK;
    WINBIO_IDENTITY identity = {0};
    WINBIO_SESSION_HANDLE sessionHandle = NULL;
    WINBIO_UNIT_ID unitId = 0;
    WINBIO_REJECT_DETAIL rejectDetail = 0;
    BOOLEAN isNewTemplate = TRUE;

    // システムプールに接続します。
    hr = WinBioOpenSession( 
            WINBIO_TYPE_FINGERPRINT,    // サービスプロバイダー
            WINBIO_POOL_SYSTEM,         // プールの種類
            WINBIO_FLAG_DEFAULT,        // 構成とアクセス
            NULL,                       // 生体認証ユニット ID の配列
            0,                          // 生体認証ユニット ID の数
            NULL,                       // データベース ID
            &sessionHandle              // [out] セッションハンドル
            );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioOpenSession failed. ");
        wprintf_s(L"hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // センサーを検出します。
    wprintf_s(L"\n Swipe your finger on the sensor...\n");
    hr = WinBioLocateSensor( sessionHandle, &unitId);
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioLocateSensor failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // 登録シーケンスを開始します。
    wprintf_s(L"\n Starting enrollment sequence...\n");
    hr = WinBioEnrollBegin(
            sessionHandle,      // オープン済みの生体認証セッションのハンドル
            subFactor,          // テンプレートを作成する対象の指
            unitId              // 生体認証ユニット ID
            );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioEnrollBegin failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // WinBioEnrollBegin 関数の subFactor 引数で指定した指で
    // センサーをスワイプして、登録情報をキャプチャします。
    for (int swipeCount = 1;; ++swipeCount)
    {
        wprintf_s(L"\n Swipe the sensor to capture %s sample.",
                 (swipeCount == 1)?L"the first":L"another");

        hr = WinBioEnrollCapture(
                sessionHandle,  // オープン済みの生体認証セッションのハンドル
                &rejectDetail   // [out] 失敗情報
                );

        wprintf_s(L"\n Sample %d captured from unit number %d.", 
                  swipeCount, 
                  unitId);

        if (hr == WINBIO_I_MORE_DATA)
        {
            wprintf_s(L"\n    More data required.\n");
            continue;
        }
        if (FAILED(hr))
        {
            if (hr == WINBIO_E_BAD_CAPTURE)
            {
                wprintf_s(L"\n  Error: Bad capture; reason: %d", 
                          rejectDetail);
                continue;
            }
            else
            {
                wprintf_s(L"\n WinBioEnrollCapture failed. hr = 0x%x", hr);
                goto e_Exit;
            }
        }
        else
        {
            wprintf_s(L"\n    Template completed.\n");
            break;
        }
    }

    // 対応するフラグが設定されている場合は登録を破棄します。
    // 破棄しない場合は登録をコミットします。
    if (discardEnrollment == TRUE)
    {
        wprintf_s(L"\n Discarding enrollment...\n\n");
        hr = WinBioEnrollDiscard( sessionHandle );
        if (FAILED(hr))
        {
            wprintf_s(L"\n WinBioLocateSensor failed. hr = 0x%x\n", hr);
        }
        goto e_Exit;    
    }
    else
    {
        wprintf_s(L"\n Committing enrollment...\n");
        hr = WinBioEnrollCommit( 
                sessionHandle,      // オープン済みの生体認証セッションのハンドル
                &identity,          // ユーザーの WINBIO_IDENTITY オブジェクト
                &isNewTemplate);    // 新しいテンプレートかどうか

        if (FAILED(hr))
        {
            wprintf_s(L"\n WinBioEnrollCommit failed. hr = 0x%x\n", hr);
            goto e_Exit;
        }
    }


e_Exit:
    if (sessionHandle != NULL)
    {
        WinBioCloseSession(sessionHandle);
        sessionHandle = NULL;
    }

    wprintf_s(L" Press any key to continue...");
    _getch();

    return hr;
}

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// winbio.dll
#include <windows.h>

HRESULT WinBioEnrollCommit(
    DWORD SessionHandle,
    WINBIO_IDENTITY* Identity,   // optional
    BYTE* IsNewTemplate   // optional
);

[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioEnrollCommit(
    uint SessionHandle,   // DWORD
    IntPtr Identity,   // WINBIO_IDENTITY* optional, out
    IntPtr IsNewTemplate   // BYTE* optional, out
);

<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioEnrollCommit(
    SessionHandle As UInteger,   ' DWORD
    Identity As IntPtr,   ' WINBIO_IDENTITY* optional, out
    IsNewTemplate As IntPtr   ' BYTE* optional, out
) As Integer
End Function

' SessionHandle : DWORD
' Identity : WINBIO_IDENTITY* optional, out
' IsNewTemplate : BYTE* optional, out
Declare PtrSafe Function WinBioEnrollCommit Lib "winbio" ( _
    ByVal SessionHandle As Long, _
    ByVal Identity As LongPtr, _
    ByVal IsNewTemplate As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinBioEnrollCommit = ctypes.windll.winbio.WinBioEnrollCommit
WinBioEnrollCommit.restype = ctypes.c_int
WinBioEnrollCommit.argtypes = [
    wintypes.DWORD,  # SessionHandle : DWORD
    ctypes.c_void_p,  # Identity : WINBIO_IDENTITY* optional, out
    ctypes.POINTER(ctypes.c_ubyte),  # IsNewTemplate : BYTE* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winbio.dll')
WinBioEnrollCommit = Fiddle::Function.new(
  lib['WinBioEnrollCommit'],
  [
    -Fiddle::TYPE_INT,  # SessionHandle : DWORD
    Fiddle::TYPE_VOIDP,  # Identity : WINBIO_IDENTITY* optional, out
    Fiddle::TYPE_VOIDP,  # IsNewTemplate : BYTE* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winbio")]
extern "system" {
    fn WinBioEnrollCommit(
        SessionHandle: u32,  // DWORD
        Identity: *mut WINBIO_IDENTITY,  // WINBIO_IDENTITY* optional, out
        IsNewTemplate: *mut u8  // BYTE* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("winbio.dll")]
public static extern int WinBioEnrollCommit(uint SessionHandle, IntPtr Identity, IntPtr IsNewTemplate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winbio_WinBioEnrollCommit' -Namespace Win32 -PassThru
# $api::WinBioEnrollCommit(SessionHandle, Identity, IsNewTemplate)

#uselib "winbio.dll"
#func global WinBioEnrollCommit "WinBioEnrollCommit" sptr, sptr, sptr
; WinBioEnrollCommit SessionHandle, varptr(Identity), varptr(IsNewTemplate)   ; 戻り値は stat
; SessionHandle : DWORD -> "sptr"
; Identity : WINBIO_IDENTITY* optional, out -> "sptr"
; IsNewTemplate : BYTE* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "winbio.dll"
#cfunc global WinBioEnrollCommit "WinBioEnrollCommit" int, var, var
; res = WinBioEnrollCommit(SessionHandle, Identity, IsNewTemplate)
; SessionHandle : DWORD -> "int"
; Identity : WINBIO_IDENTITY* optional, out -> "var"
; IsNewTemplate : BYTE* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "winbio.dll"
#cfunc global WinBioEnrollCommit "WinBioEnrollCommit" int, sptr, sptr
; res = WinBioEnrollCommit(SessionHandle, varptr(Identity), varptr(IsNewTemplate))
; SessionHandle : DWORD -> "int"
; Identity : WINBIO_IDENTITY* optional, out -> "sptr"
; IsNewTemplate : BYTE* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。