WinBioEnrollCommit 函式 (winbio.h)

發行項
03/13/2024

完成擱置中的生物特徵辨識範本，並將它儲存至與用於註冊之生物特徵辨識單位相關聯的資料庫。從 Windows 10 組建 1607 開始，此函式可用來搭配行動映射使用。

語法

HRESULT WinBioEnrollCommit(
  [in]            WINBIO_SESSION_HANDLE SessionHandle,
  [out, optional] WINBIO_IDENTITY       *Identity,
  [out, optional] BOOLEAN               *IsNewTemplate
);

參數

[in] SessionHandle

識別開放式生物特徵辨識會話 的WINBIO_SESSION_HANDLE 值。呼叫 WinBioOpenSession 來開啟同步會話句柄。呼叫 WinBioAsyncOpenSession 來開啟異步會話句柄。

[out, optional] Identity

接收範本識別碼 ( GUID 或 SID) 之WINBIO_IDENTITY結構的指標。

[out, optional] IsNewTemplate

布爾值的指標，指定是否要新增至資料庫的範本。

傳回值

如果函式成功，它會傳回S_OK。如果函式失敗，它會傳回 HRESULT 值，指出錯誤。可能的值包括 (但不限於) 下表中的這些值。如需常見錯誤碼的清單，請參閱一般 HRESULT 值。

傳回碼	Description
E_HANDLE	會話句柄無效。
E_POINTER	Identity 和 IsNewTemplate 參數指定的指標不可為 NULL。
WINBIO_E_DATABASE_FULL	範本的資料庫中沒有可用的空間。
WINBIO_E_DUPLICATE_TEMPLATE	此範本會比對資料庫中已儲存的身分識別或子因素 (系統集區) 。
WINBIO_E_LOCK_VIOLATION	生物特徵辨識單位正在使用中，並已鎖定。

備註

如果暫止範本是資料庫中已經存在的範本複本， Identity 參數會指向現有的範本， 而IsNewTemplate 參數所指向的值將會是 FALSE。

如果 WinBioEnrollCommit 函式成功，下列登錄值會設定為 0x01。

HKEY_LOCAL_MACHINE
   System
      CurrentControlSet
         Services
            WbioSrvc
               Parameters
                  EnrollmentCommitted

注意 Windows 生物特徵辨識架構 (WBF) 永遠不會刪除此登錄值。

若要以同步方式使用 WinBioEnrollCommit ，請使用呼叫 WinBioOpenSession 所建立的會話句柄呼叫函式。函式會封鎖直到作業完成或發生錯誤為止。

若要以異步方式使用 WinBioEnrollCommit ，請使用呼叫 WinBioAsyncOpenSession 所建立的會話句柄呼叫函式。架構會配置 WINBIO_ASYNC_RESULT 結構，並用它來傳回作業成功或失敗的相關信息。如果作業成功，架構會傳回 WINBIO_IDENTITY 資訊和旗標，指出範本是否在巢狀 的 EnrollCommit 結構中是新的。如果作業失敗，架構會傳回錯誤資訊。 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 結構。

範例

下列函式會呼叫 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;

    // 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)
程式庫	Winbio.lib
Dll	Winbio.dll

另請參閱

WinBioEnrollBegin

WinBioEnrollCapture

WinBioEnrollCaptureWithCallback

WinBioEnrollDiscard

共用方式為

WinBioEnrollCommit 函式 (winbio.h)

語法

參數

傳回值

備註

範例

規格需求

另請參閱

意見反應

其他資源