PIBIO_STORAGE_PIPELINE_CLEANUP_FN callback function (winbio_adapter.h)

Article
02/22/2024

Called by the Windows Biometric Framework to give the Storage Adapter the chance to perform any cleanup in preparation for closing the template database.

Syntax

PIBIO_STORAGE_PIPELINE_CLEANUP_FN PibioStoragePipelineCleanupFn;

HRESULT PibioStoragePipelineCleanupFn(
  [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 once, when a biometric unit is being torn down.

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

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