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

Статья
08/27/2023

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

Синтаксис

HRESULT WinBioGetEnrolledFactors(
  [in]  WINBIO_IDENTITY       *AccountOwner,
  [out] WINBIO_BIOMETRIC_TYPE *EnrolledFactors
);

Параметры

[in] AccountOwner

Структура WINBIO_IDENTITY для пользователя, чьи биометрические регистрации вы хотите получить. Пример:

WINBIO_IDENTITY identity = {};
identity.Type = WINBIO_ID_TYPE_SID;

// Move an account SID into identity.Value.AccountSid.Data.
// For example, CopySid(...)

Чтобы просмотреть регистрации для каждого пользователя на компьютере, укажите тип удостоверения WINBIO_ID_TYPE_WILDCARD для структуры WINBIO_IDENTITY , указанной для параметра AccountOwner . Пример:

WINBIO_IDENTITY identity = {};
identity.Type = WINBIO_ID_TYPE_WILDCARD;

[out] EnrolledFactors

Набор WINBIO_BIOMETRIC_TYPE флагов, указывающих биометрические регистрации, которые указанный пользователь имеет на компьютере. Значение 0 указывает, что у пользователя нет биометрических регистраций.

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

Если указать тип удостоверения с подстановочными знаками для структуры WINBIO_IDENTITY , используемой для параметра AccountOwner , этот набор флагов представляет собой объединенный набор регистраций для всех пользователей с учетными записями на компьютере.

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

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

Код возврата	Описание
E_POINTER	Параметры AccountOwner и EnrolledFactors не могут иметь значение NULL.
E_INVALIDARG	Элемент Typeструктуры WINBIO_IDENTITY , указанный в параметре AccountOnwer , не был WINBIO_ID_TYPE_SID или WINBIO_ID_TYPE_WILDCARD либо элемент AccountSidструктуры WINBIO_IDENTITY был недопустим.

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

WinBioGetEnrolledFactors предоставляет поставщикам учетных данных способ соответствующим образом адаптировать свой пользовательский интерфейс. Например, экран входа вызывает WinBioGetEnrolledFactors , чтобы определить, следует ли отображать параметр входа с отпечатком пальца.

Примеры

WINBIO_BIOMETRIC_TYPE enrolledFactors = WINBIO_NO_TYPE_AVAILABLE;

WINBIO_IDENTITY identity = {};
identity.Type = WINBIO_ID_TYPE_SID;

// Move an account SID into identity.Value.AccountSid.Data.
// e.g., CopySid(...)

HRESULT hr = WinBioGetEnrolledFactors(&identity, &enrolledFactors);

Требования

Требование	Значение
Минимальная версия клиента	Windows 10 [только классические приложения]
Минимальная версия сервера	Windows Server 2016 [только классические приложения]
Целевая платформа	Windows
Header	winbio.h
Библиотека	Winbio.lib
DLL	Winbio.dll

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

WINBIO_BIOMETRIC_TYPE

WINBIO_IDENTITY

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