golcconfig 9.0
Loading...
Searching...
No Matches
Functions
LcSettingC_Lookup_C_API

locates the setting in the configuration and return the data or an LcSettingCMore...

+ Collaboration diagram for LcSettingC_Lookup_C_API:

Functions

LC_EXTERN LC_CFS LcSettingLookupP (LC_CFS setting, MK_STRN path)
 Non-inline replacement for LcSettingLookup
 
LC_EXTERN enum MkErrorE LcSettingLookupBoolP (LC_CFSN setting, MK_STRN name, MK_BOOL *value_out)
 Non-inline replacement for LcSettingLookupBool
 
LC_EXTERN enum MkErrorE LcSettingLookupFloatP (LC_CFSN setting, MK_STRN name, MK_DBL *value_out)
 Non-inline replacement for LcSettingLookupFloat
 
LC_EXTERN enum MkErrorE LcSettingLookupIntP (LC_CFSN setting, MK_STRN name, MK_INT *value_out)
 Non-inline replacement for LcSettingLookupInt
 
LC_EXTERN enum MkErrorE LcSettingLookupInt64P (LC_CFSN setting, MK_STRN name, MK_WID *value_out)
 Non-inline replacement for LcSettingLookupInt64
 
LC_EXTERN enum MkErrorE LcSettingLookupStringP (LC_CFSN setting, MK_STRN name, MK_STRN *value_out)
 Non-inline replacement for LcSettingLookupString
 
MK_BFL LcSettingLookupAll (LC_CFSN setting)
 addon - read an entire configuration below setting into MkBufferListC
 
LC_CFS LcSettingLookup (LC_CFS setting, MK_STRN path)
 This function locates a setting by a path path relative to the setting setting
 
enum MkErrorE LcSettingLookupBool (LC_CFSN setting, MK_STRN name, MK_BOOL *value_out)
 These functions look up the value of the child setting named name of the setting setting
 
enum MkErrorE LcSettingLookupFloat (LC_CFSN setting, MK_STRN name, MK_DBL *value_out)
 These functions look up the value of the child setting named name of the setting setting
 
enum MkErrorE LcSettingLookupInt (LC_CFSN setting, MK_STRN name, MK_INT *value_out)
 These functions look up the value of the child setting named name of the setting setting
 
enum MkErrorE LcSettingLookupInt64 (LC_CFSN setting, MK_STRN name, MK_WID *value_out)
 These functions look up the value of the child setting named name of the setting setting
 
enum MkErrorE LcSettingLookupString (LC_CFSN setting, MK_STRN name, MK_STRN *value_out)
 These functions look up the value of the child setting named name of the setting setting
 

Overload

#define LcSettingLookupBool_E(...)   MkErrorCheck(LcSettingLookupBool(__VA_ARGS__))
 
#define LcSettingLookupBool_C(...)   if (MkErrorCheckI(LcSettingLookupBool(__VA_ARGS__)))
 
#define LcSettingLookupBool_e(...)   MK_EMBEDDED(MK_BOOL,LcSettingLookupBool,__VA_ARGS__)
 
#define LcSettingLookupFloat_E(...)   MkErrorCheck(LcSettingLookupFloat(__VA_ARGS__))
 
#define LcSettingLookupFloat_C(...)   if (MkErrorCheckI(LcSettingLookupFloat(__VA_ARGS__)))
 
#define LcSettingLookupFloat_e(...)   MK_EMBEDDED(MK_DBL,LcSettingLookupFloat,__VA_ARGS__)
 
#define LcSettingLookupInt_E(...)   MkErrorCheck(LcSettingLookupInt(__VA_ARGS__))
 
#define LcSettingLookupInt_C(...)   if (MkErrorCheckI(LcSettingLookupInt(__VA_ARGS__)))
 
#define LcSettingLookupInt_e(...)   MK_EMBEDDED(MK_INT,LcSettingLookupInt,__VA_ARGS__)
 
#define LcSettingLookupInt64_E(...)   MkErrorCheck(LcSettingLookupInt64(__VA_ARGS__))
 
#define LcSettingLookupInt64_C(...)   if (MkErrorCheckI(LcSettingLookupInt64(__VA_ARGS__)))
 
#define LcSettingLookupInt64_e(...)   MK_EMBEDDED(MK_WID,LcSettingLookupInt64,__VA_ARGS__)
 
#define LcSettingLookupString_E(...)   MkErrorCheck(LcSettingLookupString(__VA_ARGS__))
 
#define LcSettingLookupString_C(...)   if (MkErrorCheckI(LcSettingLookupString(__VA_ARGS__)))
 
#define LcSettingLookupString_e(...)   MK_EMBEDDED(MK_STRN,LcSettingLookupString,__VA_ARGS__)
 

Detailed Description

locates the setting in the configuration and return the data or an LcSettingC

In contrast to LcConfigC_Lookup_C_API, the path relative to the LcSettingC is used here.

Macro Definition Documentation

◆ LcSettingLookupBool_C

#define LcSettingLookupBool_C (   ...)    if (MkErrorCheckI(LcSettingLookupBool(__VA_ARGS__)))

Definition at line 112 of file config_overload_lc.h.

◆ LcSettingLookupBool_E

#define LcSettingLookupBool_E (   ...)    MkErrorCheck(LcSettingLookupBool(__VA_ARGS__))

Definition at line 111 of file config_overload_lc.h.

◆ LcSettingLookupBool_e

#define LcSettingLookupBool_e (   ...)    MK_EMBEDDED(MK_BOOL,LcSettingLookupBool,__VA_ARGS__)

Definition at line 113 of file config_overload_lc.h.

◆ LcSettingLookupFloat_C

#define LcSettingLookupFloat_C (   ...)    if (MkErrorCheckI(LcSettingLookupFloat(__VA_ARGS__)))

Definition at line 115 of file config_overload_lc.h.

◆ LcSettingLookupFloat_E

#define LcSettingLookupFloat_E (   ...)    MkErrorCheck(LcSettingLookupFloat(__VA_ARGS__))

Definition at line 114 of file config_overload_lc.h.

◆ LcSettingLookupFloat_e

#define LcSettingLookupFloat_e (   ...)    MK_EMBEDDED(MK_DBL,LcSettingLookupFloat,__VA_ARGS__)

Definition at line 116 of file config_overload_lc.h.

◆ LcSettingLookupInt64_C

#define LcSettingLookupInt64_C (   ...)    if (MkErrorCheckI(LcSettingLookupInt64(__VA_ARGS__)))

Definition at line 121 of file config_overload_lc.h.

◆ LcSettingLookupInt64_E

#define LcSettingLookupInt64_E (   ...)    MkErrorCheck(LcSettingLookupInt64(__VA_ARGS__))

Definition at line 120 of file config_overload_lc.h.

◆ LcSettingLookupInt64_e

#define LcSettingLookupInt64_e (   ...)    MK_EMBEDDED(MK_WID,LcSettingLookupInt64,__VA_ARGS__)

Definition at line 122 of file config_overload_lc.h.

◆ LcSettingLookupInt_C

#define LcSettingLookupInt_C (   ...)    if (MkErrorCheckI(LcSettingLookupInt(__VA_ARGS__)))

Definition at line 118 of file config_overload_lc.h.

◆ LcSettingLookupInt_E

#define LcSettingLookupInt_E (   ...)    MkErrorCheck(LcSettingLookupInt(__VA_ARGS__))

Definition at line 117 of file config_overload_lc.h.

◆ LcSettingLookupInt_e

#define LcSettingLookupInt_e (   ...)    MK_EMBEDDED(MK_INT,LcSettingLookupInt,__VA_ARGS__)

Definition at line 119 of file config_overload_lc.h.

◆ LcSettingLookupString_C

#define LcSettingLookupString_C (   ...)    if (MkErrorCheckI(LcSettingLookupString(__VA_ARGS__)))

Definition at line 124 of file config_overload_lc.h.

◆ LcSettingLookupString_E

#define LcSettingLookupString_E (   ...)    MkErrorCheck(LcSettingLookupString(__VA_ARGS__))

Definition at line 123 of file config_overload_lc.h.

◆ LcSettingLookupString_e

#define LcSettingLookupString_e (   ...)    MK_EMBEDDED(MK_STRN,LcSettingLookupString,__VA_ARGS__)

Definition at line 125 of file config_overload_lc.h.

Function Documentation

◆ LcSettingLookup()

mk_inline LC_CFS LcSettingLookup ( LC_CFS  setting,
MK_STRN  path 
)
inline

This function locates a setting by a path path relative to the setting setting

It returns a pointer to the LcSettingC structure on success, or NULL if the setting was not found.

Definition at line 386 of file LcSettingC_lc.h.

◆ LcSettingLookupAll()

LC_EXTERN MK_BFL MK_DECL LcSettingLookupAll ( LC_CFSN  setting)
extern

addon - read an entire configuration below setting into MkBufferListC

Returns
instand of MkBufferListC owned by setting.LookupAll() MkBufferListCI

reference for original

◆ LcSettingLookupBool()

mk_inline enum MkErrorE LcSettingLookupBool ( LC_CFSN  setting,
MK_STRN  name,
MK_BOOL value_out 
)
inline

These functions look up the value of the child setting named name of the setting setting

They store the value at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by config_setting_lookup_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingLookupFloat, SettingLookupInt, SettingLookupInt64, SettingLookupString

Definition at line 394 of file LcSettingC_lc.h.

◆ LcSettingLookupBoolP()

LC_EXTERN enum MkErrorE LcSettingLookupBoolP ( LC_CFSN  setting,
MK_STRN  name,
MK_BOOL value_out 
)

Non-inline replacement for LcSettingLookupBool

◆ LcSettingLookupFloat()

mk_inline enum MkErrorE LcSettingLookupFloat ( LC_CFSN  setting,
MK_STRN  name,
MK_DBL value_out 
)
inline

These functions look up the value of the child setting named name of the setting setting

They store the value at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by config_setting_lookup_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingLookupBool, SettingLookupInt, SettingLookupInt64, SettingLookupString

Definition at line 405 of file LcSettingC_lc.h.

◆ LcSettingLookupFloatP()

LC_EXTERN enum MkErrorE LcSettingLookupFloatP ( LC_CFSN  setting,
MK_STRN  name,
MK_DBL value_out 
)

Non-inline replacement for LcSettingLookupFloat

◆ LcSettingLookupInt()

mk_inline enum MkErrorE LcSettingLookupInt ( LC_CFSN  setting,
MK_STRN  name,
MK_INT value_out 
)
inline

These functions look up the value of the child setting named name of the setting setting

They store the value at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by config_setting_lookup_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingLookupBool, SettingLookupFloat, SettingLookupInt64, SettingLookupString

Definition at line 414 of file LcSettingC_lc.h.

◆ LcSettingLookupInt64()

mk_inline enum MkErrorE LcSettingLookupInt64 ( LC_CFSN  setting,
MK_STRN  name,
MK_WID value_out 
)
inline

These functions look up the value of the child setting named name of the setting setting

They store the value at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by config_setting_lookup_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingLookupBool, SettingLookupFloat, SettingLookupInt, SettingLookupString

Definition at line 423 of file LcSettingC_lc.h.

◆ LcSettingLookupInt64P()

LC_EXTERN enum MkErrorE LcSettingLookupInt64P ( LC_CFSN  setting,
MK_STRN  name,
MK_WID value_out 
)

Non-inline replacement for LcSettingLookupInt64

◆ LcSettingLookupIntP()

LC_EXTERN enum MkErrorE LcSettingLookupIntP ( LC_CFSN  setting,
MK_STRN  name,
MK_INT value_out 
)

Non-inline replacement for LcSettingLookupInt

◆ LcSettingLookupP()

LC_EXTERN LC_CFS LcSettingLookupP ( LC_CFS  setting,
MK_STRN  path 
)

Non-inline replacement for LcSettingLookup

◆ LcSettingLookupString()

mk_inline enum MkErrorE LcSettingLookupString ( LC_CFSN  setting,
MK_STRN  name,
MK_STRN value_out 
)
inline

These functions look up the value of the child setting named name of the setting setting

They store the value at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by config_setting_lookup_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingLookupBool, SettingLookupFloat, SettingLookupInt, SettingLookupInt64

Definition at line 434 of file LcSettingC_lc.h.

◆ LcSettingLookupStringP()

LC_EXTERN enum MkErrorE LcSettingLookupStringP ( LC_CFSN  setting,
MK_STRN  name,
MK_STRN value_out 
)

Non-inline replacement for LcSettingLookupString