DRIVER_DISPATCH回呼函式 (wdm.h)
回呼例程服務各種 IRP。 如需函式程式碼的清單,請參閱。
語法
DRIVER_DISPATCH DriverDispatch;
NTSTATUS DriverDispatch(
[in, out] _DEVICE_OBJECT *DeviceObject,
[in, out] _IRP *Irp
)
{...}
參數
[in, out] DeviceObject
呼叫端提供的 DEVICE_OBJECT結構的指標 。 這是目標裝置的裝置物件,先前是由驅動程式的 AddDevice 例程所建立。
[in, out] Irp
呼叫端提供的 IRP 結構指標,描述要求的 I/O 作業。
傳回值
如果例程成功,它必須傳回STATUS_SUCCESS。 否則,它必須傳回 Ntstatus.h 中定義的其中一個錯誤狀態值。
備註
Irp 所指向的 IRP 結構中會提供所有 Dispatch 例程的輸入參數。 驅動程式的相關 I/O 堆疊位置會提供其他參數,此位置是由 IO_STACK_LOCATION 結構所描述,而且可以藉由呼叫 IoGetCurrentIrpStackLocation 來取得。
一般而言,所有 Dispatch 例程都會在 IRQL = PASSIVE_LEVEL的任意線程內容中執行,但有例外狀況。 如需詳細資訊,請參閱 分派例程和 IRQL。
如需分派例程的詳細資訊,請參閱 撰寫分派例程。 如需 IRP 的詳細資訊,請參閱 處理 IRP。
IRP | 關於實作回呼 |
---|---|
IRP_MJ_CLEANUP | 驅動程式的 DispatchCleanup 例程應該命名為 XxxDispatchCleanup,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須在 DriverObject-MajorFunction>[IRP_MJ_CLEANUP] 中儲存 DispatchCleanup 例程的位址。 |
IRP_MJ_CLOSE | 驅動程式的 DispatchClose 例程應該命名為 XxxDispatchClose,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須將 DispatchClose 例程的位址儲存在 DriverObject-MajorFunction>[IRP_MJ_CLOSE]。 |
IRP_MJ_CREATE | 驅動程式的 DispatchCreate 例程應該命名為 XxxDispatchCreate,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須將 DispatchCreate 例程的位址儲存在 DriverObject-MajorFunction>[IRP_MJ_CREATE]。 |
IRP_MJ_CREATE 或 IRP_MJ_CLOSE | 驅動程式可以提供單一 DispatchCreateClose 例程,而不是個別 的 DispatchCreate 和 DispatchClose 例程。 驅動程式的 DispatchCreateClose 例程應該命名為 XxxDispatchCreateClose,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須將 DispatchCreateClose 例程的位址儲存在 DriverObject-MajorFunction>[IRP_MJ_CREATE] 和 DriverObject-MajorFunction>[IRP_MJ_CLOSE]。 |
IRP_MJ_DEVICE_CONTROL | 驅動程式的 DispatchDeviceControl 例程應該命名為 XxxDispatchDeviceControl,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須儲存 DriverObject-MajorFunction>[IRP_MJ_DEVICE_CONTROL] 中的 DispatchDeviceControl 例程位址。 系統會使用 I/O 控制程式代碼中的 FILE_XXX 旗標來判斷 IRP 傳送者是否具有將 IRP 傳送至裝置物件的許可權。 Windows Server 2003 和更新版本的 Windows 驅動程式可以使用 IoValidateDeviceIoControlAccess 例程,在 DispatchDeviceControl 內執行更嚴格的存取檢查。 |
IRP_MJ_FLUSH_BUFFERS | 驅動程式的 DispatchFlushBuffers 例程應該命名為 Xxx DispatchFlushBuffers,其中 Xxx是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須在 DriverObject-MajorFunction>[IRP_MJ_FLUSH_BUFFERS] 中儲存 DispatchFlushBuffers 例程的位址。 |
IRP_MJ_INTERNAL_DEVICE_CONTROL | 驅動程式的 DispatchInternalDeviceControl 例程應該命名為 XxxDispatchInternalDeviceControl,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須儲存 DriverObject-MajorFunction>[IRP_MJ_INTERNAL_DEVICE_CONTROL] 中的 DispatchInternalDeviceControl 例程位址。 |
IRP_MJ_PNP | 驅動程式的 DispatchPnP 例程應該命名為 XxxDispatchPnP,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須將 DispatchPnP 例程的位址儲存在 DriverObject-MajorFunction>[IRP_MJ_PNP]。 |
IRP_MJ_POWER | 驅動程式的 DispatchPower 例程應該命名為 XxxDispatchPower,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須將 DispatchPower 例程的位址儲存在 DriverObject-MajorFunction>[IRP_MJ_POWER]。 |
IRP_MJ_QUERY_INFORMATION | 驅動程式的 DispatchQueryInformation 例程應該命名為 XxxDispatchQueryInformation,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須在 DriverObject-MajorFunction>[IRP_MJ_QUERY_INFORMATION] 中儲存 DispatchQueryInformation 例程的位址。 |
IRP_MJ_READ | 驅動程式的 DispatchRead 例程應該命名為 XxxDispatchRead,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須將 DispatchRead 例程的位址儲存在 DriverObject-MajorFunction>[IRP_MJ_READ]。 |
IRP_MJ_READ 或 IRP_MJ_WRITE | 驅動程式可以提供單一 DispatchReadWrite 例程,而不是個別 的 DispatchRead 和DispatchWrite 例程。 驅動程式的 DispatchReadWrite 例程應該命名為 XxxDispatchReadWrite,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須將 DispatchReadWrite 例程的位址儲存在 DriverObject-MajorFunction>[IRP_MJ_READ] 和 DriverObject-MajorFunction>[IRP_MJ_WRITE]。 |
IRP_MJ_SET_INFORMATION | 驅動程式的 DispatchSetInformation 例程應該命名為 XxxDispatchSetInformation,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須在 DriverObject-MajorFunction>[IRP_MJ_SET_INFORMATION] 中儲存 DispatchSetInformation 例程的位址。 |
IRP_MJ_SHUTDOWN | 驅動程式的 DispatchShutdown 例程應該命名為 XxxDispatchShutdown,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須將 DispatchShutdown 例程的位址儲存在 DriverObject-MajorFunction>[IRP_MJ_SHUTDOWN]。 此外,為了接收 IRP_MJ_SHUTDOWN 要求,驅動程式必須呼叫 IoRegisterShutdownNotification 或 IoRegisterLastChanceShutdownNotification ,以向系統註冊其 DispatchShutdown 例程。 |
IRP_MJ_SYSTEM_CONTROL | 驅動程式的 DispatchSystemControl 例程應該命名為 XxxDispatchSystemControl,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須在 DriverObject-MajorFunction>[IRP_MJ_SYSTEM_CONTROL] 中儲存 DispatchSystemControl 例程的位址。 |
IRP_MJ_WRITE | 驅動程式的 DispatchWrite 例程應該命名為 XxxDispatchWrite,其中 Xxx 是驅動程式特定的前置詞。 驅動程式的 DriverEntry 例程必須在 DriverObject-MajorFunction>[IRP_MJ_WRITE] 中儲存 DispatchWrite 例程的位址。 |
範例
若要定義回呼例程,您必須先提供函式宣告,以識別您要定義的回呼例程類型。 Windows 提供一組驅動程式的回呼函式類型。 使用回呼函式類型宣告函式有助於 驅動程式的程式代碼分析、 靜態驅動程式驗證器 (SDV) ,以及其他驗證工具會尋找錯誤,而且這是撰寫 Windows 操作系統驅動程式的需求。
例如,若要定義名為MyDispatchCleanup
的 DispatchCleanup 回呼例程,請使用 DRIVER_DISPATCH 類型,如下列程式代碼範例所示:
DRIVER_DISPATCH MyDispatchCleanup;
然後,實作回呼例程,如下所示:
_Use_decl_annotations_
NTSTATUS
MyDispatchCleanup(
struct _DEVICE_OBJECT *DeviceObject,
struct _IRP *Irp
)
{
// Function body
}
DRIVER_DISPATCH函式類型定義於 Wdm.h 頭檔中。 若要在執行程式代碼分析工具時更精確地識別錯誤,請務必將the_Use_decl_annotations_annotation新增至函式定義。 The_Use_decl_annotations_annotation可確保使用頭檔中套用至DRIVER_DISPATCH函式類型的批注。 如需函式宣告需求的詳細資訊,請參閱 使用WDM驅動程式的函式角色類型來宣告函式。 如需 Use_decl_annotations的詳細資訊,請參閱 標註函式行為。
規格需求
需求 | 值 |
---|---|
目標平台 | 桌面 |
標頭 | wdm.h (包括 Wdm.h、Ntddk.h、Ntifs.h) |
IRQL | PASSIVE_LEVEL (请参阅一节) 。 |