PIBIO_SENSOR_DEACTIVATE_FN callback function (winbio_adapter.h)

Article
02/22/2024

Called by the Windows Biometric Framework to give the Sensor Adapter the chance to perform any work needed to put the sensor component into an idle state.

Syntax

PIBIO_SENSOR_DEACTIVATE_FN PibioSensorDeactivateFn;

HRESULT PibioSensorDeactivateFn(
  [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 last client using this biometric unit has closed its session handle.

This method executes in the context of the same thread that activated the biometric unit and that processed all other requests for the unit.

When this routine is called, the Engine and Storage adapters are still available.

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