Fonction WinBioGetEnrolledFactors (winbio.h)

Article
03/06/2024

Obtient des informations sur les inscriptions biométriques que l’utilisateur spécifié a sur l’ordinateur. Les inscriptions biométriques incluent les inscriptions pour la reconnaissance faciale, l’analyse des empreintes digitales, l’analyse de l’iris, etc.

Syntaxe

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

Paramètres

[in] AccountOwner

Structure WINBIO_IDENTITY pour l’utilisateur dont vous souhaitez obtenir les inscriptions biométriques. Par exemple :

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

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

Pour afficher les inscriptions de chaque utilisateur sur l’ordinateur, spécifiez le type d’identité WINBIO_ID_TYPE_WILDCARD pour la structure WINBIO_IDENTITY que vous spécifiez pour le paramètre AccountOwner . Par exemple :

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

[out] EnrolledFactors

Ensemble d’indicateurs de WINBIO_BIOMETRIC_TYPE qui indiquent les inscriptions biométriques de l’utilisateur spécifié sur l’ordinateur. La valeur 0 indique que l’utilisateur n’a pas d’inscriptions biométriques.

Ces inscriptions représentent uniquement les inscriptions de pool système, telles que les inscriptions que vous pouvez utiliser pour authentifier un utilisateur pour la connexion, le déverrouillage, etc. Cette valeur n’inclut pas les inscriptions de pool privé.

Si vous spécifiez le type d’identité générique pour la structure WINBIO_IDENTITY que vous utilisez pour le paramètre AccountOwner , cet ensemble d’indicateurs représente l’ensemble combiné d’inscriptions pour tous les utilisateurs disposant de comptes sur l’ordinateur.

Valeur retournée

Si la fonction réussit, elle retourne S_OK. Si la fonction échoue, elle retourne une valeur HRESULT qui indique l’erreur. Les valeurs possibles sont notamment celles figurant dans le tableau suivant. Pour obtenir la liste des codes d’erreur courants, consultez Valeurs HRESULT courantes.

Code de retour	Description
E_POINTER	Les paramètres AccountOwner et EnrolledFactors ne peuvent pas être NULL.
E_INVALIDARG	Membre Type de la structure WINBIO_IDENTITY que le paramètre AccountOnwer a spécifié n’était pas WINBIO_ID_TYPE_SID ou WINBIO_ID_TYPE_WILDCARD, ou que le membre AccountSid de la structure WINBIO_IDENTITY n’était pas valide.

Remarques

WinBioGetEnrolledFactors ne nécessite pas de handle de session biométrique et n’active pas le service biométrique. Par conséquent, WinBioGetEnrolledFactors s’exécute rapidement et est utile lorsque votre code doit prendre des décisions rapides sur la façon de procéder lorsque le temps est critique pour l’ensemble des opérations que vous devez effectuer.

WinBioGetEnrolledFactors fournit aux fournisseurs d’informations d’identification un moyen d’adapter leur interface utilisateur de manière appropriée. Par exemple, l’écran de connexion appelle WinBioGetEnrolledFactors pour déterminer s’il faut afficher l’option de connexion avec une empreinte digitale.

Exemples

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);

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 10 (applications de bureau uniquement)
Serveur minimal pris en charge	Windows Server 2016 (applications de bureau uniquement)
Plateforme cible	Windows
En-tête	winbio.h
Bibliothèque	Winbio.lib
DLL	Winbio.dll

Voir aussi

WINBIO_BIOMETRIC_TYPE

WINBIO_IDENTITY

Partager via