IO_CSQ_COMPLETE_CANCELED_IRP回呼函式 (wdm.h)

發行項
02/27/2024

CsqCompleteCanceledIrp 例程是由系統用來向驅動程式發出訊號，指出它可以完成已取消的 IRP。

語法

IO_CSQ_COMPLETE_CANCELED_IRP IoCsqCompleteCanceledIrp;

void IoCsqCompleteCanceledIrp(
  [in] PIO_CSQ Csq,
  [in] PIRP Irp
)
{...}

參數

[in] Csq

取消安全 IRP 佇列 IO_CSQ 結構的指標。

[in] Irp

要取消之 IRP 的指標。

傳回值

無

備註

驅動程式會在初始化佇列的IO_CSQ結構時，指定適用於取消安全 IRP 佇列的 CsqCompleteCanceledIrp 例程。驅動程式會在初始化IO_CSQ時，將例程指定為IoCsqInitialize或IoCsqInitializeEx的 CsqCompleteCanceledIrp 參數。如需詳細資訊，請參閱取消安全的 IRP 佇列。

系統會呼叫此例程，以完成已從驅動程式佇列中移除的已取消 IRP。一般而言，驅動程式只會呼叫 IRP 的 IoCompleteRequest ，其狀態為 STATUS_CANCELLED。

驅動程式不需要先從佇列中移除 IRP，再將其完成為已取消：系統一律呼叫佇列的 CsqRemoveIrp 例程，在呼叫 CsqCompleteCanceledIrp 之前，先從佇列中移除 IRP。

範例

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

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

IO_CSQ_COMPLETE_CANCELED_IRP MyCsqCompleteCanceledIrp;

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

_Use_decl_annotations_
VOID 
 MyCsqCompleteCanceledIrp(
    _In_ PIO_CSQ  Csq,
    _In_ PIRP  Irp
    )
  {
      // Function body
  }

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