PIBIO_ENGINE_ACTIVATE_FN callback function (winbio_adapter.h)

Article
02/22/2024

Called by the Windows Biometric Framework to give the Engine Adapter the chance to perform any work needed to bring the sensor component out of an idle state.

Syntax

PIBIO_ENGINE_ACTIVATE_FN PibioEngineActivateFn;

HRESULT PibioEngineActivateFn(
  [in, out] PWINBIO_PIPELINE Pipeline
)
{...}

Parameters

[in, out] Pipeline

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

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

This method is called when the first client session opens a handle to an inactive biometric unit.

The Storage adapter has been activated when this method is called.

Returning any HRESULT other than S_OK will cause the Windows Biometric Framework to log the error and abort the activation of the biometric unit.

This method executes in the context of the sensor control thread that will process all other requests for the unit, including deactivation.

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