fungsi panggilan balik PIBIO_SENSOR_CANCEL_FN (winbio_adapter.h)
Dipanggil oleh Windows Biometric Framework untuk membatalkan semua operasi sensor yang tertunda.
Sintaks
PIBIO_SENSOR_CANCEL_FN PibioSensorCancelFn;
HRESULT PibioSensorCancelFn(
[in, out] PWINBIO_PIPELINE Pipeline
)
{...}
Parameter
[in, out] Pipeline
Arahkan 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 |
---|---|
|
Argumen Alur tidak boleh NULL. |
|
Anggota SensorHandle dari struktur WINBIO_PIPELINE yang diacu oleh argumen Alur diatur ke INVALID_HANDLE_VALUE. |
Keterangan
Implementasi Anda dari fungsi ini seharusnya tidak menunggu operasi yang tertunda selesai.
Jika sensor tidak memiliki operasi yang tertunda ketika fungsi ini dipanggil, implementasi Anda harus mengembalikan S_OK tanpa mengubah status alur.
Contoh
Pseudocode berikut menunjukkan satu kemungkinan implementasi fungsi ini. Contoh tidak dikompilasi. Anda harus menyesuaikannya agar sesuai dengan tujuan Anda.
//////////////////////////////////////////////////////////////////////////////////////////
//
// SensorAdapterCancel
//
// Purpose:
// Cancels all pending sensor operations.
//
// Parameters:
// Pipeline - Pointer to a WINBIO_PIPELINE structure associated with
// the biometric unit.
//
static HRESULT
WINAPI
SensorAdapterCancel(
__inout PWINBIO_PIPELINE Pipeline
)
{
HRESULT hr = S_OK;
// Verify that the Pipeline parameter is not NULL.
if (!ARGUMENT_PRESENT(Pipeline))
{
hr = E_POINTER;
goto cleanup;
}
// Validate the current sensor state.
if (Pipeline->SensorHandle == INVALID_HANDLE_VALUE)
{
return WINBIO_E_INVALID_DEVICE_STATE;
}
// Cancel all I/O to the sensor handle.
if (!CancelIoEx(Pipeline->SensorHandle, NULL))
{
hr = _SensorAdapterGetHresultFromWin32(GetLastError());
}
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) |