CONFIGMG_Get_First_Log_Conf

CONFIGRET CONFIGMG_Get_First_Log_Conf(PLOG_CONF plcLogConf, DEVNODE dnDevNode, ULONG ulFlags)
 

Returns a handle to the first logical configuration of the specified type in a device node.

• Returns CR_SUCCESS if the function is successful. Otherwise, the return value can be CR_INVALID_FLAG, CR_INVALID_POINTER or CR_NO_MORE_LOG_CONF.

plcLogConf

Address that receives the handle of the logical configuration.

dnDevNode

Device node for which the logical configuration is retrieved.

ulFlags

One of the following values.

ALLOC_LOG_CONF	Specifies the Alloc Element.
BASIC_LOG_CONF	Specifies the requirements list.
BOOT_LOG_CONF	Specifies the boot Alloc Element.
FILTERED_LOG_CONF	Specifies the filtered requirements list.

An initializing device driver typically requests the BASIC_LOG_CONF to verify the work of the enumerator. Sometimes the initializing driver may also check BOOT_LOG_CONF. Drivers typically check FILTERED_LOG_CONF while processing the CONFIG_FILTER device-driver configuration function. ALLOC_LOG_CONF is typically checked while processing CONFIG_DYNAMIC_START, CONFIG_DYNAMIC_STOP, CONFIG_FIRST_CONFIG and CONFIG_REMOVE.

Note  Calling CONFIGMG_Add_Empty_Log_Conf or CONFIGMG_Free_Log_Conf from within a CONFIGMG_Get_First_Log_Conf/CONFIGMG_Get_Next_Log_Conf loop may have unwelcome side effects. Drivers should end the loop before adding or freeing a logical configuration and start it again when the operation is finished.

See Also

CONFIGMG_Add_Empty_Log_Conf, CONFIGMG_Free_Log_Conf, CONFIGMG_Get_Next_Log_Conf