PIBIO_SENSOR_CANCEL_FN回呼函式 (winbio_adapter.h)
由 Windows 生物特徵辨識架構呼叫,以取消所有擱置的感測器作業。
語法
PIBIO_SENSOR_CANCEL_FN PibioSensorCancelFn;
HRESULT PibioSensorCancelFn(
[in, out] PWINBIO_PIPELINE Pipeline
)
{...}
參數
[in, out] Pipeline
與執行作業之生物特徵辨識單位相關聯的 WINBIO_PIPELINE 結構的指標。
傳回值
如果函式成功,它會傳回S_OK。 如果函式失敗,它必須傳回下列其中一個 HRESULT 值,以指出錯誤。
傳回碼 | Description |
---|---|
|
Pipeline 自變數不可為 NULL。 |
|
Pipeline 自變數所指向之WINBIO_PIPELINE結構的 SensorHandle 成員會設定為 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 |
標頭 | winbio_adapter.h (包含 Winbio_adapter.h) |