Win32 API 日本語リファレンス
ホーム › Devices.BiometricFramework › PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN

PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN

コールバック

シグネチャ

HRESULT PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN(
    WINBIO_PIPELINE* Pipeline,
    GUID* FormatArray,
    UINT_PTR FormatArraySize,
    UINT_PTR* FormatCount
);

パラメーター

フィールド型説明
PipelineWINBIO_PIPELINE*操作を実行するバイオメトリックユニットに関連付けられた WINBIO_PIPELINE 構造体へのポインター。
FormatArrayGUID*空の WINBIO_UUID 項目からなる配列のアドレス。SensorAdapterQueryCalibrationFormats メソッドは、Sensor Adapter が認識しているキャリブレーションデータ形式を識別する 1 つ以上の UUID をこの配列に格納することが期待されます。
FormatArraySizeUINT_PTRFormatArray で使用できるスロットの数を示す値。SensorAdapterQueryCalibrationFormats メソッドは、この数を超える要素を FormatArray に書き込もうとしてはなりません。書き込んだ場合、結果は予測できません。
FormatCountUINT_PTR*FormatArray に返された UUID の数を受け取る変数へのポインター。SensorAdapterQueryCalibrationFormats メソッドは、制御を返す前にこの値を設定する必要があります。

公式ドキュメント

Sensor Adapter がサポートするキャリブレーション形式のセットを判別するために、Windows Biometric Framework から呼び出されます。

戻り値

関数が成功した場合は S_OK を返します。関数が失敗した場合は、エラーを示すために次のいずれかの HRESULT 値を返す必要があります。

戻り値 説明
E_NOTIMPL
– Sensor Adapter が動的キャリブレーションをサポートしていません。
E_some_other_error
その他のエラーコードを返した場合、Windows Biometric Framework はそのエラーをログに記録し、バイオメトリックユニットの構成を中止します。

解説(Remarks)

このメソッドは、バイオメトリックユニットの初期構成時に 1 回だけ呼び出されます。

Sensor Adapter がサポートする各キャリブレーション形式は、個別の UUID 値によって識別されます。

このメソッドは、任意の RPC サーバースレッドのコンテキストで実行されます。

Sensor Adapter が動的キャリブレーションをサポートしていない場合は、E_NOTIMPL の値を返してください。Engine Adapter が動的キャリブレーションを必要としない限り、Windows Biometric Framework はこれをエラーとして扱いません。(詳細については、EngineAdapterSelectCalibrationFormat メソッドの説明を参照してください。)

このメソッドが S_OK の値を返す場合は、FormatArray と FormatCount を設定する必要があります。FormatCount が 0 の状態でこのメソッドが S_OK を返すのはエラーです。その場合、Windows Biometric Framework は WINBIO_E_INVALID_CALIBRATION_FORMAT_ARRAY エラーメッセージをログに記録し、バイオメトリックユニットの構成を中止します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)