WdfCmResourceListGetDescriptor function (wdfresource.h)

Article
02/22/2024

[Applies to KMDF and UMDF]

The WdfCmResourceListGetDescriptor method returns a pointer to a resource descriptor that is contained in a specified resource list.

Syntax

PCM_PARTIAL_RESOURCE_DESCRIPTOR WdfCmResourceListGetDescriptor(
  [in] WDFCMRESLIST List,
  [in] ULONG        Index
);

Parameters

[in] List

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

[in] Index

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

Return value

WdfCmResourceListGetDescriptor returns a pointer to the CM_PARTIAL_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 resource descriptor that WdfCmResourceListGetDescriptor retrieves.

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

Examples

For a code example that uses WdfCmResourceListGetDescriptor, see WdfCmResourceListGetCount.

Requirements

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

Share via