Поделиться через

Функция WinBioAsyncEnumBiometricUnits (winbio.h)

  • Статья

Асинхронно перечисляет все присоединенные биометрические единицы, соответствующие типу входного фактора. Синхронную версию этой функции см. в разделе WinBioEnumBiometricUnits. Начиная с Windows 10 сборки 1607 эта функция доступна для использования с мобильным образом.

Синтаксис

HRESULT WinBioAsyncEnumBiometricUnits(
  [in] WINBIO_FRAMEWORK_HANDLE FrameworkHandle,
  [in] WINBIO_BIOMETRIC_TYPE   Factor
);

Параметры

[in] FrameworkHandle

Обработка сеанса платформы, открытого путем вызова WinBioAsyncOpenFramework.

[in] Factor

Битовая маска флагов WINBIO_BIOMETRIC_TYPE , указывающая перечисляемые типы биометрических единиц. В настоящее время поддерживается только WINBIO_TYPE_FINGERPRINT .

Возвращаемое значение

Функция возвращает HRESULT , указывающее на успех или сбой. Обратите внимание, что успешное выполнение указывает только на то, что аргументы были допустимыми. Сбои, возникшие во время выполнения операции, будут асинхронно возвращены в структуру WINBIO_ASYNC_RESULT с помощью метода уведомления, указанного в вызове WinBioAsyncOpenFramework.

Код возврата Описание
E_HANDLE
 Необходимо задать аргумент FrameworkHandle .
E_INVALIDARG
 Битовая маска, содержащаяся в параметре Factor, содержит один или несколько битов недопустимого типа.
E_OUTOFMEMORY
 Недостаточно памяти для выполнения запроса.
WINBIO_E_DISABLED
 Текущая административная политика запрещает использование API Биометрической платформы Windows.
WINBIO_E_INCORRECT_SESSION_TYPE
 Аргумент FrameworkHandle должен представлять асинхронный сеанс платформы.
WINBIO_E_SESSION_HANDLE_CLOSED
 Дескриптор сеанса помечен для закрытия.

Комментарии

Функция WinBioAsyncEnumBiometricUnits использует дескриптор для сеанса платформы, открытого путем вызова WinBioAsyncOpenFramework. Платформа выделяет структуру WINBIO_ASYNC_RESULT и использует ее для возврата сведений об успешном или неудачном выполнении операции. Если операция перечисления выполнена успешно, платформа возвращает массив схем, включающих сведения о каждой перечислимой биометрической единице. Если операция завершается неудачно, платформа использует структуру WINBIO_ASYNC_RESULT для возврата сведений об ошибке. Структура возвращается в обратный вызов приложения или в очередь сообщений приложения в зависимости от значения, заданного в параметре NotificationMethod функции WinBioAsyncOpenFramework .

  • Если вы решили получать уведомления о завершении с помощью обратного вызова, необходимо реализовать функцию PWINBIO_ASYNC_COMPLETION_CALLBACK и задать для параметра NotificationMethodзначение WINBIO_ASYNC_NOTIFY_CALLBACK.
  • Если вы решили получать уведомления о завершении с помощью очереди сообщений приложения, необходимо задать для параметра NotificationMethodзначение WINBIO_ASYNC_NOTIFY_MESSAGE. Платформа возвращает указатель WINBIO_ASYNC_RESULT на поле LPARAM сообщения окна.
Массив схем возвращается в структуре EnumBiometricUnits , вложенной в структуру WINBIO_ASYNC_RESULT . Чтобы освободить структуру WINBIO_ASYNC_RESULT после завершения использования, необходимо вызвать WinBioFree.

Вызов WinBioAsyncEnumBiometricUnits приводит к отправке одного уведомления в клиентское приложение.

Требования

   
Минимальная версия клиента Windows 8 [только классические приложения]
Минимальная версия сервера Windows Server 2012 [только классические приложения]
Целевая платформа Windows
Header winbio.h (включая Winbio.h)
Библиотека Winbio.lib
DLL Winbio.dll

См. также раздел

WinBioAsyncOpenFramework