WinBioEnumEnrollments 函数 (winbio.h)

项目
03/03/2024

检索为指定标识和生物识别单元注册的生物识别子因素。从Windows 10版本 1607 开始，此函数可用于移动映像。

语法

HRESULT WinBioEnumEnrollments(
  [in]            WINBIO_SESSION_HANDLE    SessionHandle,
  [in]            WINBIO_UNIT_ID           UnitId,
  [in]            WINBIO_IDENTITY          *Identity,
                  WINBIO_BIOMETRIC_SUBTYPE **SubFactorArray,
  [out, optional] SIZE_T                   *SubFactorCount
);

参数

[in] SessionHandle

标识打开的生物识别会话 的WINBIO_SESSION_HANDLE 值。通过调用 WinBioOpenSession 打开同步会话句柄。通过调用 WinBioAsyncOpenSession 打开异步会话句柄。

[in] UnitId

指定生物识别单位 的WINBIO_UNIT_ID 值。

[in] Identity

指向 WINBIO_IDENTITY 结构的指针，该结构包含要从中检索子因子的模板的 GUID 或 SID。

SubFactorArray

接收指向子因素数组的指针的变量的地址。如果函数不成功，则指针设置为 NULL。如果函数成功，则必须将指针传递到 WinBioFree ，以释放内部为数组分配的内存。

[out, optional] SubFactorCount

指向一个值的指针，该值指定 SubFactorArray 参数指向的数组中的元素数。如果函数不成功，则此值设置为零。

返回值

如果函数成功，则返回S_OK。如果函数失败，它将返回一个 指示错误的 HRESULT 值。可能的值包括（但并不限于）下表中的项。有关常见错误代码的列表，请参阅通用 HRESULT 值。

返回代码	说明
E_HANDLE	会话句柄无效。
E_INVALIDARG	UnitId 参数不能为零。
E_POINTER	Identity、SubFactorArray 和 SubFactorCount 参数不能为 NULL。
WINBIO_E_ENROLLMENT_IN_PROGRESS	无法完成该操作，因为 UnitId 参数指定的生物识别单元当前正用于注册事务。
WINBIO_E_UNKNOWN_ID	找不到由 Identity 参数指定的 GUID 或 SID。

注解

WinBioEnumEnrollments 函数主要是为了使应用程序可以提供用户反馈。例如，应用程序可以调用此函数来告知用户已在特定指纹读取器上注册了哪些指纹。

使用返回到 SubFactorArray 参数的结构后，必须调用 WinBioFree 以释放在内部为数组分配的内存。

若要同步使用 WinBioEnumEnrollments ，请使用通过调用 WinBioOpenSession 创建的会话句柄调用函数。函数将一直阻止，直到操作完成或遇到错误。

若要异步使用 WinBioEnumEnrollments ，请使用通过调用 WinBioAsyncOpenSession 创建的会话句柄调用函数。框架分配 WINBIO_ASYNC_RESULT 结构，并使用它返回有关操作成功或失败的信息。如果操作成功，框架将返回嵌套 EnumEnrollments 结构中的WINBIO_IDENTITY和WINBIO_BIOMETRIC_SUBTYPE信息。如果操作不成功，框架将返回错误信息。 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 以释放它。

示例

以下函数调用 WinBioEnumEnrollments 来枚举为模板注册的生物识别子因素。链接到 Winbio.lib 静态库并包含以下头文件：

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

HRESULT EnumEnrollments( )
{
    // Declare variables.
    HRESULT hr = S_OK;
    WINBIO_IDENTITY identity = {0};
    WINBIO_SESSION_HANDLE sessionHandle = NULL;
    WINBIO_UNIT_ID unitId = 0;
    PWINBIO_BIOMETRIC_SUBTYPE subFactorArray = NULL;
    WINBIO_BIOMETRIC_SUBTYPE SubFactor = 0;
    SIZE_T subFactorCount = 0;
    WINBIO_REJECT_DETAIL rejectDetail = 0;
    WINBIO_BIOMETRIC_SUBTYPE subFactor = WINBIO_SUBTYPE_NO_INFORMATION;

    // 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. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // Locate the biometric sensor and retrieve a WINBIO_IDENTITY object.
    wprintf_s(L"\n Calling WinBioIdentify - Swipe finger on sensor...\n");
    hr = WinBioIdentify( 
            sessionHandle,              // Session handle
            &unitId,                    // Biometric unit ID
            &identity,                  // User SID
            &subFactor,                 // Finger sub factor
            &rejectDetail               // Rejection information
            );
    wprintf_s(L"\n Swipe processed - Unit ID: %d\n", unitId);
    if (FAILED(hr))
    {
        if (hr == WINBIO_E_UNKNOWN_ID)
        {
            wprintf_s(L"\n Unknown identity.\n");
        }
        else if (hr == WINBIO_E_BAD_CAPTURE)
        {
            wprintf_s(L"\n Bad capture; reason: %d\n", rejectDetail);
        }
        else
        {
            wprintf_s(L"\n WinBioEnumBiometricUnits failed. hr = 0x%x\n", hr);
        }
        goto e_Exit;
    }

    // Retrieve the biometric sub-factors for the template.
    hr = WinBioEnumEnrollments( 
            sessionHandle,              // Session handle
            unitId,                     // Biometric unit ID
            &identity,                  // Template ID
            &subFactorArray,            // Subfactors
            &subFactorCount             // Count of subfactors
            );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioEnumEnrollments failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // Print the sub-factor(s) to the console.
    wprintf_s(L"\n Enrollments for this user on Unit ID %d:", unitId);
    for (SIZE_T index = 0; index < subFactorCount; ++index)
    {
        SubFactor = subFactorArray[index];
        switch (SubFactor)
        {
            case WINBIO_ANSI_381_POS_RH_THUMB:
                wprintf_s(L"\n   RH thumb\n");
                break;
            case WINBIO_ANSI_381_POS_RH_INDEX_FINGER:
                wprintf_s(L"\n   RH index finger\n");
                break;
            case WINBIO_ANSI_381_POS_RH_MIDDLE_FINGER:
                wprintf_s(L"\n   RH middle finger\n");
                break;
            case WINBIO_ANSI_381_POS_RH_RING_FINGER:
                wprintf_s(L"\n   RH ring finger\n");
                break;
            case WINBIO_ANSI_381_POS_RH_LITTLE_FINGER:
                wprintf_s(L"\n   RH little finger\n");
                break;
            case WINBIO_ANSI_381_POS_LH_THUMB:
                wprintf_s(L"\n   LH thumb\n");
                break;
            case WINBIO_ANSI_381_POS_LH_INDEX_FINGER:
                wprintf_s(L"\n   LH index finger\n");
                break;
            case WINBIO_ANSI_381_POS_LH_MIDDLE_FINGER:
                wprintf_s(L"\n   LH middle finger\n");
                break;
            case WINBIO_ANSI_381_POS_LH_RING_FINGER:
                wprintf_s(L"\n   LH ring finger\n");
                break;
            case WINBIO_ANSI_381_POS_LH_LITTLE_FINGER:
                wprintf_s(L"\n   LH little finger\n");
                break;
            default:
                wprintf_s(L"\n   The sub-factor is not correct\n");
                break;
        }
 
    }

e_Exit:
    if (subFactorArray!= NULL)
    {
        WinBioFree(subFactorArray);
        subFactorArray = NULL;
    }

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

    wprintf_s(L"\n Press any key to exit...");
    _getch();

    return hr;
}

要求

要求	值
最低受支持的客户端	Windows 7 [仅限桌面应用]
最低受支持的服务器	Windows Server 2008 R2 [仅限桌面应用]
目标平台	Windows
标头	winbio.h (包括 Winbio.h)
Library	Winbio.lib
DLL	Winbio.dll

另请参阅

WinBioEnumBiometricUnits

WinBioEnumDatabases

WinBioEnumServiceProviders

通过

WinBioEnumEnrollments 函数 (winbio.h)

语法

参数

返回值

注解

示例

要求

另请参阅

反馈

其他资源