PIBIO_SENSOR_CLEAR_CONTEXT_FN

Windows Biometric Framework によって呼び出され、バイオメトリック ユニットの処理パイプラインを新しい操作に向けて準備します。この関数は、センサー コンテキストから一時データをフラッシュし、センサー アダプターを明確に定義された初期状態にする必要があります。

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

SensorAdapterClearContext 関数の実装では、サンプル バッファーをクリアする必要があります。

例

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

//////////////////////////////////////////////////////////////////////////////////////////
//
// SensorAdapterClearContext
//
// 目的:
//      処理パイプラインを新しい操作に向けて準備します。この関数は、
//      センサー コンテキストから一時データをフラッシュし、センサー
//      アダプターを明確に定義された初期状態にする必要があります。
//      
// パラメーター:
//      Pipeline -  バイオメトリック ユニットに関連付けられた
//                  WINBIO_PIPELINE 構造体へのポインター。
//
static HRESULT
WINAPI
SensorAdapterClearContext(
    __inout PWINBIO_PIPELINE Pipeline
    )
{
    // Pipeline パラメーターが NULL でないことを確認します。
    if (!ARGUMENT_PRESENT(Pipeline))
    {
        hr = E_POINTER;
        goto cleanup;
    }

    // パイプラインからコンテキストを取得します。
    PWINBIO_SENSOR_CONTEXT sensorContext = 
        (PWINBIO_SENSOR_CONTEXT)Pipeline->SensorContext;

    // センサーの現在の状態を検証します。
    if (sensorContext == NULL)
    {
        return WINBIO_E_INVALID_DEVICE_STATE;
    }

    // センサー アダプターの状態を変更し、途中まで完了している操作を破棄します。
    // アダプターによっては、状態変数の変更やハードウェアで実装された
    // 動作が必要になる場合があります。次の例では、センサー アダプター
    // コンテキストに ULONG のデータ メンバーと、キャプチャ バッファーおよび
    // 属性バッファーへのポインターが含まれていることを前提としています。

    sensorContext->SomeField = 0L;

    if (sensorContext->CaptureBuffer != NULL)
    {
        // キャプチャ バッファーをゼロで埋めます。
        SecureZeroMemory(
            sensorContext->CaptureBuffer,
            sensorContext->CaptureBufferSize);

        // キャプチャ バッファーを解放します。
        _AdapterRelease(sensorContext->CaptureBuffer);
        sensorContext->CaptureBuffer = NULL;
        sensorContext->CaptureBufferSize = 0;
    }

    if (sensorContext->AttributesBuffer != NULL)
    {
        // 属性バッファーをゼロで埋めます。
        SecureZeroMemory(
            sensorContext->AttributesBuffer,
            sensorContext->AttributesBufferSize);

        // 属性バッファーを解放します。
        _AdapterRelease(sensorContext->AttributesBuffer);
        sensorContext->AttributesBuffer = NULL;
        sensorContext->AttributesBufferSize = 0;
    }

    // TODO: センサー コンテキストのクリアに必要なその他の処理を実行します。

    return S_OK;
}