nf-winbio_adapter-wbioqueryengineinterface.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:winbio_adapter.WbioQueryEngineInterface	WbioQueryEngineInterface function (winbio_adapter.h)	Retrieves a pointer to the WINBIO_ENGINE_INTERFACE structure for the engine adapter.	WbioQueryEngineInterface WbioQueryEngineInterface function [Windows Biometric Framework API] secbiomet.wbioqueryengineinterface winbio_adapter/WbioQueryEngineInterface	secbiomet\wbioqueryengineinterface.htm	SecBioMet	d98da825-ce27-41ec-8f82-6f44e4854018	12/05/2018	WbioQueryEngineInterface, WbioQueryEngineInterface function [Windows Biometric Framework API], secbiomet.wbioqueryengineinterface, winbio_adapter/WbioQueryEngineInterface	winbio_adapter.h	Winbio_adapter.h	Windows	Windows 7 [desktop apps only]	Windows Server 2008 R2 [desktop apps only]													Windows			19H1	WbioQueryEngineInterface winbio_adapter/WbioQueryEngineInterface	c++	APIRef kbSyntax	HeaderDef	Winbio_adapter.h	WbioQueryEngineInterface

WbioQueryEngineInterface function

-description

Retrieves a pointer to the WINBIO_ENGINE_INTERFACE structure for the engine adapter.

-parameters

-param EngineInterface [out]

Address of a variable that receives a pointer to the WINBIO_ENGINE_INTERFACE structure.

-returns

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 EngineInterface parameter cannot be NULL.

-remarks

The Windows Biometric Framework calls this function after loading an engine adapter DLL into memory. Every engine adapter DLL must therefore implement and export the WbioQueryEngineInterface function. The function name is case-sensitive, and its spelling and signature must exactly match that provided in the Syntax section.

To be visible to the Windows Biometric Framework, the WbioQueryEngineInterface function must be named in the EXPORTS section of the export definition linker command file for the DLL.

Examples

The following pseudocode shows one possible implementation of this function.

HRESULT
WINAPI
WbioQueryEngineInterface(
    __out PWINBIO_ENGINE_INTERFACE *EngineInterface)
{
    // g_EngineInterface is a global variable.
    *EngineInterface = &g_EngineInterface;
    return S_OK;
}

-see-also

Plug-in Functions