DRIVER_CANCEL回呼函式 (wdm.h)

Cancel 例程會取消 I/O 作業。

語法

DRIVER_CANCEL DriverCancel;

void DriverCancel(
  [in, out] _DEVICE_OBJECT *DeviceObject,
  [in, out] _IRP *Irp
)
{...}

參數

[in, out] DeviceObject

呼叫端提供的 DEVICE_OBJECT 結構的指標。 這是目標裝置的裝置物件，先前是由驅動程式的 AddDevice 例程所建立。

[in, out] Irp

呼叫端提供的 IRP 結構的指標，描述要取消的 I/O 作業。

傳回值

無

備註

當驅動程式或其他系統元件呼叫 IoCancelIrp 時，如果 IRP 已註冊 IRP，I/O 管理員就會呼叫 IRP 的 Cancel 例程。

若要註冊 IRP 的 Cancel 例程，驅動程式可以使用下列兩種方法之一：

1. 提供 StartIo 例程並使用 I/O 管理員提供的裝置佇列的驅動程式可以在呼叫 IoStartPacket 時指定 Cancel 例程。

2. 建立和管理補充裝置佇列的驅動程式可以藉由呼叫IoSetCancelRoutine來註冊 Cancel 例程。

一次只能註冊一個 IRP 的 Cancel 例程。

I/O 管理員會在呼叫驅動程式的 Cancel 例程之前呼叫 IoAcquireCancelSpinLock，因此 Cancel 例程必須在某個時間點呼叫 IoReleaseCancelSpinLock。 例程不應保留超過必要時間的微調鎖定。

Cancel 例程會在 IRQL = DISPATCH_LEVEL的任意線程內容中執行，直到呼叫 IoReleaseCancelSpinLock，這會將 IRQL 變更為呼叫端提供的值。 驅動程式應該指定這個值的 Irp-CancelIrql>。

Cancel 例程必須將 I/O 狀態區塊的狀態成員設定為STATUS_CANCELLED，並將其 Information 成員設定為零。 然後，此例程必須藉由呼叫 IoCompleteRequest 來完成指定的 IRP。

如需實作驅動程式 Cancel 例程的詳細資訊，請參閱 取消 IRP。

範例

若要定義 Cancel 回呼例程，您必須先提供函式宣告，以識別您要定義的回呼例程類型。 Windows 提供一組驅動程式的回呼函式類型。 使用回呼函式類型宣告函式有助於 驅動程式的程式代碼分析、 靜態驅動程式驗證器 (SDV) ，以及其他驗證工具尋找錯誤，而且這是撰寫 Windows 操作系統驅動程式的需求。

例如，若要定義名為 MyCancel的 Cancel 回呼例程，請使用DRIVER_CANCEL類型，如下列程式代碼範例所示：

DRIVER_CANCEL MyCancel;

然後，實作回呼例程，如下所示：

_Use_decl_annotations_
VOID
  MyCancel(
    struct _DEVICE_OBJECT  *DeviceObject,
    struct _IRP  *Irp
    )
  {
      // Function body
  }

DRIVER_CANCEL函式類型定義於 Wdm.h 頭檔中。 若要在執行程式代碼分析工具時更精確地識別錯誤，請務必將 _Use_decl_annotations_ 批註新增至函式定義。 註釋 _Use_decl_annotations_ 可確保使用頭檔中套用至DRIVER_CANCEL函式類型的註釋。 如需函數宣告需求的詳細資訊，請參閱 使用WDM驅動程式的函式角色類型來宣告函式。 如需 的相關信息 _Use_decl_annotations_，請參閱 標註函式行為。

規格需求

需求	值
目標平台	桌面
標頭	wdm.h (包括 Wdm.h、Ntddk.h、Ntifs.h)
IRQL	在DISPATCH_LEVEL (呼叫，請參閱一節) 。