PIBIO_SENSOR_PIPELINE_CLEANUP_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 cleanup in that requires help from the Engine or Storage adapter components.

Syntax

PIBIO_SENSOR_PIPELINE_CLEANUP_FN PibioSensorPipelineCleanupFn;

HRESULT PibioSensorPipelineCleanupFn(
  [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

The Sensor Adapter should return S_OK if it doesn’t need to perform any cleanup at this point.

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

This method executes in the context of an arbitrary RPC server thread.

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