PIBIO_ENGINE_SELECT_CALIBRATION_FORMAT_FN callback function (winbio_adapter.h)

Article
10/13/2021

Called by the Windows Biometric Framework to determine which of the Sensor Adapter’s calibration formats the Engine Adapter wants to use.

Syntax

PIBIO_ENGINE_SELECT_CALIBRATION_FORMAT_FN PibioEngineSelectCalibrationFormatFn;

HRESULT PibioEngineSelectCalibrationFormatFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [in]      PWINBIO_UUID FormatArray,
  [in]      SIZE_T FormatCount,
  [out]     PWINBIO_UUID SelectedFormat,
  [out]     PSIZE_T MaxBufferSize
)
{...}

Parameters

[in, out] Pipeline

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

[in] FormatArray

Address of an array of WINBIO_UUID items identifying the calibration data formats supported by the Sensor Adapter. The Engine Adapter is expected to choose one of these formats for its calibration data.

[in] FormatCount

Value indicating the number of UUIDs in the FormatArray parameter.

[out] SelectedFormat

Address of a WINBIO_UUID item where the EngineAdapterSelectCalibrationFormat method will store the UUID of the selected calibration format. This must be one of the UUIDs in the FormatArray parameter.

[out] MaxBufferSize

Address of a variable where the EngineAdapterSelectCalibrationFormat method will store the maximum size (in bytes) of any calibration data it plans to return to the Sensor Adapter. The maximum size of this buffer must be 4096 bytes or less.

Return value

The function will return one of the following HRESULT values.

Return code	Description
S_OK	The operation succeeded. The SelectedFormat and MaxBufferSize return values have both been set.
E_NOTIMPL	The Engine Adapter doesn’t require dynamic calibration. This is not an error condition. The Biometric Service will convert this value to S_OK, and the biometric unit will be configured not to use dynamic calibration.
WINBIO_E_NO_SUPPORTED_CALIBRATION_FORMAT	The Engine Adapter requires dynamic calibration, but doesn’t support any of the calibration formats specified in the FormatArray parameter. (The Engine Adapter should also return this error code if the FormatCount argument is zero.) 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

This method is called once during configuration of the biometric unit. After a calibration format has been selected, it cannot be changed.

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