функция обратного вызова PIBIO_SENSOR_CANCEL_FN (winbio_adapter.h)
Вызывается windows Biometric Framework для отмены всех ожидающих операций датчика.
Синтаксис
PIBIO_SENSOR_CANCEL_FN PibioSensorCancelFn;
HRESULT PibioSensorCancelFn(
[in, out] PWINBIO_PIPELINE Pipeline
)
{...}
Параметры
[in, out] Pipeline
Указатель на WINBIO_PIPELINE структуру, связанную с биометрической единицей, выполняющей операцию.
Возвращаемое значение
Если функция завершается успешно, она возвращает S_OK. Если функция завершается сбоем, она должна вернуть одно из следующих значений HRESULT , чтобы указать на ошибку.
Код возврата | Описание |
---|---|
|
Аргумент Pipeline не может иметь значение NULL. |
|
Член SensorHandle структуры WINBIO_PIPELINE , на который указывает аргумент Pipeline, имеет значение INVALID_HANDLE_VALUE. |
Комментарии
Реализация этой функции не должна ждать завершения ожидающих операций.
Если при вызове этой функции у датчика нет ожидающих операций, реализация должна возвращать S_OK без изменения состояния конвейера.
Примеры
В следующем псевдокоде показана одна из возможных реализаций этой функции. Пример не компилируется. Вы должны адаптировать его в соответствии с вашей целью.
//////////////////////////////////////////////////////////////////////////////////////////
//
// 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;
}
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows 7 [только классические приложения] |
Минимальная версия сервера | Windows Server 2008 R2 [только классические приложения] |
Целевая платформа | Windows |
Header | winbio_adapter.h (включая Winbio_adapter.h) |