Fonction WinBioAsyncEnumBiometricUnits (winbio.h)

Article
08/27/2023

Énumère de manière asynchrone toutes les unités biométriques attachées qui correspondent au type de facteur d’entrée. Pour obtenir une version synchrone de cette fonction, consultez WinBioEnumBiometricUnits. À compter de Windows 10 build 1607, cette fonction peut être utilisée avec une image mobile.

Syntaxe

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

Paramètres

[in] FrameworkHandle

Gérez la session d’infrastructure ouverte en appelant WinBioAsyncOpenFramework.

[in] Factor

Masque de bits de WINBIO_BIOMETRIC_TYPE indicateurs qui spécifie les types d’unités biométriques à énumérer. Seule WINBIO_TYPE_FINGERPRINT est actuellement prise en charge.

Valeur retournée

La fonction retourne un HRESULT indiquant la réussite ou l’échec. Notez que la réussite indique uniquement que les arguments étaient valides. Les échecs rencontrés pendant l’exécution de l’opération sont renvoyés de manière asynchrone à une structure de WINBIO_ASYNC_RESULT à l’aide de la méthode de notification spécifiée dans l’appel à WinBioAsyncOpenFramework.

Code de retour	Description
E_HANDLE	Vous devez définir l’argument FrameworkHandle .
E_INVALIDARG	Le masque de bits contenu dans le paramètre Factor contient un ou plusieurs bits de type non valides.
E_OUTOFMEMORY	La mémoire était insuffisante pour effectuer la demande.
WINBIO_E_DISABLED	La stratégie d’administration actuelle interdit l’utilisation de l’API Du framework biométrique Windows.
WINBIO_E_INCORRECT_SESSION_TYPE	L’argument FrameworkHandle doit représenter une session de framework asynchrone.
WINBIO_E_SESSION_HANDLE_CLOSED	Le handle de session a été marqué pour fermeture.

Remarques

La fonction WinBioAsyncEnumBiometricUnits utilise un handle pour la session d’infrastructure ouverte en appelant WinBioAsyncOpenFramework. L’infrastructure alloue une structure de WINBIO_ASYNC_RESULT et l’utilise pour retourner des informations sur la réussite ou l’échec de l’opération. Si l’opération d’énumération réussit, l’infrastructure retourne un tableau de schémas qui inclut des informations sur chaque unité biométrique énumérée. Si l’opération échoue, l’infrastructure utilise la structure WINBIO_ASYNC_RESULT pour retourner les informations d’erreur. La structure est retournée au rappel de l’application ou à la file d’attente des messages de l’application, en fonction de la valeur que vous avez définie dans le paramètre NotificationMethod de la fonction WinBioAsyncOpenFramework .

Si vous choisissez de recevoir des notifications d’achèvement à l’aide d’un rappel, vous devez implémenter une fonction PWINBIO_ASYNC_COMPLETION_CALLBACK et définir le paramètre NotificationMethod sur WINBIO_ASYNC_NOTIFY_CALLBACK.
Si vous choisissez de recevoir des notifications d’achèvement à l’aide de la file d’attente de messages d’application, vous devez définir le paramètre NotificationMethodsur WINBIO_ASYNC_NOTIFY_MESSAGE. L’infrastructure retourne un pointeur WINBIO_ASYNC_RESULT vers le champ LPARAM du message de fenêtre.

Le tableau de schémas est retourné dans une structure EnumBiometricUnits imbriquée à l’intérieur de la structure WINBIO_ASYNC_RESULT . Vous devez appeler WinBioFree pour libérer la structure WINBIO_ASYNC_RESULT une fois que vous avez terminé de l’utiliser.

L’appel de WinBioAsyncEnumBiometricUnits entraîne l’envoi d’une notification unique à l’application cliente.

Configuration requise


Client minimal pris en charge	Windows 8 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2012 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winbio.h (inclure Winbio.h)
Bibliothèque	Winbio.lib
DLL	Winbio.dll

Voir aussi

WinBioAsyncOpenFramework

Partager via