Skip to content

Latest commit

 

History

History
116 lines (92 loc) · 4.69 KB

nc-winbio_adapter-pibio_sensor_query_calibration_formats_fn.md

File metadata and controls

116 lines (92 loc) · 4.69 KB
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
NC:winbio_adapter.PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN
PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN (winbio_adapter.h)
Determines the set of calibration formats supported by the Sensor Adapter.
PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN
PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN callback
SensorAdapterQueryCalibrationFormats
SensorAdapterQueryCalibrationFormats callback function [Windows Biometric Framework API]
secbiomet.sensoradapterquerycalibrationformats
winbio_adapter/SensorAdapterQueryCalibrationFormats
secbiomet\sensoradapterquerycalibrationformats.htm
SecBioMet
F8C97013-3BDA-445F-A2C2-60D08DD9C71A
12/05/2018
PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN, PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN callback, SensorAdapterQueryCalibrationFormats, SensorAdapterQueryCalibrationFormats callback function [Windows Biometric Framework API], secbiomet.sensoradapterquerycalibrationformats, winbio_adapter/SensorAdapterQueryCalibrationFormats
winbio_adapter.h
Winbio_adapter.h
Windows
Windows 10 [desktop apps only]
Windows Server 2016 [desktop apps only]
Windows
19H1
PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN
winbio_adapter/PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN
c++
APIRef
kbSyntax
UserDefined
Winbio_adapter.h
SensorAdapterQueryCalibrationFormats

PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN callback function

-description

Called by the Windows Biometric Framework to determine the set of calibration formats supported by the Sensor Adapter.

-parameters

-param Pipeline [in, out]

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

-param FormatArray [out]

Address of an array of empty WINBIO_UUID items. The SensorAdapterQueryCalibrationFormats method is expected to fill this array with one or more UUIDs identifying the calibration data formats known to the Sensor Adapter.

-param FormatArraySize [in]

A value indicating the number of slots available in FormatArray. The SensorAdapterQueryCalibrationFormats method must not attempt to write more than this number of elements into FormatArray, or the results will be unpredictable.

-param FormatCount [out]

Pointer to a variable that receives the number UUIDs returned in FormatArray. The SensorAdapterQueryCalibrationFormats method must set this value before returning.

-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_NOTIMPL
– The Sensor Adapter doesn’t support dynamic calibration.
E_some_other_error
Any other error code will cause the Windows Biometric Framework to log the error and abort the configuration of the biometric unit.

-remarks

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

Each calibration format supported by the Sensor Adapter is identified by a separate UUID value.

This method executes in the context of an arbitrary RPC server thread.

If the Sensor Adapter doesn’t support dynamic calibration, it should return a value of E_NOTIMPL. The Windows Biometric Framework will not treat this as an error unless the Engine Adapter requires dynamic calibration. (For details, see the description of the EngineAdapterSelectCalibrationFormat method.)

If this method returns a value of S_OK, FormatArray and FormatCount must be set. It is an error for this method to return S_OK along with a zero value for FormatCount. Doing so will cause the Windows Biometric Framework to log a WINBIO_E_INVALID_CALIBRATION_FORMAT_ARRAY error message and abort the configuration of the biometric unit.