Edit

PIBIO_SENSOR_SET_CALIBRATION_FORMAT_FN callback function (winbio_adapter.h)

  • Article

Called by the Windows Biometric Framework to notify the sensor adapter that a particular calibration data format has been selected by the engine adapter.

Syntax

PIBIO_SENSOR_SET_CALIBRATION_FORMAT_FN PibioSensorSetCalibrationFormatFn;

HRESULT PibioSensorSetCalibrationFormatFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [in]      PWINBIO_UUID Format
)
{...}

Parameters

[in, out] Pipeline

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

[in] Format

Address of a WINBIO_UUID identifying the calibration data format selected by the Engine Adapter.

Return value

The function will return one of the following HRESULT values.

Return code Description
S_OK
The operation succeeded.
E_NOTIMPL
The Sensor Adapter doesn’t support dynamic calibration. This is only treated as an error if the SensorAdapterQueryCalibrationFormats method has previously indicated that the adapter supports dynamic calibration.
WINBIO_E_UNSUPPORTED_SENSOR_CALIBRATION_FORMAT
The UUID specified in the Format parameter is not one of the ones supported by the Sensor Adapter. This error code will cause the Biometric Service to log the error and abort the configuration of the biometric unit.
E_some_other_error
Any other error code will cause the Biometric Service to log the error and abort the configuration of the biometric unit.

Remarks

The Sensor Adapter should store a copy of this UUID value for later use in interpreting the contents of any calibration buffers sent to its SensorAdapterAcceptCalibrationData method.

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)