PIBIO_ENGINE_SET_ENROLLMENT_SELECTOR_FN callback function (winbio_adapter.h)

Article
02/22/2024

Called by the Windows Biometric Framework to tell the Engine Adapter which person to track for the current enrollment operation.

Syntax

PIBIO_ENGINE_SET_ENROLLMENT_SELECTOR_FN PibioEngineSetEnrollmentSelectorFn;

HRESULT PibioEngineSetEnrollmentSelectorFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [in]      ULONGLONG SelectorValue
)
{...}

Parameters

[in, out] Pipeline

Pointer to the WINBIO_PIPELINE structure associated with the biometric unit performing the operation.

[in] SelectorValue

The enrollment selector value to use.

Return value

If the function succeeds, it returns S_OK. If the function fails, it must return one of the following HRESULT values to indicate the error.

Return code	Description
E_POINTER	The Pipeline parameter cannot be NULL.

Remarks

For some biometric factors (such as WINBIO_TYPE_FACIAL_FEATURES), there can be multiple people in camera frame at the same time. During an enrollment operation, it’s necessary for the enrollment application to select one specific person to enroll. The enrollment application does this by calling the WinBioEnrollSelect function. The Windows Biometric Framework then calls the engine adapter’s EngineAdapterSetEnrollmentSelector function with this information.

The engine adapter should store this value and use it to track the proper person during the course of the enrollment.

Requirements

Requirement	Value
Minimum supported client	Windows 10 [desktop apps only]
Minimum supported server	Windows Server 2016 [desktop apps only]
Target Platform	Windows
Header	winbio_adapter.h (include Winbio_adapter.h)

Share via