WdfIoResourceListRemove function (wdfresource.h)

Article
02/22/2024

[Applies to KMDF only]

The WdfIoResourceListRemove method removes a resource descriptor from a resource requirements list's logical configuration.

Syntax

void WdfIoResourceListRemove(
  [in] WDFIORESLIST ResourceList,
  [in] ULONG        Index
);

Parameters

[in] ResourceList

A handle to a framework resource-range-list object that represents a logical configuration of hardware resources for a device.

[in] Index

A zero-based value that is used as an index into the logical configuration that ResourceList specifies.

Return value

None

Remarks

A bug check occurs if the driver supplies an invalid object handle.

The WdfIoResourceListRemove method removes the resource descriptor that is associated with the index value that the Index parameter specifies.

When WdfIoResourceListRemove removes the resource descriptor that has the index value n, the index value of the next resource descriptor changes from n+1 to n.

For more information about resource requirements lists and logical configurations, see Hardware Resources for Framework-Based Drivers.

Examples

The following code example removes the first resource descriptor from a logical configuration.

WdfIoResourceListRemove(
                        Reslist,
                        0
                        );

Requirements

Requirement	Value
Target Platform	Universal
Minimum KMDF version	1.0
Header	wdfresource.h (include Wdf.h)
Library	Wdf01000.sys (see Framework Library Versioning.)
IRQL	<=DISPATCH_LEVEL
DDI compliance rules	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Share via