PIBIO_ENGINE_CLEAR_CONTEXT_FN コールバック関数 (winbio_adapter.h)
新しい操作のために生体認証ユニットの処理パイプラインを準備するために、Windows 生体認証フレームワークによって呼び出されます。 この関数は、エンジン コンテキストから一時データをフラッシュし、エンジン アダプターを明確に定義された初期状態にする必要があります。
構文
PIBIO_ENGINE_CLEAR_CONTEXT_FN PibioEngineClearContextFn;
HRESULT PibioEngineClearContextFn(
[in, out] PWINBIO_PIPELINE Pipeline
)
{...}
パラメーター
[in, out] Pipeline
操作を実行する生体認証ユニットに関連付けられている WINBIO_PIPELINE 構造体へのポインター。
戻り値
関数が成功した場合は、S_OK を返します。 関数が失敗した場合は、次のいずれかの HRESULT 値を返してエラーを示す必要があります。
| リターン コード | 説明 |
|---|---|
|
Pipeline 引数を NULL にすることはできません。 |
注釈
この関数のこの目的は、 EngineAdapterAttach 関数の呼び出し直後の状態にコンテキストをリセットすることです。 コンテキストは再利用可能な構造体です。 EngineAdapterClearContext 関数はコンテキストを再初期化しますが、パイプラインから削除することはありません。
クリアする必要があるエンジン アダプター コンテキスト領域のオブジェクトの一般的な例を次に示します。
| Object | 説明 |
|---|---|
| 機能セット | 生体認証サンプルの説明が含まれています |
| 加入 | 登録トランザクションの現在の状態を追跡します。 |
| Template | 機能セットまたは登録オブジェクトによって作成された生体認証テンプレート。 |
| 比較 | テンプレートと機能セットの比較結果を格納します。 |
| インデックス ベクター | テンプレートに関連付けられているインデックス値のセットが含まれます。 |
例
次の擬似コードは、この関数の 1 つの可能な実装を示しています。 この例はコンパイルされません。 目的に合わせて調整する必要があります。
//////////////////////////////////////////////////////////////////////////////////////////
//
// EngineAdapterClearContext
//
// Purpose:
// Prepares the processing pipeline of the biometric unit for a
// new operation.
//
// Parameters:
// Pipeline - Pointer to a WINBIO_PIPELINE structure associated with
// the biometric unit.
//
static HRESULT
WINAPI
EngineAdapterClearContext(
__inout PWINBIO_PIPELINE Pipeline
)
{
// Verify that the Pipeline parameter is not NULL.
if (!ARGUMENT_PRESENT(Pipeline))
{
hr = E_POINTER;
goto cleanup;
}
// Retrieve the context from the pipeline.
PWINBIO_ENGINE_CONTEXT context =
(PWINBIO_ENGINE_CONTEXT)Pipeline->EngineContext;
if (context == NULL)
{
goto cleanup;
}
// Change the engine adapter state and discard any partially completed
// operations. Depending on the adapter, this can involve changes to state
// variables or actions implemented in hardware. The following example
// assumes that your engine adapter context contains a ULONG data member
// and pointers to a feature set and an enrollment object.
context->SomeField = 0L;
if (context->FeatureSet != NULL)
{
// Zero the feature set if it contains unencrypted biometric data.
SecureZeroMemory(
context->FeatureSet,
context->FeatureSetSize);
// Release the feature set.
_AdapterRelease(context->FeatureSet);
context->FeatureSet = NULL;
context->FeatureSetSize = 0;
}
if (context->Enrollment.Template != NULL)
{
// Zero the template if it contains unencrypted biometric data.
SecureZeroMemory(
context->Enrollment.Template,
context->Enrollment.TemplateSize);
// Release the template.
_AdapterRelease(context->Enrollment.Template);
context->Enrollment.Template = NULL;
context->Enrollment.TemplateSize = 0;
// Release other data members attached to the enrollment object.
context->Enrollment.SampleCount = 0;
context->Enrollment.InProgress = FALSE;
}
cleanup:
return S_OK;
}
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 7 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 R2 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winbio_adapter.h (Winbio_adapter.h を含む) |