NdisQueueIoWorkItem 函数 (ndis.h)

项目
02/26/2024

NDIS 驱动程序调用 NdisQueueIoWorkItem 函数将工作项排队。

语法

void NdisQueueIoWorkItem(
  [in] NDIS_HANDLE              NdisIoWorkItemHandle,
  [in] NDIS_IO_WORKITEM_ROUTINE Routine,
  [in] PVOID                    WorkItemContext
);

参数

[in] NdisIoWorkItemHandle

前一次调用返回的专用 IO_WORKITEM 结构的句柄 NdisAllocateIoWorkItem 函数。

[in] Routine

NDIS 调用以处理工作项的函数的入口点。 NDIS 在系统线程的上下文中调用此例程。

注意必须使用 NDIS_IO_WORKITEM_FUNCTION 类型声明函数， (不能 NDIS_IO_WORKITEM_ROUTINE) 。有关详细信息，请参阅以下示例部分。

例程包括以下输入参数：

WorkItemContext

指向驱动程序传递给 NdisQueueIoWorkItem 的 WorkItemContext 参数的上下文区域的指针。

NdisIoWorkItemHandle

前一次调用返回的专用 NDIS_IO_WORKITEM 结构的句柄 NdisAllocateIoWorkItem 函数。

[in] WorkItemContext

指向 NDIS 传递给回调例程的调用方提供的上下文区域的指针。 WorkItemContext 可以是驱动程序管理工作项所需的任何调用方指定的数据。

返回值

无

备注

NdisQueueIoWorkItem 调用 IoQueueWorkItem 将工作项排队。 NDIS 工作项使用 CriticalWorkQueue 队列类型。

调用方提供的回调例程 (NDIS_IO_WORKITEM_ROUTINE) 在 IRQL = PASSIVE_LEVEL 的系统线程上下文中运行。

此调用方提供的例程可以调用 NdisFreeIoWorkItem 函数，以回收为工作项分配的存储。

示例

若要定义例程函数，必须首先提供一个函数声明，用于标识要定义的函数类型。 Windows 为驱动程序提供一组函数类型。使用函数类型声明函数可帮助驱动程序的代码分析、静态驱动程序验证程序 (SDV) 和其他验证工具查找错误，并且这是编写 Windows 操作系统驱动程序的要求。

例如，若要定义名为“MyWorkitemRoutine”的例程函数，请使用 NDIS_IO_WORKITEM_FUNCTION 类型，如以下代码示例所示：

NDIS_IO_WORKITEM_FUNCTION MyWorkitemRoutine;

然后，按如下所示实现函数：

_Use_decl_annotations_
VOID
 MyWorkitemRoutine(
    PVOID   WorkItemContext,
    NDIS_HANDLE  NdisIoWorkItemHandle
    )
  {...}

NDIS_IO_WORKITEM_FUNCTION函数类型在 Ndis.h 头文件中定义。若要在运行代码分析工具时更准确地识别错误，请务必将 Use_decl_annotations 注释添加到函数定义。 Use_decl_annotations批注可确保使用应用于头文件中NDIS_IO_WORKITEM_FUNCTION函数类型的注释。有关函数声明要求的详细信息，请参阅使用 NDIS 驱动程序的函数角色类型声明函数。

有关 Use_decl_annotations的信息，请参阅批注函数行为。

要求

要求	值
最低受支持的客户端	在 NDIS 6.0 及更高版本中受支持。
目标平台	通用
标头	ndis.h (包括 Ndis.h)
Library	Ndis.lib
IRQL	<= DISPATCH_LEVEL
DDI 符合性规则	Irql_Miscellaneous_Function (ndis)