Skip to content

Latest commit

 

History

History
158 lines (134 loc) · 6.13 KB

nf-winbio-winbioasyncenumbiometricunits.md

File metadata and controls

158 lines (134 loc) · 6.13 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winbio.WinBioAsyncEnumBiometricUnits
WinBioAsyncEnumBiometricUnits function (winbio.h)
Asynchronously enumerates all attached biometric units that match the input factor type.
WinBioAsyncEnumBiometricUnits
WinBioAsyncEnumBiometricUnits function [Windows Biometric Framework API]
secbiomet.winbioasyncenumbiometricunits
winbio/WinBioAsyncEnumBiometricUnits
secbiomet\winbioasyncenumbiometricunits.htm
SecBioMet
3A7CEC71-7352-43B7-83D3-447D487C4703
12/05/2018
WinBioAsyncEnumBiometricUnits, WinBioAsyncEnumBiometricUnits function [Windows Biometric Framework API], secbiomet.winbioasyncenumbiometricunits, winbio/WinBioAsyncEnumBiometricUnits
winbio.h
Winbio.h
Windows
Windows 8 [desktop apps only]
Windows Server 2012 [desktop apps only]
Winbio.lib
Winbio.dll
Windows
19H1
WinBioAsyncEnumBiometricUnits
winbio/WinBioAsyncEnumBiometricUnits
c++
APIRef
kbSyntax
DllExport
Winbio.dll
Ext-MS-Win-BioMetrics-WinBio-Core-l1-1-0.dll
Ext-MS-Win-BioMetrics-WinBio-Core-L1-1-1.dll
WinBioAsyncEnumBiometricUnits

WinBioAsyncEnumBiometricUnits function

-description

Asynchronously enumerates all attached biometric units that match the input factor type. For a synchronous version of this function, see WinBioEnumBiometricUnits. Starting with Windows 10, build 1607, this function is available to use with a mobile image.

-parameters

-param FrameworkHandle [in]

Handle to the framework session opened by calling WinBioAsyncOpenFramework.

-param Factor [in]

A bitmask of WINBIO_BIOMETRIC_TYPE flags that specifies the biometric unit types to be enumerated. Only WINBIO_TYPE_FINGERPRINT is currently supported.

-returns

The function returns an HRESULT indicating success or failure. Note that success indicates only that the arguments were valid. Failures encountered during the execution of the operation will be returned asynchronously to a WINBIO_ASYNC_RESULT structure using the notification method specified in the call to WinBioAsyncOpenFramework.

Return code Description
E_HANDLE
You must set the FrameworkHandle argument.
E_INVALIDARG
The bitmask contained in the Factor parameter contains one or more an invalid type bits.
E_OUTOFMEMORY
There was insufficient memory to complete the request.
WINBIO_E_DISABLED
Current administrative policy prohibits use of the Windows Biometric Framework API.
WINBIO_E_INCORRECT_SESSION_TYPE
The FrameworkHandle argument must represent an asynchronous framework session.
WINBIO_E_SESSION_HANDLE_CLOSED
The session handle has been marked for closure.

-remarks

The WinBioAsyncEnumBiometricUnits function uses a handle to the framework session opened by calling WinBioAsyncOpenFramework. The framework allocates a WINBIO_ASYNC_RESULT structure and uses it to return information about operation success or failure. If the enumeration operation is successful, the framework returns an array of schemas that include information about each enumerated biometric unit. If the operation is unsuccessful, the framework uses the WINBIO_ASYNC_RESULT structure to return error information. The structure is returned to the application callback or to the application message queue, depending on the value you set in the NotificationMethod parameter of the WinBioAsyncOpenFramework function.

  • If you choose to receive completion notices by using a callback, you must implement a PWINBIO_ASYNC_COMPLETION_CALLBACK function and set the NotificationMethod parameter to WINBIO_ASYNC_NOTIFY_CALLBACK.
  • If you choose to receive completion notices by using the application message queue, you must set the NotificationMethod parameter to WINBIO_ASYNC_NOTIFY_MESSAGE. The framework returns a WINBIO_ASYNC_RESULT pointer to the LPARAM field of the window message.
The array of schemas is returned in an EnumBiometricUnits structure nested inside the WINBIO_ASYNC_RESULT structure. You must call WinBioFree to release the WINBIO_ASYNC_RESULT structure after you have finished using it.

Calling WinBioAsyncEnumBiometricUnits causes a single notification to be sent to the client application.

-see-also

WinBioAsyncOpenFramework