CM_Free_Log_Conf_Ex function (cfgmgr32.h)
[Beginning with Windows 8 and Windows Server 2012, this function has been deprecated. Please use CM_Free_Log_Conf instead.]
The CM_Free_Log_Conf_Ex function removes a logical configuration and all associated resource descriptors from either a local or a remote machine.
Syntax
CMAPI CONFIGRET CM_Free_Log_Conf_Ex(
[in] LOG_CONF lcLogConfToBeFreed,
[in] ULONG ulFlags,
[in, optional] HMACHINE hMachine
);
Parameters
[in] lcLogConfToBeFreed
Caller-supplied handle to a logical configuration. This handle must have been previously obtained by calling one of the following functions:
[in] ulFlags
Not used, must be zero.
[in, optional] hMachine
Caller-supplied machine handle, obtained from a previous call to CM_Connect_Machine.
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
Calling CM_Free_Log_Conf_Ex can cause the handles returned by CM_Get_First_Log_Conf_Ex and CM_Get_Next_Log_Conf_Ex to become invalid. Thus if you want to obtain logical configurations after calling CM_Free_Log_Conf_Ex, your code must call CM_Get_First_Log_Conf_Ex again and start at the first configuration.
Note that calling CM_Free_Log_Conf_Ex frees the configuration, but not the configuration's handle. To free the handle, call CM_Free_Log_Conf_Handle_Ex.
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 |