Client Application Functions

The following functions are supported for client application development by the Windows Biometric Framework API.

In this section

Topic	Description
WinBioAcquireFocus	Acquires window focus.
WinBioAsyncEnumBiometricUnits	Asynchronously enumerates all attached biometric units that match the input factor type.
WinBioAsyncEnumDatabases	Asynchronously enumerates all registered databases that match a specified type.
WinBioAsyncEnumServiceProviders	Asynchronously returns information about installed biometric service providers. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioAsyncMonitorFrameworkChanges	Starts an asynchronous monitor of changes to the biometric framework.
WinBioAsyncOpenFramework	Opens a handle to the biometric framework. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioAsyncOpenSession	Asynchronously connects to a biometric service provider and one or more biometric units. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioCancel	Cancels all pending biometric operations for a specified session. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioCaptureSample	Captures a biometric sample and fills a biometric information record (BIR) with the raw or processed data.
WinBioCaptureSampleWithCallback	Captures a biometric sample asynchronously and returns the raw or processed data in a biometric information record (BIR).
WinBioCloseFramework	Closes a framework handle previously opened with WinBioAsyncOpenFramework. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioCloseSession	Closes a biometric session and releases associated resources. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioControlUnit	Allows the caller to perform vendor-defined control operations on a biometric unit. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioControlUnitPrivileged	Allows the caller to perform privileged vendor-defined control operations on a biometric unit. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioDeleteTemplate	Deletes a biometric template from the template store. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioEnrollBegin	Initiates a biometric enrollment sequence and creates an empty biometric template. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioEnrollCapture	Captures a biometric sample and adds it to a template. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioEnrollCaptureWithCallback	Asynchronously captures a biometric sample and adds it to a template.
WinBioEnrollCommit	Finalizes a pending biometric template and saves it to the database associated with the biometric unit used for enrollment. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioEnrollDiscard	Ends the enrollment sequence and discards a pending biometric template. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioEnrollSelect	Specifies the individual that you want to enroll when data that represents multiple individuals is present in the sample buffer. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioEnumBiometricUnits	Enumerates all attached biometric units that match the input type.
WinBioEnumDatabases	Enumerates all registered databases that match a specified type.
WinBioEnumEnrollments	Retrieves the biometric sub-factors enrolled for a specified identity and biometric unit. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioEnumServiceProviders	Retrieves information about installed biometric service providers. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioFree	Releases memory allocated for the client application by an earlier call to a Windows Biometric Framework API function. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioGetCredentialState	Retrieves a value that specifies whether credentials have been set for the specified user. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioGetDomainLogonSetting	Retrieves a value that specifies whether users can log on to a domain by using biometric information.
WinBioGetEnabledSetting	Retrieves a value that specifies whether the Windows Biometric Framework is currently enabled.
WinBioGetEnrolledFactors	Gets information about the biometric enrollments that the specified user has on the computer.
WinBioGetLogonSetting	Retrieves a value that indicates whether users can log on by using biometric information.
WinBioGetProperty	Retrieves a session, unit, or template property. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioIdentify	Captures a biometric sample and determines whether it matches an existing biometric template. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioIdentifyWithCallback	Asynchronously captures a biometric sample and determines whether it matches an existing biometric template.
WinBioLocateSensor	Retrieves the ID number of a biometric unit selected interactively by a user.
WinBioLocateSensorWithCallback	Asynchronously retrieves the ID number of the biometric unit selected interactively by a user.
WinBioLockUnit	Locks a biometric unit for exclusive use by a single session. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioLogonIdentifiedUser	causes a fast user switch to the account associated with the last successful identification operation performed by the biometric session.
WinBioMonitorPresence	Turns on the face-recognition or iris-monitoring mechanism for the specified biometric unit. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioOpenSession	Connects to a biometric service provider and one or more biometric units.
WinBioRegisterEventMonitor	Registers a callback function to receive event notifications from the service provider associated with an open session.
WinBioReleaseFocus	Releases window focus.
WinBioRemoveAllCredentials	Removes all credentials from the store. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioRemoveAllDomainCredentials	Removes all user credentials for the current domain from the store. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioRemoveCredential	Deletes a biometric logon credential for a specified user. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioSetCredential	Saves a biometric logon credential for the current user. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioSetProperty	Sets the value of a standard property associated with a biometric session, unit, template, or account. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioUnlockUnit	Releases the session lock on the specified biometric unit.
WinBioUnregisterEventMonitor	cancels event notifications from the service provider associated with an open biometric session.
WinBioVerify	Captures a biometric sample and determines whether the sample corresponds to the specified user identity. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
WinBioVerifyWithCallback	Asynchronously captures a biometric sample and determines whether the sample corresponds to the specified user identity.
WinBioWait	Blocks caller execution until all pending biometric operations for a session have been completed or canceled. Starting with Windows 10, build 1607, this function is available to use with a mobile image.

Related topics

Client Application Reference