WinBioEnrollCapture 関数 (winbio.h)

[アーティクル]
08/27/2023

生体認証サンプルをキャプチャし、テンプレートに追加します。 Windows 10 ビルド 1607 以降では、この関数をモバイルイメージで使用できます。

構文

HRESULT WinBioEnrollCapture(
  [in]            WINBIO_SESSION_HANDLE SessionHandle,
  [out, optional] WINBIO_REJECT_DETAIL  *RejectDetail
);

パラメーター

[in] SessionHandle

開いている生体認証セッションを識別する WINBIO_SESSION_HANDLE 値。 WinBioOpenSession を呼び出して同期セッションハンドルを開きます。 WinBioAsyncOpenSession を呼び出して非同期セッションハンドルを開きます。

[out, optional] RejectDetail

生体認証サンプルのキャプチャに失敗した追加情報を含む ULONG 値へのポインター。キャプチャが成功した場合、このパラメーターは 0 に設定されます。フィンガープリントキャプチャには、次の値が定義されています。

WINBIO_FP_TOO_HIGH
WINBIO_FP_TOO_LOW
WINBIO_FP_TOO_LEFT
WINBIO_FP_TOO_RIGHT
WINBIO_FP_TOO_FAST
WINBIO_FP_TOO_SLOW
WINBIO_FP_POOR_QUALITY
WINBIO_FP_TOO_SKEWED
WINBIO_FP_TOO_SHORT
WINBIO_FP_MERGE_FAILURE

戻り値

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

リターンコード	説明
E_ACCESSDENIED	呼び出し元アカウントは登録を実行できません。
E_HANDLE	セッションハンドルが無効です。
E_POINTER	RejectDetail パラメーターで指定されたポインターを NULL にすることはできません。
WINBIO_E_BAD_CAPTURE	サンプルをキャプチャできませんでした。詳細については、 RejectDetail 値を使用してください。
WINBIO_E_LOCK_VIOLATION	生体認証ユニットは使用中であり、ロックされています。
WINBIO_I_MORE_DATA	照合エンジンでは、信頼性の高いテンプレートを生成するために 1 つ以上の追加サンプルが必要です。ユーザーに指示を更新して、より多くのサンプルを送信し、 WinBioEnrollCapture をもう一度呼び出す必要があります。

注釈

システムプールで生体認証ユニットを使用して登録するアプリケーションは、 WinBioEnrollBegin を呼び出すときにウィンドウフォーカスを持っている必要があります。そうでない場合、アプリケーションがウィンドウフォーカスを取得し、ユーザーが生体認証サンプルを提供するまで、呼び出しはブロックされます。そのため、アプリケーションがフォーカスを取得するまで WinBioEnrollBegin を呼び出しないことをお勧めします。フォーカスを取得する方法は、作成するアプリケーションの種類によって異なります。たとえば、GUI アプリケーションを作成する場合は、WM_ACTIVATE、WM_SETFOCUS、またはその他の適切なメッセージをキャプチャするメッセージハンドラーを実装できます。 CUI アプリケーションを作成する場合は、 GetConsoleWindow を呼び出してコンソールウィンドウへのハンドルを取得し、そのハンドルを SetForegroundWindow 関数に渡してコンソールウィンドウをフォアグラウンドに強制的に割り当て、フォーカスを割り当てます。アプリケーションがデタッチされたプロセスで実行されていて、ウィンドウがない場合、または Windows サービスである場合は、 WinBioAcquireFocus と WinBioReleaseFocus を使用して手動でフォーカスを制御します。

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

WinBioEnrollCapture を非同期的に使用するには、WinBioAsyncOpenSession を呼び出して作成されたセッションハンドルで関数を呼び出します。フレームワークは、WINBIO_ASYNC_RESULT 構造体を割り当て、それを使用して操作の成功または失敗に関する情報を返します。操作が失敗した場合、フレームワークは入れ子になった EnrollCapture 構造体WINBIO_REJECT_DETAIL情報を返します。 WINBIO_ASYNC_RESULT構造体は、WinBioAsyncOpenSession 関数の NotificationMethod パラメーターで設定した値に応じて、アプリケーションコールバックまたはアプリケーションメッセージキューに返されます。

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

メモリリークを防ぐには、コールバック実装から WinBioFree を呼び出して、WINBIO_ASYNC_RESULT 構造体の使用が完了した後で解放する必要があります。

Windows 7: この操作は、 WinBioEnrollCaptureWithCallback 関数を使用して非同期的に実行できます。関数は入力引数を検証し、すぐにを返します。入力引数が無効な場合、関数はエラーコードを返します。それ以外の場合、フレームワークは別のスレッドで操作を開始します。非同期操作が完了するか、エラーが発生すると、フレームワークはアプリケーションによって実装された PWINBIO_ENROLL_CAPTURE_CALLBACK 関数に結果を送信します。

例

次の関数は、 WinBioEnrollCapture を呼び出して、システムプールに生体認証テンプレートを登録します。 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;

    // Connect to the system pool. 
    hr = WinBioOpenSession( 
            WINBIO_TYPE_FINGERPRINT,    // Service provider
            WINBIO_POOL_SYSTEM,         // Pool type
            WINBIO_FLAG_DEFAULT,        // Configuration and access
            NULL,                       // Array of biometric unit IDs
            0,                          // Count of biometric unit IDs
            NULL,                       // Database ID
            &sessionHandle              // [out] Session handle
            );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioOpenSession failed. ");
        wprintf_s(L"hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // Locate a sensor.
    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;
    }

    // Begin the enrollment sequence. 
    wprintf_s(L"\n Starting enrollment sequence...\n");
    hr = WinBioEnrollBegin(
            sessionHandle,      // Handle to open biometric session
            subFactor,          // Finger to create template for
            unitId              // Biometric unit ID
            );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioEnrollBegin failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // Capture enrollment information by swiping the sensor with
    // the finger identified by the subFactor argument in the 
    // WinBioEnrollBegin function.
    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,  // Handle to open biometric session
                &rejectDetail   // [out] Failure information
                );

        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;
        }
    }

    // Discard the enrollment if the appropriate flag is set.
    // Commit the enrollment if it is not discarded.
    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,      // Handle to open biometric session
                &identity,          // WINBIO_IDENTITY object for the user
                &isNewTemplate);    // Is this a new template

        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;
}

要件

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