WdfIoResourceListGetDescriptor method

[Applies to KMDF only]

The WdfIoResourceListGetDescriptor method returns a pointer to a resource descriptor that is contained in a resource requirements list's logical configuration.

Syntax


PIO_RESOURCE_DESCRIPTOR WdfIoResourceListGetDescriptor(
  [in]  WDFIORESLIST ResourceList,
  [in]  ULONG Index
);

Parameters

ResourceList [in]

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

Index [in]

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

Return value

WdfIoResourceListGetDescriptor returns a pointer to the IO_RESOURCE_DESCRIPTOR structure that describes the hardware resource that the Index parameter identifies, if the index value is valid. Otherwise, the method returns NULL.

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

Remarks

Your driver cannot modify the contents of the IO_RESOURCE_DESCRIPTOR structure that WdfIoResourceListGetDescriptor retrieves. To modify a resource descriptor, the driver can call WdfIoResourceListUpdateDescriptor.

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

Examples

For a code example that uses WdfIoResourceListGetDescriptor, see WdfIoResourceRequirementsListGetIoResList.

Requirements

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, KmdfIrql, KmdfIrql2

See also

IO_RESOURCE_DESCRIPTOR
WdfIoResourceListUpdateDescriptor

 

 

Send comments about this topic to Microsoft

Afficher:
© 2014 Microsoft