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

PIBIO_ENGINE_QUERY_INDEX_VECTOR_SIZE_FN

コールバック

シグネチャ

HRESULT PIBIO_ENGINE_QUERY_INDEX_VECTOR_SIZE_FN(
    WINBIO_PIPELINE* Pipeline,
    UINT_PTR* IndexElementCount
);

パラメーター

フィールド型説明
PipelineWINBIO_PIPELINE*操作を実行するバイオメトリックユニットに関連付けられた WINBIO_PIPELINE 構造体へのポインターです。
IndexElementCountUINT_PTR*インデックスベクター内の配列要素数を受け取る変数のアドレスです。

公式ドキュメント

エンジンアダプターが使用するインデックスベクターのサイズを取得するために、Windows Biometric Framework から呼び出されます。

戻り値

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

戻り値 説明
E_POINTER
必須のポインターパラメーターが NULL です。

解説(Remarks)

インデックスベクターは、使用可能なバイオメトリックテンプレートのインデックスを作成するためにエンジンアダプターが使用します。

例

次の擬似コードは、この関数の実装例の 1 つを示しています。このコードはコンパイルできません。目的に合わせて変更してください。

///////////////////////////////////////////////////////////////////////////////
//
// EngineAdapterQueryIndexVectorSize
//
// 目的:
//      エンジンアダプターが使用するインデックスベクターのサイズを取得するために、
//      Windows Biometric Framework から呼び出されます。
//
// パラメーター:
//      Pipeline            - 操作を実行するバイオメトリックユニットに関連付けられた
//                            WINBIO_PIPELINE 構造体へのポインター。
//      IndexElementCount   - インデックスベクター内の要素数を受け取る変数のアドレス。
//
static HRESULT
WINAPI
EngineAdapterQueryIndexVectorSize(
    __inout PWINBIO_PIPELINE Pipeline,
    __out PSIZE_T IndexElementCount
    )
{
    HRESULT hr = S_OK;

    // ポインター引数が NULL でないことを確認します。
    if (!ARGUMENT_PRESENT(Pipeline) ||
        !ARGUMENT_PRESENT(IndexElementCount))
    {
        hr = E_POINTER;
        goto cleanup;
    }

    // アダプターがサポートするインデックスベクター要素の数を指定します。任意の正の値
    // または 0 を指定できます。テンプレートをバケットに格納する機能をアダプターが
    // サポートしていない場合は 0 を返します。つまり、アダプターがインデックスベクターを
    // サポートしていない場合は 0 を返します。
    *IndexElementCount = NUMBER_OF_TEMPLATE_BINS;

cleanup:

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