PIBIO_ENGINE_QUERY_EXTENDED_INFO_FN callback function (winbio_adapter.h)

Article
2024-02-22

Called by the Windows Biometric Framework to determine the capabilities and limitations of the biometric engine component.

Syntax

PIBIO_ENGINE_QUERY_EXTENDED_INFO_FN PibioEngineQueryExtendedInfoFn;

HRESULT PibioEngineQueryExtendedInfoFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [out]     PWINBIO_EXTENDED_ENGINE_INFO EngineInfo,
  [in]      SIZE_T EngineInfoSize
)
{...}

Parameters

[in, out] Pipeline

Pointer to the WINBIO_PIPELINE structure associated with the biometric unit performing the operation.

[out] EngineInfo

Pointer to the WINBIO_EXTENDED_ENGINE_INFO structure that contains the engine information returned by this function.

[in] EngineInfoSize

The specified size in bytes of the engine information.

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 and EngineInfo parameters cannot be NULL.
E_INVALIDARG	The EngineInfoSize value is less than the size needed to return the engine information.

Remarks

This method is called once during configuration of the biometric unit.

It will also be called if a client application uses the WinBioGetProperty function to query the value of the WINBIO_PROPERTY_EXTENDED_ENGINE_INFO property.

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