Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CM_Free_Log_Conf function

The CM_Free_Log_Conf function removes a logical configuration and all associated resource descriptors from the local machine.

Syntax


CMAPI
CONFIGRET
WINAPI CM_Free_Log_Conf(
  _In_ LOG_CONF lcLogConfToBeFreed,
  _In_ ULONG    ulFlags
);

Parameters

lcLogConfToBeFreed [in]

Caller-supplied handle to a logical configuration. 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

ulFlags [in]

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

Calling CM_Free_Log_Conf can cause the handles returned by CM_Get_First_Log_Conf and CM_Get_Next_Log_Conf to become invalid. Thus if you want to obtain logical configurations after calling CM_Free_Log_Conf, your code must call CM_Get_First_Log_Conf again and start at the first configuration.

Note that calling CM_Free_Log_Conf frees the configuration, but not the configuration's handle. To free the handle, call CM_Free_Log_Conf_Handle.

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

Requirements

Target platform

Desktop

Version

Available in Microsoft Windows 2000 and later versions of Windows.

Header

Cfgmgr32.h (include Cfgmgr32.h)

Library

Cfgmgr32.lib

DLL

Cfgmgr32.dll

See also

CM_Free_Log_Conf_Ex

 

 

Send comments about this topic to Microsoft

Show: