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

PIBIO_ENGINE_QUERY_CALIBRATION_DATA_FN

コールバック

シグネチャ

HRESULT PIBIO_ENGINE_QUERY_CALIBRATION_DATA_FN(
    WINBIO_PIPELINE* Pipeline,
    BOOLEAN* DiscardAndRepeatCapture,
    BYTE* CalibrationBuffer,
    UINT_PTR* CalibrationBufferSize,
    UINT_PTR MaxBufferSize
);

パラメーター

フィールド型説明
PipelineWINBIO_PIPELINE*操作を実行するバイオメトリックユニットに関連付けられた WINBIO_PIPELINE 構造体へのポインター。
DiscardAndRepeatCaptureBOOLEAN*

EngineAdapterQueryCalibrationData メソッドで設定する必要があるブール値のアドレス。この値は、キャリブレーションの完了後に現在のサンプルをバイオメトリックサービスがどのように扱うべきかを示します。

  • TRUE は、キャプチャされたバイオメトリックサンプルが使用できないことを示します。バイオメトリックサービスはそのサンプルを破棄し、新しいサンプルを取得します。
  • FALSE は、サンプルが使用可能であり、エンジンに対してそのサンプルへのさらなる処理を実行するよう指示すべきであることを示します。
CalibrationBufferBYTE*メソッドがキャリブレーションデータを書き込むことを期待される空のバッファーのアドレス。このバッファーを保持するメモリはバイオメトリックサービスに属しており、エンジンアダプターは EngineAdapterQueryCalibrationData メソッドが復帰した後に、このバッファーへのポインターを保持してはなりません。
CalibrationBufferSizeUINT_PTR*

EngineAdapterQueryCalibrationData メソッドが CalibrationBuffer に書き込んだキャリブレーションデータのサイズ (バイト単位) を格納する変数のアドレス。この値は MaxBufferSize を超えてはなりません。

EngineAdapterQueryCalibrationData がこの値を 0 に設定した場合、CalibrationBuffer の内容はセンサーアダプターに送信されずに破棄されます。これはエラー状態ではなく、現在のキャプチャデータに基づいてセンサーのキャリブレーションを更新する必要がエンジンアダプターにないことを示しているにすぎません。

MaxBufferSizeUINT_PTRCalibrationBuffer においてエンジンアダプターが使用できる最大の領域 (バイト単位) を示す値。

公式ドキュメント

エンジンアダプターからキャプチャ後のキャリブレーションデータのセットを取得するために、Windows Biometric Framework によって呼び出されます。

戻り値

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

戻り値 説明
E_some_error
いずれのエラーコードでも、バイオメトリックサービスは動的キャリブレーションループを中止し、キャプチャ操作を中断します。

解説(Remarks)

EngineAdapterQueryCalibrationData メソッドは、DiscardAndRepeatCapture と CalibrationBufferSize をそれぞれ設定することにより、バイオメトリックサービスの再キャプチャ動作とキャリブレーション動作を個別に制御できます。

目的の動作 DiscardAndRepeatCapture CalibrationBufferSize
キャリブレーション後にキャプチャを繰り返す。 TRUE 0 以外
キャリブレーションを行わずにキャプチャを繰り返す。 TRUE 0
キャリブレーション後にサンプルの処理を続行する。 FALSE 0 以外
キャリブレーションを行わずにサンプルの処理を続行する。 FALSE 0
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)