Edit

Share via

Plug-in Wrapper Functions

  • Article

The Windows Biometric Framework API includes wrapper functions that allow you to call a public function on any adapter attached to the pipeline without manually acquiring a pointer to the adapter. Each wrapper checks the input arguments, retrieves an adapter pointer, and calls the requested function. For example, the WbioEngineSetHashAlgorithm wrapper has the following signature.

inline HRESULT
WbioEngineSetHashAlgorithm(
    __inout PWINBIO_PIPELINE Pipeline,
    __in SIZE_T AlgorithmBufferSize,
    __in PUCHAR AlgorithmBuffer
    )
{
    if (ARGUMENT_PRESENT(Pipeline) &&
        ARGUMENT_PRESENT(Pipeline->EngineInterface) &&
        ARGUMENT_PRESENT(Pipeline->EngineInterface->SetHashAlgorithm))
    {
        return Pipeline->EngineInterface->SetHashAlgorithm(
                                            Pipeline,
                                            AlgorithmBufferSize,
                                            AlgorithmBuffer
                                            );
    }
    else
    {
        return E_NOTIMPL;
    }
}

The function verifies that the Pipeline argument is not NULL, that an engine adapter exists, and that the EngineAdapterSetHashAlgorithm function exists. All wrapper functions are defined in the Winbio_adapter.h header file. The following topics discuss the available wrappers.

In this section

Topic Description
Engine Adapter Wrappers
 Functions that you can use to call functions on your engine adapter. These functions are defined in Winbio_adapter.h.
Sensor Adapter Wrappers
 Functions that you can use to call functions on your sensor adapter. These functions are defined in Winbio_adapter.h.
Storage Adapter Wrappers
 Functions that you can use to call functions on your storage adapter. These functions are defined in Winbio_adapter.h.

Plug-in Reference