Skip to content

Latest commit

 

History

History
171 lines (125 loc) · 5.56 KB

nf-cfgmgr32-cm_get_first_log_conf.md

File metadata and controls

171 lines (125 loc) · 5.56 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:cfgmgr32.CM_Get_First_Log_Conf
CM_Get_First_Log_Conf function (cfgmgr32.h)
The CM_Get_First_Log_Conf function obtains the first logical configuration, of a specified configuration type, associated with a specified device instance on the local machine.
CM_Get_First_Log_Conf
CM_Get_First_Log_Conf function [Device and Driver Installation]
cfgmgr32/CM_Get_First_Log_Conf
cfgmgrfn_5310503c-65cc-4185-9d26-bf29c1af74c4.xml
devinst.cm_get_first_log_conf
devinst\cm_get_first_log_conf.htm
devinst
7ef14797-ea67-40cb-ad8d-e8c846ae1fd4
12/05/2018
CM_Get_First_Log_Conf, CM_Get_First_Log_Conf function [Device and Driver Installation], cfgmgr32/CM_Get_First_Log_Conf, cfgmgrfn_5310503c-65cc-4185-9d26-bf29c1af74c4.xml, devinst.cm_get_first_log_conf
cfgmgr32.h
Cfgmgr32.h
Desktop
Available in Microsoft Windows 2000 and later versions of Windows.
Cfgmgr32.lib
Cfgmgr32.dll
Windows
19H1
CM_Get_First_Log_Conf
cfgmgr32/CM_Get_First_Log_Conf
c++
APIRef
kbSyntax
DllExport
Cfgmgr32.dll
CM_Get_First_Log_Conf

CM_Get_First_Log_Conf function

-description

The CM_Get_First_Log_Conf function obtains the first logical configuration, of a specified configuration type, associated with a specified device instance on the local machine.

-parameters

-param plcLogConf [out, optional]

Address of a location to receive the handle to a logical configuration, or NULL. See the following Remarks section.

-param dnDevInst [in]

Caller-supplied device instance handle that is bound to the local machine.

-param ulFlags [in]

Caller-supplied flag value indicating the type of logical configuration being requested. One of the flags in the following table must be specified.

Configuration Type Flags Definitions
BASIC_LOG_CONF The caller is requesting basic configuration information.
FILTERED_LOG_CONF The caller is requesting filtered configuration information.
ALLOC_LOG_CONF The caller is requesting allocated configuration information.
BOOT_LOG_CONF The caller is requesting boot configuration information.
FORCED_LOG_CONF The caller is requesting forced configuration information.
OVERRIDE_LOG_CONF The caller is requesting override configuration information.

-returns

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_First_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_Add_Empty_Log_Conf or CM_Free_Log_Conf can invalidate the handle obtained from a previous call to CM_Get_First_Log_Conf. Thus if you want to obtain logical configurations after calling CM_Add_Empty_Log_Conf or CM_Free_Log_Conf, your code must call CM_Get_First_Log_Conf again and start at the first configuration.

The handle received in plcLogConf must be explicitly freed by calling CM_Free_Log_Conf_Handle.

If CM_Get_First_Log_Conf is called with plcLogConf set to NULL, no handle is returned. This allows you to use the return status to determine if a configuration exists without the need to subsequently free the handle.

For information about using device instance handles that are bound to the local machine, see CM_Get_Child.

-see-also

CM_Add_Empty_Log_Conf

CM_Free_Log_Conf

CM_Free_Log_Conf_Handle

CM_Get_Child

CM_Get_First_Log_Conf_Ex