ホーム › Devices.BiometricFramework › PIBIO_ENGINE_QUERY_PREFERRED_FORMAT_FN
PIBIO_ENGINE_QUERY_PREFERRED_FORMAT_FN
コールバックシグネチャ
HRESULT PIBIO_ENGINE_QUERY_PREFERRED_FORMAT_FN(
WINBIO_PIPELINE* Pipeline,
WINBIO_REGISTERED_FORMAT* StandardFormat,
GUID* VendorFormat
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| Pipeline | WINBIO_PIPELINE* | 操作を実行するバイオメトリックユニットに関連付けられた WINBIO_PIPELINE 構造体へのポインターです。 |
| StandardFormat | WINBIO_REGISTERED_FORMAT* | WINBIO_BIR オブジェクトの StandardDataBlock メンバーに格納されるデータの形式を指定する WINBIO_REGISTERED_FORMAT 構造体へのポインターです。この形式は、IBIA に登録された名前と値のペアです。 |
| VendorFormat | GUID* | WINBIO_BIR オブジェクトの VendorDataBlock メンバーに格納されるデータの、ベンダー定義の形式を受け取る GUID へのポインターです。 |
公式ドキュメント
エンジンアダプターが優先する入力データ形式を判別するために、バイオメトリックユニット上のセンサーアダプターから呼び出されます。
戻り値
関数が成功した場合は S_OK を返します。関数が失敗した場合は、エラーを示す次の HRESULT 値のいずれかを返す必要があります。
| 戻り値 | 説明 |
|---|---|
| 必須のポインターパラメーターが NULL です。 |
解説(Remarks)
センサーアダプターは、バイオメトリックキャプチャの形式を判別するために、この関数を呼び出します。
例
次の擬似コードは、この関数の実装例の 1 つを示しています。このコードはそのままではコンパイルできません。目的に合わせて調整する必要があります。
//////////////////////////////////////////////////////////////////////////////////////////
//
// EngineAdapterQueryPreferredFormat
//
// Purpose:
// Called by the sensor adapter on the biometric unit to determine the
// input data format preferred by the engine adapter.
//
// Parameters:
// Pipeline - Pointer to a WINBIO_PIPELINE structure associated
// with the biometric unit performing the operation.
// StandardFormat - Pointer to a WINBIO_REGISTERED_FORMAT structure
// that specifies the format of the data in the
// StandardDataBlock member of the WINBIO_BIR object.
// The format is an IBIA-registered name/value pair.
// VendorFormat - Pointer to a GUID that receives the vendor-defined
// format of the data in the VendorDataBlock member of
// the WINBIO_BIR object.
//
static HRESULT
WINAPI
EngineAdapterQueryPreferredFormat(
__inout PWINBIO_PIPELINE Pipeline,
__out PWINBIO_REGISTERED_FORMAT StandardFormat,
__out PWINBIO_UUID VendorFormat
)
{
HRESULT hr = S_OK;
// Verify that pointer arguments are not NULL.
if (!ARGUMENT_PRESENT(Pipeline) ||
!ARGUMENT_PRESENT(StandardFormat) ||
!ARGUMENT_PRESENT(VendorFormat))
{
hr = E_POINTER;
goto cleanup;
}
// Specify the preferred data formats.
StandardFormat->Owner = WINBIO_ANSI_381_FORMAT_OWNER;
StandardFormat->Type = WINBIO_ANSI_381_FORMAT_TYPE;
*VendorFormat = VENDOR_UUID_VALUE;
cleanup:
return hr;
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)