WdfCmResourceListInsertDescriptor 函数 (wdfresource.h)

项目
08/08/2023

[仅适用于 KMDF]

WdfCmResourceListInsertDescriptor 方法将资源描述符插入指定的资源列表中。

语法

NTSTATUS WdfCmResourceListInsertDescriptor(
  [in] WDFCMRESLIST                    List,
  [in] PCM_PARTIAL_RESOURCE_DESCRIPTOR Descriptor,
  [in] ULONG                           Index
);

参数

[in] List

表示设备硬件资源列表列表的框架资源列表对象的句柄。

[in] Descriptor

指向描述硬件资源的 CM_PARTIAL_RESOURCE_DESCRIPTOR 结构的指针。

[in] Index

一个从零开始的值，用作 List 指定的逻辑配置中的索引。若要将资源描述符添加到资源列表的末尾，请指定WDF_INSERT_AT_END或 WdfCmResourceListGetCount 中的返回值。

返回值

如果操作成功，WdfCmResourceListInsertDescriptor 将返回STATUS_SUCCESS。否则，此方法可能会返回以下值之一：

返回代码	说明
STATUS_INVALID_PARAMETER	指定的参数无效。
STATUS_ACCESS_DENIED	不允许驱动程序将描述符添加到 List 参数指定的逻辑配置。例如，驱动程序无法修改其 EvtDevicePrepareHardware 或 EvtDeviceReleaseHardware 回调函数收到的逻辑配置。
STATUS_INSUFFICIENT_RESOURCES	框架无法分配空间来存储描述符参数指向的描述符。
STATUS_ARRAY_BOUNDS_EXCEEDED	指定的 Index 参数太大的值。

如果驱动程序提供无效的对象句柄，则会发生系统 bug 检查。

注解

WdfCmResourceListInsertDescriptor 方法将描述符指定的资源描述符插入 List 指定的资源列表，位于 Index 值标识的资源描述符前面。

若要将资源描述符添加到资源列表的末尾，请将WDF_INSERT_AT_END或 WdfCmResourceListGetCount 中的返回值指定为 Index 值。或者，使用 WdfCmResourceListAppendDescriptor 方法。

框架将 CM_PARTIAL_RESOURCE_DESCRIPTOR 结构的内容复制到内部存储中，因此调用 WdfCmResourceListInsertDescriptor 的驱动程序例程可以在本地分配结构。驱动程序调用 WdfCmResourceListInsertDescriptor 后，可以重复使用 CM_PARTIAL_RESOURCE_DESCRIPTOR 结构。

有关资源列表的详细信息，请参阅 Framework-Based 驱动程序的硬件资源。

示例

下面的代码示例将资源描述符添加到 EvtDeviceResourcesQuery 回调函数接收的资源列表末尾。

NTSTATUS
PdoEvtDeviceResourcesQuery(
    IN WDFDEVICE  Device,
    IN WDFCMRESLIST  Resources
    )
{
    CM_PARTIAL_RESOURCE_DESCRIPTOR newDescriptor;
...
    newDescriptor.Type = CmResourceTypePort;
    newDescriptor.ShareDisposition = CmResourceShareDeviceExclusive;
    newDescriptor.Flags = CM_RESOURCE_PORT_IO|CM_RESOURCE_PORT_16_BIT_DECODE;
    newDescriptor.u.Port.Length = 1;
    newDescriptor.u.Port.Start = 0;

    status = WdfCmResourceListInsertDescriptor(
                                               Resources,
                                               &newDescriptor,
                                               WDF_INSERT_AT_END
                                               );
...

}

要求

要求	值
目标平台	通用
最低 KMDF 版本	1.0
标头	wdfresource.h (包括 Wdf.h)
Library	Wdf01000.sys (请参阅框架库 Versioning.)
IRQL	<=DISPATCH_LEVEL
DDI 符合性规则	DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)