CM_Get_Next_Res_Des function (cfgmgr32.h)
The CM_Get_Next_Res_Des function obtains a handle to the next resource descriptor, of a specified resource type, for a logical configuration on the local machine.
Syntax
CMAPI CONFIGRET CM_Get_Next_Res_Des(
[out] PRES_DES prdResDes,
[in] RES_DES rdResDes,
[in] RESOURCEID ForResource,
[out, optional] PRESOURCEID pResourceID,
[in] ULONG ulFlags
);
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.
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.
Remarks
To enumerate a logical configuration's resource descriptors, begin by calling CM_Get_Next_Res_Des 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, 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.
To modify the information stored in a resource descriptor, call CM_Modify_Res_Des.
Callers of CM_Get_Next_Res_Des must call CM_Free_Res_Des_Handle to deallocate the resource descriptor handle, after it is no longer needed.
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 |