PIBIO_ENGINE_CLEAR_CONTEXT_FN fungsi panggilan balik (winbio_adapter.h)

Artikel
03/03/2024

Dipanggil oleh Windows Biometric Framework untuk menyiapkan alur pemrosesan unit biometrik untuk operasi baru. Fungsi ini harus membersihkan data sementara dari konteks mesin dan menempatkan adaptor mesin ke dalam keadaan awal yang terdefinisi dengan baik.

Sintaks

PIBIO_ENGINE_CLEAR_CONTEXT_FN PibioEngineClearContextFn;

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

Parameter

[in, out] Pipeline

Penunjuk ke struktur WINBIO_PIPELINE yang terkait dengan unit biometrik yang melakukan operasi.

Mengembalikan nilai

Jika fungsi berhasil, fungsi akan mengembalikan S_OK. Jika fungsi gagal, fungsi harus mengembalikan salah satu nilai HRESULT berikut untuk menunjukkan kesalahan.

Menampilkan kode	Deskripsi
E_POINTER	Argumen Alur tidak boleh NULL.

Keterangan

Tujuan dari fungsi ini adalah untuk mengatur ulang konteks ke statusnya segera setelah panggilan ke fungsi EngineAdapterAttach . Konteksnya adalah struktur yang dapat digunakan kembali. Fungsi EngineAdapterClearContext menginisialisasi ulang konteks tetapi tidak menghapusnya dari alur.

Contoh umum objek di area konteks adaptor mesin yang harus dibersihkan termasuk yang berikut ini.

Objek	Deskripsi
Set fitur	Berisi deskripsi sampel biometrik
Pendaftaran	Melacak status transaksi pendaftaran saat ini.
Templat	Templat biometrik yang dibuat oleh set fitur atau objek pendaftaran.
Perbandingan	Berisi hasil perbandingan antara templat dan set fitur.
Vektor indeks	Berisi sekumpulan nilai indeks yang terkait dengan templat.

Contoh

Pseudocode berikut menunjukkan salah satu kemungkinan implementasi fungsi ini. Contoh tidak dikompilasi. Kau harus menyesuaikannya sesuai dengan tujuanmu.

//////////////////////////////////////////////////////////////////////////////////////////
//
// 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;
}

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 7 [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 R2 [hanya aplikasi desktop]
Target Platform	Windows
Header	winbio_adapter.h (termasuk Winbio_adapter.h)

Lihat juga

Fungsi Plug-in

SensorAdapterClearContext

StorageAdapterClearContext

Bagikan melalui