Edit

PIBIO_SENSOR_QUERY_EXTENDED_INFO_FN callback function (winbio_adapter.h)

  • Article

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

Syntax

PIBIO_SENSOR_QUERY_EXTENDED_INFO_FN PibioSensorQueryExtendedInfoFn;

HRESULT PibioSensorQueryExtendedInfoFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [out]     PWINBIO_EXTENDED_SENSOR_INFO SensorInfo,
  [in]      SIZE_T SensorInfoSize
)
{...}

Parameters

[in, out] Pipeline

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

[out] SensorInfo

Pointer to the WINBIO_EXTENDED_SENSOR_INFO structure that contains the sensor information returned by this function.

[in] SensorInfoSize

The specified size of the sensor 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 SensorInfo parameters cannot be NULL.
E_INVALIDARG
The SensorInfoSize value is less than the size needed to return the sensor 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_SENSOR_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)