CM_Get_Res_Des_Data function (cfgmgr32.h)

Article
02/22/2024

The CM_Get_Res_Des_Data function retrieves the information stored in a resource descriptor on the local machine.

Syntax

CMAPI CONFIGRET CM_Get_Res_Des_Data(
  [in]  RES_DES rdResDes,
  [out] PVOID   Buffer,
  [in]  ULONG   BufferLen,
  [in]  ULONG   ulFlags
);

Parameters

[in] rdResDes

Caller-supplied handle to a resource descriptor, obtained by a previous call to CM_Get_Next_Res_Des.

[out] Buffer

Address of a buffer to receive the contents of a resource descriptor. The required buffer size should be obtained by calling CM_Get_Res_Des_Data_Size.

[in] BufferLen

Caller-supplied length of the buffer specified by Buffer.

[in] ulFlags

Not used, must be zero.

Return value

If the operation succeeds, the function returns CR_SUCCESS. Otherwise, it returns one of the CR_-prefixed error codes defined in Cfgmgr32.h.

Note Starting with Windows 8, CM_Get_Res_Des_Data returns CR_CALL_NOT_IMPLEMENTED when used in a Wow64 scenario. To request information about the hardware resources on a local machine it is necessary implement an architecture-native version of the application using the hardware resource APIs. For example: An AMD64 application for AMD64 systems.

Remarks

Information returned in the buffer supplied by Buffer will be formatted as one of the resource type structures listed in the description of CM_Add_Res_Des, based on the resource type that was specified when CM_Get_Next_Res_Des was called to obtain the resource descriptor handle.

Requirements

Requirement	Value
Minimum supported client	Available in Microsoft Windows 2000 and later versions of Windows.
Target Platform	Desktop
Header	cfgmgr32.h (include Cfgmgr32.h)
Library	Cfgmgr32.lib
DLL	Cfgmgr32.dll