WdfIoResourceListInsertDescriptor 函数 (wdfresource.h)

  • 项目

[仅适用于 KMDF]

WdfIoResourceListInsertDescriptor 方法将资源描述符插入资源要求列表的逻辑配置中。

语法

NTSTATUS WdfIoResourceListInsertDescriptor(
  [in] WDFIORESLIST            ResourceList,
  [in] PIO_RESOURCE_DESCRIPTOR Descriptor,
  [in] ULONG                   Index
);

参数

[in] ResourceList

框架 resource-range-list 对象的句柄，该对象表示设备硬件资源的逻辑配置。

[in] Descriptor

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

[in] Index

一个从零开始的值，用作资源描述符集中的索引，这些资源描述符已在 ResourceList 指定的逻辑配置中。 若要将资源描述符添加到逻辑配置的末尾，请指定WDF_INSERT_AT_END或 WdfIoResourceListGetCount 中的返回值。

返回值

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

返回代码 说明
STATUS_INVALID_PARAMETER
 指定的参数无效。
STATUS_ACCESS_DENIED
 不允许驱动程序将描述符添加到逻辑配置。
STATUS_INSUFFICIENT_RESOURCES
 框架无法分配空间来存储描述符。
STATUS_ARRAY_BOUNDS_EXCEEDED
 Index 参数指定的值太大。
 

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

注解

WdfIoResourceListInsertDescriptor 方法在 Index 值标识的资源描述符前面，将描述符参数指向的资源描述符插入 ResourceList 参数指定的逻辑配置中。

若要将资源描述符添加到逻辑配置的末尾，请指定 WDF_INSERT_AT_END 或 WdfIoResourceListGetCount 中的返回值作为 Index 值。 或者，使用 WdfIoResourceListAppendDescriptor 方法。

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

有关资源要求列表和逻辑配置的详细信息，请参阅 Framework-Based 驱动程序的硬件资源。

示例

下面的代码示例初始化资源描述符，并将描述符添加到逻辑配置的末尾。

IO_RESOURCE_DESCRIPTOR descriptor;

RtlZeroMemory(&descriptor, sizeof(descriptor));

descriptor.Option = 0;
descriptor.Type = CmResourceTypePort;
descriptor.ShareDisposition = CmResourceShareDeviceExclusive;
descriptor.Flags = CM_RESOURCE_PORT_IO|CM_RESOURCE_PORT_16_BIT_DECODE;
descriptor.u.Port.Length = 1;
descriptor.u.Port.Alignment = 0x01;
descriptor.u.Port.MinimumAddress.QuadPart = 0;
descriptor.u.Port.MaximumAddress.QuadPart = 0xFFFF;

status = WdfIoResourceListInsertDescriptor(
                                           logConfig,
                                           &descriptor,
                                           WDF_INSERT_AT_END
                                           );
if (!NT_SUCCESS(status)) {
    return status;
}

要求

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

另请参阅

IO_RESOURCE_DESCRIPTOR

WdfIoResourceListAppendDescriptor