WdfIoResourceListInsertDescriptor function (wdfresource.h)

[Applies to KMDF only]

The WdfIoResourceListInsertDescriptor method inserts a resource descriptor into a resource requirements list's logical configuration.

Syntax

NTSTATUS WdfIoResourceListInsertDescriptor(
  [in] WDFIORESLIST            ResourceList,
  [in] PIO_RESOURCE_DESCRIPTOR Descriptor,
  [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] Descriptor

A pointer to an IO_RESOURCE_DESCRIPTOR structure that describes a hardware resource.

[in] Index

A zero-based value that is used as an index into the set of resource descriptors that are already in the logical configuration that ResourceList specifies. To add a resource descriptor to the end of the logical configuration, specify WDF_INSERT_AT_END or the return value from WdfIoResourceListGetCount.

Return value

WdfIoResourceListInsertDescriptor returns STATUS_SUCCESS if the operation succeeds. Otherwise, this method might return one of the following values:

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

Remarks

The WdfIoResourceListInsertDescriptor method inserts the resource descriptor that the Descriptor parameter points to into the logical configuration that the ResourceList parameter specifies, in front of the resource descriptor that the Index value identifies.

To add a resource descriptor to the end of a logical configuration, specify WDF_INSERT_AT_END or the return value from WdfIoResourceListGetCount for the Index value. Alternatively, use the WdfIoResourceListAppendDescriptor method.

The framework copies the contents of the IO_RESOURCE_DESCRIPTOR structure into internal storage, so the driver routine that calls WdfIoResourceListInsertDescriptor can allocate the structure locally. After the driver calls WdfIoResourceListInsertDescriptor, the driver can reuse the IO_RESOURCE_DESCRIPTOR structure.

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

Examples

The following code example initializes a resource descriptor and adds the descriptor to the end of a logical configuration.

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;
}

Requirements

See also

IO_RESOURCE_DESCRIPTOR

WdfIoResourceListAppendDescriptor