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 值的指针，该值包含捕获生物识别样本失败的其他信息。如果捕获成功，此参数将设置为零。为指纹捕获定义了以下值：

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	匹配的引擎需要一个或多个额外的示例来生成可靠的模板。应向用户更新说明以提交更多示例并再次调用 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