PIBIO_ENGINE_DISCARD_ENROLLMENT_FN

Windows Biometric Framework によって呼び出され、中間的な登録状態情報をパイプラインから削除します。

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

この関数の実装では、バイオメトリックユニットデータベースに情報を保存しないでください。

例

次の疑似コードは、この関数の実装方法の一例を示しています。この例はそのままではコンパイルできません。目的に合わせて調整してください。

//////////////////////////////////////////////////////////////////////////////////////////
//
// EngineAdapterDiscardEnrollment
//
// 目的:
//      中間的な登録状態情報をパイプラインから削除します。
//
// パラメーター:
//      Pipeline  - 操作を実行するバイオメトリックユニットに
//                  関連付けられた WINBIO_PIPELINE 構造体へのポインター
// 
static HRESULT
WINAPI
EngineAdapterDiscardEnrollment(
    __inout PWINBIO_PIPELINE Pipeline
    )
{
    HRESULT hr = S_OK;

    // Pipeline パラメーターが NULL でないことを確認します。
    if (!ARGUMENT_PRESENT(Pipeline))
    {
        hr = E_POINTER;
        goto cleanup;
    }

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

    // 登録が進行中でない場合は戻ります。この例では、登録オブジェクトが
    // エンジンコンテキスト構造体の一部であることを前提としています。
    if (context->Enrollment.InProgress != TRUE)
    {
        hr = WINBIO_E_INVALID_DEVICE_STATE;
        goto cleanup;
    }


    // カスタム関数 (_AdapterDestroyEnrollmentTemplate) を呼び出して、
    // 登録オブジェクトに関連付けられているオブジェクトを解放します。
    _AdapterDestroyEnrollmentTemplate(
        context,
        &context->Enrollment
        );

    // _AdapterDestroyEnrollmentTemplate 関数が InProgress データメンバーを
    // リセットしない場合は、ここでリセットします。
    context->Enrollment.InProgress = FALSE;

cleanup:

    return hr;
}