fungsi panggilan balik PIBIO_ENGINE_QUERY_SAMPLE_HINT_FN (winbio_adapter.h)

Dipanggil oleh Windows Biometric Framework untuk mengambil jumlah sampel yang benar yang diperlukan oleh adaptor mesin untuk membuat templat pendaftaran.

Sintaks

PIBIO_ENGINE_QUERY_SAMPLE_HINT_FN PibioEngineQuerySampleHintFn;

HRESULT PibioEngineQuerySampleHintFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [out]     PSIZE_T SampleHint
)
{...}

Parameter

[in, out] Pipeline

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

[out] SampleHint

Penunjuk ke variabel yang menerima jumlah sampel yang diperlukan.

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	Parameter pointer wajib adalah NULL.
WINBIO_E_UNSUPPORTED_PROPERTY	Adaptor mesin tidak mendukung properti ini.

Keterangan

Jika adaptor mesin memerlukan jumlah sampel yang berbeda dalam situasi yang berbeda, Anda harus mengembalikan angka terbesar. Misalnya, jika mesin sidik jari memerlukan lebih banyak gesek untuk jari telunjuk daripada untuk ibu jari, kembalikan angka yang diperlukan untuk jari telunjuk.

Nilai yang dikembalikan oleh parameter SampleHint menentukan jumlah sampel yang benar yang diperlukan. Karena tangkapan yang buruk, jumlah sampel aktual yang diperlukan selama pendaftaran mungkin lebih besar dari jumlah yang ditentukan.

Contoh

Pseudocode berikut menunjukkan satu kemungkinan implementasi fungsi ini. Contoh tidak dikompilasi. Anda harus menyesuaikannya agar sesuai dengan tujuan Anda.

//////////////////////////////////////////////////////////////////////////////////////////
//
// EngineAdapterQuerySampleHint
//
// Purpose: 
//      Retrieves the number of correct samples required by the engine adapter 
//      to construct an enrollment template.
//
// Parameters:
//      Pipeline    - Pointer to a WINBIO_PIPELINE structure associated 
//                    with the biometric unit performing the operation. 
//      SampleHint  - Pointer to a variable that receives the number of 
//                    required samples.
//
static HRESULT
WINAPI
EngineAdapterQuerySampleHint(
    __inout PWINBIO_PIPELINE Pipeline,
    __out PSIZE_T SampleHint
    )
{
    // Verify that pointer arguments are not NULL.
    if (!ARGUMENT_PRESENT(Pipeline) ||
        !ARGUMENT_PRESENT(SampleHint))
    {
        hr = E_POINTER;
        goto cleanup;
    }

    // The sample hint specified here is a constant but can also be a 
    // function of the hardware model or the device settings depending
    // on your adapter.
    // If your adapter does not support this feature, return
    // WINBIO_E_UNSUPPORTED_PROPERTY.
    *SampleHint = SAMPLES_REQUIRED_FOR_ENROLLMENT;

cleanup:

    return hr;
}

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

EngineAdapterAcceptSampleData

Fungsi Plug-in