PIBIO_SENSOR_ATTACH_FN コールバック関数 (winbio_adapter.h)

[アーティクル]
03/03/2024

センサーアダプターが生体認証ユニットの処理パイプラインに追加されたときに、Windows 生体認証フレームワークによって呼び出されます。この関数の目的は、後の生体認証操作に必要な初期化を実行することです。

構文

PIBIO_SENSOR_ATTACH_FN PibioSensorAttachFn;

HRESULT PibioSensorAttachFn(
  [in, out] PWINBIO_PIPELINE Pipeline
)
{...}

パラメーター

[in, out] Pipeline

操作を実行する生体認証ユニットに関連付けられている WINBIO_PIPELINE 構造体へのポインター。

戻り値

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

リターンコード	説明
E_POINTER	Pipeline 引数に NULL を指定することはできません。
E_OUTOFMEMORY	メモリ不足のため、操作を完了できませんでした。
WINBIO_E_INVALID_DEVICE_STATE	Pipeline 引数が指すWINBIO_PIPELINE構造体の SensorContext メンバーが NULL ではありません。

注釈

この関数は、生体認証ユニットに対してエンジンとストレージアダプターが初期化される前に呼び出されます。したがって、この関数は、パイプラインオブジェクトのEngineInterface メンバーと StorageInterface メンバーが指すWINBIO_ENGINE_INTERFACEまたはWINBIO_STORAGE_INTERFACE構造体によって参照される関数を呼び出してはなりません。

WINBIO_PIPELINE構造体の SensorHandle メンバーには、このメソッドが呼び出される前に有効なハンドルが含まれるため、SensorAdapterAttach の実装では、ハンドルを使用して、必要に応じてセンサーデバイスにアクセスできます。

この関数を実装する場合は、アダプターに必要なリソースを割り当てて管理し、生体認証ユニットパイプラインにアタッチする必要があります。これを行うには、ヒープにプライベート WINBIO_SENSOR_CONTEXT 構造体を割り当てて初期化し、パイプラインオブジェクトの SensorContext メンバーでそのアドレスを設定します。

この関数で使用されるエンジンアダプターリソースの作成と初期化中にエラーが発生した場合は、戻る前に必要なクリーンアップを実行する必要があります。

この関数の呼び出し時に SensorContext フィールドが NULL でない場合、 SensorAdapterDetach の以前の呼び出しによってパイプラインが正しくリセットされず、Windows 生体認証フレームワークに問題を通知するために WINBIO_E_INVALID_DEVICE_STATE を返す必要があります。

例

次の擬似コードは、この関数の 1 つの可能な実装を示しています。この例はコンパイルされません。目的に合わせて調整する必要があります。

//////////////////////////////////////////////////////////////////////////////////////////
//
// SensorAdapterAttach
//
// 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
SensorAdapterAttach(
    __inout PWINBIO_PIPELINE Pipeline
    )
{
    HRESULT hr = S_OK;
    PWINBIO_SENSOR_CONTEXT newContext = NULL;

    // Verify that the Pipeline parameter is not NULL.
    if (!ARGUMENT_PRESENT(Pipeline))
    {
        hr = E_POINTER;
        goto cleanup;
    }

    // Validate the current sensor state.
    if (Pipeline->SensorContext != NULL)
    {
        hr = WINBIO_E_INVALID_DEVICE_STATE;
        goto cleanup;
    }

    // Use a custom function (_AdapterAlloc) to allocate memory for the 
    // sensor adapter context.
    newContext = (PWINBIO_SENSOR_CONTEXT)_AdapterAlloc(sizeof(WINBIO_SENSOR_CONTEXT));
    if (newContext == NULL)
    {
        hr = E_OUTOFMEMORY;
        goto cleanup;
    }

    // Create a manual reset event to monitor overlapped I/O.
    newContext->Overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
    if (newContext->Overlapped.hEvent == NULL)
    {
        hr = E_OUTOFMEMORY;
        goto cleanup;
    }

    // Initialize any required context fields. This example assumes that your
    // sensor context points to a capture buffer and an attributes buffer.
    newContext->CaptureBuffer = NULL;
    newContext->CaptureBufferSize = 0;

    newContext->AttributesBuffer = NULL;
    newContext->AttributesBufferSize = sizeof (WINBIO_SENSOR_ATTRIBUTES);

    // Transfer ownership of the new sensor context structure to the 
    // pipeline.
    Pipeline->SensorContext = newContext;
    newContext = NULL;

cleanup:

    if (FAILED(hr) && newContext != NULL)
    {
        CloseHandle( newContext->Overlapped.hEvent;
        _AdapterRelease( newContext );
        newContext = NULL;
    }
    return hr;
}

要件

要件	値
サポートされている最小のクライアント	Windows 7 [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 R2 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winbio_adapter.h (Winbio_adapter.h を含む)