CM_Add_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_Add_Res_Des instead.]

The CM_Add_Res_Des_Ex function adds a resource descriptor to a logical configuration. The logical configuration can be on either the local or a remote machine.

Syntax

CMAPI CONFIGRET CM_Add_Res_Des_Ex(
  [out, optional] PRES_DES   prdResDes,
  [in]            LOG_CONF   lcLogConf,
  [in]            RESOURCEID ResourceID,
  [in]            PCVOID     ResourceData,
  [in]            ULONG      ResourceLen,
  [in]            ULONG      ulFlags,
  [in, optional]  HMACHINE   hMachine
);

Parameters

[out, optional] prdResDes

Pointer to a location to receive a handle to the new resource descriptor.

[in] lcLogConf

Caller-supplied handle to the logical configuration to which the resource descriptor should be added. This handle must have been previously obtained by calling one of the following functions:

CM_Add_Empty_Log_Conf

CM_Add_Empty_Log_Conf_Ex

CM_Get_First_Log_Conf

CM_Get_First_Log_Conf_Ex

CM_Get_Next_Log_Conf

CM_Get_Next_Log_Conf_Ex

[in] ResourceID

Caller-supplied resource type identifier, which identifies the type of structure supplied by ResourceData. This must be one of the ResType_-prefixed constants defined in Cfgmgr32.h.

[in] ResourceData

Caller-supplied pointer to one of the resource structures listed in the following table.

ResourceID Parameter	Resource Structure
ResType_BusNumber	BUSNUMBER_RESOURCE
ResType_ClassSpecific	CS_RESOURCE
ResType_DevicePrivate	DEVPRIVATE_RESOURCE
ResType_DMA	DMA_RESOURCE
ResType_IO	IO_RESOURCE
ResType_IRQ	IRQ_RESOURCE
ResType_Mem	MEM_RESOURCE
ResType_MfCardConfig	MFCARD_RESOURCE
ResType_PcCardConfig	PCCARD_RESOURCE

[in] ResourceLen

Caller-supplied length of the structure pointed to by ResourceData.

[in] ulFlags

Not used, must be zero.

[in, optional] hMachine

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

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

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

Callers of this function must have SeLoadDriverPrivilege. (Privileges are described in the Microsoft Windows SDK documentation.)

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