CM_Get_Next_Res_Des_Ex function (cfgmgr32.h)

Article
10/13/2021

[Beginning with Windows 8 and Windows Server 2012, this function has been deprecated. Please use CM_Get_Next_Res_Des instead.]

The CM_Get_Next_Res_Des_Ex function obtains a handle to the next resource descriptor, of a specified resource type, for a logical configuration on a local or a remote machine.

Syntax

CMAPI CONFIGRET CM_Get_Next_Res_Des_Ex(
  [out]           PRES_DES    prdResDes,
  [in]            RES_DES     rdResDes,
  [in]            RESOURCEID  ForResource,
  [out, optional] PRESOURCEID pResourceID,
  [in]            ULONG       ulFlags,
  [in, optional]  HMACHINE    hMachine
);

Parameters

[out] prdResDes

Pointer to a location to receive a resource descriptor handle.

[in] rdResDes

Caller-supplied handle to either a resource descriptor or a logical configuration. For more information, see the following Remarks section.

[in] ForResource

Caller-supplied resource type identifier, indicating the type of resource descriptor being requested. This must be one of the ResType_-prefixed constants defined in Cfgmgr32.h.

[out, optional] pResourceID

Pointer to a location to receive a resource type identifier, if ForResource specifies ResType_All. For any other ForResource value, callers should set this to NULL.

[in] ulFlags

Not used, must be zero.

[in, optional] hMachine

Caller-supplied machine handle, obtained from a previous call to CM_Connect_Machine.

Note Using this function to access remote machines is not supported beginning with Windows 8 and Windows Server 2012, as this functionality has been removed.

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_Next_Res_Des_Ex 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

To enumerate a logical configuration's resource descriptors, begin by calling CM_Get_Next_Res_Des_Ex with the logical configuration's handle as the argument for rdResDes. This obtains a handle to the first resource descriptor of the type specified by ForResource. Then for each subsequent call to CM_Get_Next_Res_Des_Ex, specify the most recently obtained descriptor handle as the argument for rdResDes. Repeat until the function returns CR_NO_MORE_RES_DES.

To retrieve the information stored in a resource descriptor, call CM_Get_Res_Des_Data_Ex.

To modify the information stored in a resource descriptor, call CM_Modify_Res_Des_Ex.

Callers of CM_Get_Next_Res_Des_Ex must call CM_Free_Res_Des_Handle to deallocate the resource descriptor handle, after it is no longer needed.

Functionality to access remote machines has been removed in Windows 8 and Windows Server 2012 and later operating systems thus you cannot access remote machines when running on these versions of Windows.

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