コールバック関数PIBIO_ENGINE_ATTACH_FN (winbio_adapter.h)
エンジン アダプターが生体認証ユニットの処理パイプラインに追加されるときに、Windows 生体認証フレームワークによって呼び出されます。 この関数の目的は、後の生体認証操作に必要な初期化を実行することです。
構文
PIBIO_ENGINE_ATTACH_FN PibioEngineAttachFn;
HRESULT PibioEngineAttachFn(
[in, out] PWINBIO_PIPELINE Pipeline
)
{...}
パラメーター
[in, out] Pipeline
操作を実行する生体認証ユニットに関連付けられている WINBIO_PIPELINE 構造体へのポインター。
戻り値
関数が成功した場合は、S_OK を返します。 関数が失敗した場合は、エラーを示すために次のいずれかの HRESULT 値を返す必要があります。
| リターン コード | 説明 |
|---|---|
|
Pipeline 引数に NULL を指定することはできません。 |
|
メモリ不足のため、操作を完了できませんでした。 |
|
Pipeline 引数が指すWINBIO_PIPELINE構造体の EngineContext メンバーが NULL ではないか、EngineHandle メンバーが INVALID_HANDLE_VALUE に設定されていません。 |
解説
この関数は、生体認証ユニットのストレージ アダプターが初期化される前に呼び出されます。 したがって、この関数は、パイプライン オブジェクトの StorageInterface メンバーが指すWINBIO_STORAGE_INTERFACE構造体によって参照される関数を呼び出してはなりません。
この関数を実装する場合は、アダプターに必要なリソースを割り当てて管理し、生体認証ユニット パイプラインにアタッチする必要があります。 これを行うには、ヒープにプライベート WINBIO_ENGINE_CONTEXT 構造体を割り当てて初期化し、パイプライン オブジェクトの EngineContext メンバーでそのアドレスを設定します。
この関数で使用されるエンジン アダプター リソースの作成と初期化中にエラーが発生した場合は、戻る前に必要なクリーンアップを実行する必要があります。
この関数の呼び出し時に EngineContext フィールドが NULL でない場合、パイプラインは正しく初期化されていないため、Windows 生体認証フレームワークに問題を通知するには 、WINBIO_E_INVALID_DEVICE_STATE を返す必要があります。
同様に、この関数の呼び出し時に EngineHandle フィールドに INVALID_HANDLE_VALUE が含まれていない場合は、 WINBIO_E_INVALID_DEVICE_STATEを返す必要があります。
例
次の擬似コードは、この関数の 1 つの可能な実装を示しています。 この例はコンパイルされません。 目的に合わせて調整する必要があります。
//////////////////////////////////////////////////////////////////////////////////////////
//
// EngineAdapterAttach
//
// Purpose:
// Performs any initialization required for later biometric operations.
//
// Parameters:
// Pipeline - Pointer to a WINBIO_PIPELINE structure associated with
// the biometric unit performing the operation.
//
static HRESULT
WINAPI
EngineAdapterAttach(
__inout PWINBIO_PIPELINE Pipeline
)
{
HRESULT hr = S_OK;
// 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 newContext = NULL;
// Call a custom function (_AdapterAlloc) to allocate memory to hold the
// engine adapter context.
newContext = (PWINBIO_ENGINE_CONTEXT)_AdapterAlloc(sizeof(WINBIO_ENGINE_CONTEXT));
if (newContext == NULL)
{
E_OUTOFMEMORY;
goto cleanup;
}
// Clear the context memory.
ZeroMemory(newContext, sizeof(WINBIO_ENGINE_CONTEXT));
// Initialize any required context fields.
newContext->SomeField = SomeSpecialValue;
newContext->SomePointerField = _AdapterAlloc(sizeof(SOME_STRUCTURE));
if (newContext->SomePointerField == NULL)
{
E_OUTOFMEMORY;
goto cleanup;
}
// If your adapter supports software-based template hashing, implement the
// following custom function to open a SHA1 hash object handle and store
// the handle in the adapter context. Use Cryptography Next Generation (CNG)
// functions to create the SHA1 hash object.
hr = _AdapterInitializeCrypto(newContext);
if (FAILED(hr))
{
goto cleanup;
}
// If initialization completes successfully, attach the engine context to the
// processing pipeline of the biometric unit.
Pipeline->EngineContext = newContext;
newContext = NULL;
cleanup:
if (FAILED(hr))
{
// If a new context has been created, release any memory
// pointed to by various data members in the context and
// then release the context. The following example assumes
// that your adapter contains a handle
// for a hash object and a pointer to another object.
if (newContext != NULL)
{
// Close any open CNG handles and release the hash object memory.
_AdapterCleanupCrypto(newContext);
// Release any other object pointed to by the context.
if (newContext->SomePointerField != NULL)
{
_AdapterRelease(newContext->SomePointerField);
}
// Release the context
_AdapterRelease(newContext);
}
}
return hr;
}
要件
| サポートされている最小のクライアント | Windows 7 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 R2 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winbio_adapter.h (Winbio_adapter.h を含む) |