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

various functions to get data from a LcSettingC More...

+ Collaboration diagram for LcSettingC_Get_C_API:

Functions

LC_EXTERN LC_CFG LcSettingGetConfigP (LC_CFS setting)
 Non-inline replacement for LcSettingGetConfig
 
LC_EXTERN LC_CFS LcSettingGetElemP (LC_CFSN setting, MK_INT idx)
 Non-inline replacement for LcSettingGetElem
 
LC_EXTERN LC_CFS LcSettingGetMemberP (LC_CFSN setting, MK_STRN name)
 Non-inline replacement for LcSettingGetMember
 
LC_EXTERN MK_BOOL LcSettingGetBoolP (LC_CFSN setting)
 Non-inline replacement for LcSettingGetBool
 
LC_EXTERN MK_BOOL LcSettingGetBoolElemP (LC_CFSN setting, MK_INT idx)
 Non-inline replacement for LcSettingGetBoolElem
 
LC_EXTERN MK_DBL LcSettingGetFloatP (LC_CFSN setting)
 Non-inline replacement for LcSettingGetFloat
 
LC_EXTERN MK_DBL LcSettingGetFloatElemP (LC_CFSN setting, MK_INT idx)
 Non-inline replacement for LcSettingGetFloatElem
 
LC_EXTERN enum LcConfigFormatE LcSettingGetFormatP (LC_CFSN setting)
 Non-inline replacement for LcSettingGetFormat
 
LC_EXTERN MK_INT LcSettingGetIntP (LC_CFSN setting)
 Non-inline replacement for LcSettingGetInt
 
LC_EXTERN MK_WID LcSettingGetInt64P (LC_CFSN setting)
 Non-inline replacement for LcSettingGetInt64
 
LC_EXTERN MK_WID LcSettingGetInt64ElemP (LC_CFSN setting, MK_INT idx)
 Non-inline replacement for LcSettingGetInt64Elem
 
LC_EXTERN MK_INT LcSettingGetIntElemP (LC_CFSN setting, MK_INT idx)
 Non-inline replacement for LcSettingGetIntElem
 
LC_EXTERN MK_STRN LcSettingGetStringP (LC_CFSN setting)
 Non-inline replacement for LcSettingGetString
 
LC_EXTERN MK_STRN LcSettingGetStringElemP (LC_CFSN setting, MK_INT idx)
 Non-inline replacement for LcSettingGetStringElem
 
LC_CFS LcSettingGetElem (LC_CFSN setting, MK_INT idx)
 This function fetches the element at the given index index in the setting setting, which must be an array, list, or group …
 
LC_CFS LcSettingGetMember (LC_CFSN setting, MK_STRN name)
 This function fetches the child setting named name from the group setting
 
MK_BOOL LcSettingGetBool (LC_CFSN setting)
 These functions return the value of the given setting
 
MK_BOOL LcSettingGetBoolElem (LC_CFSN setting, MK_INT idx)
 These functions return the value at the specified index index in the setting setting
 
MK_DBL LcSettingGetFloat (LC_CFSN setting)
 These functions return the value of the given setting
 
MK_DBL LcSettingGetFloatElem (LC_CFSN setting, MK_INT idx)
 These functions return the value at the specified index index in the setting setting
 
enum LcConfigFormatE LcSettingGetFormat (LC_CFSN setting)
 These functions get and set the external format for the setting setting
 
MK_INT LcSettingGetInt (LC_CFSN setting)
 These functions return the value of the given setting
 
MK_WID LcSettingGetInt64 (LC_CFSN setting)
 These functions return the value of the given setting
 
MK_WID LcSettingGetInt64Elem (LC_CFSN setting, MK_INT idx)
 These functions return the value at the specified index index in the setting setting
 
MK_INT LcSettingGetIntElem (LC_CFSN setting, MK_INT idx)
 These functions return the value at the specified index index in the setting setting
 
MK_STRN LcSettingGetString (LC_CFSN setting)
 These functions return the value of the given setting
 
MK_STRN LcSettingGetStringElem (LC_CFSN setting, MK_INT idx)
 These functions return the value at the specified index index in the setting setting
 
LC_CFG LcSettingGetConfig (LC_CFS setting)
 addon - return the LcConfigC from the LcSettingC
 

Detailed Description

various functions to get data from a LcSettingC

Function Documentation

◆ LcSettingGetBool()

mk_inline MK_BOOL LcSettingGetBool ( LC_CFSN  setting)
inline

These functions return the value of the given setting

If the type of the setting does not match the type requested, a 0 or NULL value is returned. Storage for the string returned by config_setting_get_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
SettingGetFloat, SettingGetInt, SettingGetInt64, SettingGetString

Definition at line 282 of file LcSettingC_lc.h.

◆ LcSettingGetBoolElem()

mk_inline MK_BOOL LcSettingGetBoolElem ( LC_CFSN  setting,
MK_INT  idx 
)
inline

These functions return the value at the specified index index in the setting setting

If the setting is not an array or list, or if the type of the element does not match the type requested, or if index is out of range, they return 0 or NULL. Storage for the string returned by config_setting_get_string_elem is managed by the library and released automatically when the setting is destroyed or when its value is changed; the string must not be freed by the caller.

See also
SettingGetFloatElem, SettingGetInt64Elem, SettingGetIntElem, SettingGetStringElem

Definition at line 287 of file LcSettingC_lc.h.

◆ LcSettingGetBoolElemP()

LC_EXTERN MK_BOOL LcSettingGetBoolElemP ( LC_CFSN  setting,
MK_INT  idx 
)

Non-inline replacement for LcSettingGetBoolElem

◆ LcSettingGetBoolP()

LC_EXTERN MK_BOOL LcSettingGetBoolP ( LC_CFSN  setting)

Non-inline replacement for LcSettingGetBool

◆ LcSettingGetConfig()

mk_inline LC_CFG LcSettingGetConfig ( LC_CFS  setting)
inline

addon - return the LcConfigC from the LcSettingC

reference for original

Definition at line 625 of file LcSettingC_lc.h.

◆ LcSettingGetConfigP()

LC_EXTERN LC_CFG LcSettingGetConfigP ( LC_CFS  setting)

Non-inline replacement for LcSettingGetConfig

◆ LcSettingGetElem()

mk_inline LC_CFS LcSettingGetElem ( LC_CFSN  setting,
MK_INT  idx 
)
inline

This function fetches the element at the given index index in the setting setting, which must be an array, list, or group …

It returns the requested setting on success, or NULL if index is out of range or if setting is not an array, list, or group.

Definition at line 269 of file LcSettingC_lc.h.

◆ LcSettingGetElemP()

LC_EXTERN LC_CFS LcSettingGetElemP ( LC_CFSN  setting,
MK_INT  idx 
)

Non-inline replacement for LcSettingGetElem

◆ LcSettingGetFloat()

mk_inline MK_DBL LcSettingGetFloat ( LC_CFSN  setting)
inline

These functions return the value of the given setting

If the type of the setting does not match the type requested, a 0 or NULL value is returned. Storage for the string returned by config_setting_get_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
SettingGetBool, SettingGetInt, SettingGetInt64, SettingGetString

Definition at line 292 of file LcSettingC_lc.h.

◆ LcSettingGetFloatElem()

mk_inline MK_DBL LcSettingGetFloatElem ( LC_CFSN  setting,
MK_INT  idx 
)
inline

These functions return the value at the specified index index in the setting setting

If the setting is not an array or list, or if the type of the element does not match the type requested, or if index is out of range, they return 0 or NULL. Storage for the string returned by config_setting_get_string_elem is managed by the library and released automatically when the setting is destroyed or when its value is changed; the string must not be freed by the caller.

See also
SettingGetBoolElem, SettingGetInt64Elem, SettingGetIntElem, SettingGetStringElem

Definition at line 297 of file LcSettingC_lc.h.

◆ LcSettingGetFloatElemP()

LC_EXTERN MK_DBL LcSettingGetFloatElemP ( LC_CFSN  setting,
MK_INT  idx 
)

Non-inline replacement for LcSettingGetFloatElem

◆ LcSettingGetFloatP()

LC_EXTERN MK_DBL LcSettingGetFloatP ( LC_CFSN  setting)

Non-inline replacement for LcSettingGetFloat

◆ LcSettingGetFormat()

mk_inline enum LcConfigFormatE LcSettingGetFormat ( LC_CFSN  setting)
inline

These functions get and set the external format for the setting setting

The format must be one of the constants CONFIG_FORMAT_DEFAULT or CONFIG_FORMAT_HEX. All settings support the CONFIG_FORMAT_DEFAULT format. The CONFIG_FORMAT_HEX format specifies hexadecimal formatting for integer values, and hence only applies to settings of type CONFIG_TYPE_INT and CONFIG_TYPE_INT64. If format is invalid for the given setting, it is ignored.

If a non-default format has not been set for the setting, config_setting_get_format returns the default format for the configuration, as set by ConfigSetDefaultFormat.

config_setting_set_format returns CONFIG_TRUE on success and CONFIG_FALSE on failure.

See also
SettingSetFormat

Definition at line 302 of file LcSettingC_lc.h.

◆ LcSettingGetFormatP()

LC_EXTERN enum LcConfigFormatE LcSettingGetFormatP ( LC_CFSN  setting)

Non-inline replacement for LcSettingGetFormat

◆ LcSettingGetInt()

mk_inline MK_INT LcSettingGetInt ( LC_CFSN  setting)
inline

These functions return the value of the given setting

If the type of the setting does not match the type requested, a 0 or NULL value is returned. Storage for the string returned by config_setting_get_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
SettingGetBool, SettingGetFloat, SettingGetInt64, SettingGetString

Definition at line 307 of file LcSettingC_lc.h.

◆ LcSettingGetInt64()

mk_inline MK_WID LcSettingGetInt64 ( LC_CFSN  setting)
inline

These functions return the value of the given setting

If the type of the setting does not match the type requested, a 0 or NULL value is returned. Storage for the string returned by config_setting_get_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
SettingGetBool, SettingGetFloat, SettingGetInt, SettingGetString

Definition at line 312 of file LcSettingC_lc.h.

◆ LcSettingGetInt64Elem()

mk_inline MK_WID LcSettingGetInt64Elem ( LC_CFSN  setting,
MK_INT  idx 
)
inline

These functions return the value at the specified index index in the setting setting

If the setting is not an array or list, or if the type of the element does not match the type requested, or if index is out of range, they return 0 or NULL. Storage for the string returned by config_setting_get_string_elem is managed by the library and released automatically when the setting is destroyed or when its value is changed; the string must not be freed by the caller.

See also
SettingGetBoolElem, SettingGetFloatElem, SettingGetIntElem, SettingGetStringElem

Definition at line 317 of file LcSettingC_lc.h.

◆ LcSettingGetInt64ElemP()

LC_EXTERN MK_WID LcSettingGetInt64ElemP ( LC_CFSN  setting,
MK_INT  idx 
)

Non-inline replacement for LcSettingGetInt64Elem

◆ LcSettingGetInt64P()

LC_EXTERN MK_WID LcSettingGetInt64P ( LC_CFSN  setting)

Non-inline replacement for LcSettingGetInt64

◆ LcSettingGetIntElem()

mk_inline MK_INT LcSettingGetIntElem ( LC_CFSN  setting,
MK_INT  idx 
)
inline

These functions return the value at the specified index index in the setting setting

If the setting is not an array or list, or if the type of the element does not match the type requested, or if index is out of range, they return 0 or NULL. Storage for the string returned by config_setting_get_string_elem is managed by the library and released automatically when the setting is destroyed or when its value is changed; the string must not be freed by the caller.

See also
SettingGetBoolElem, SettingGetFloatElem, SettingGetInt64Elem, SettingGetStringElem

Definition at line 322 of file LcSettingC_lc.h.

◆ LcSettingGetIntElemP()

LC_EXTERN MK_INT LcSettingGetIntElemP ( LC_CFSN  setting,
MK_INT  idx 
)

Non-inline replacement for LcSettingGetIntElem

◆ LcSettingGetIntP()

LC_EXTERN MK_INT LcSettingGetIntP ( LC_CFSN  setting)

Non-inline replacement for LcSettingGetInt

◆ LcSettingGetMember()

mk_inline LC_CFS LcSettingGetMember ( LC_CFSN  setting,
MK_STRN  name 
)
inline

This function fetches the child setting named name from the group setting

It returns the requested setting on success, or NULL if the setting was not found or if setting is not a group.

Definition at line 274 of file LcSettingC_lc.h.

◆ LcSettingGetMemberP()

LC_EXTERN LC_CFS LcSettingGetMemberP ( LC_CFSN  setting,
MK_STRN  name 
)

Non-inline replacement for LcSettingGetMember

◆ LcSettingGetString()

mk_inline MK_STRN LcSettingGetString ( LC_CFSN  setting)
inline

These functions return the value of the given setting

If the type of the setting does not match the type requested, a 0 or NULL value is returned. Storage for the string returned by config_setting_get_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
SettingGetBool, SettingGetFloat, SettingGetInt, SettingGetInt64

Definition at line 327 of file LcSettingC_lc.h.

◆ LcSettingGetStringElem()

mk_inline MK_STRN LcSettingGetStringElem ( LC_CFSN  setting,
MK_INT  idx 
)
inline

These functions return the value at the specified index index in the setting setting

If the setting is not an array or list, or if the type of the element does not match the type requested, or if index is out of range, they return 0 or NULL. Storage for the string returned by config_setting_get_string_elem is managed by the library and released automatically when the setting is destroyed or when its value is changed; the string must not be freed by the caller.

See also
SettingGetBoolElem, SettingGetFloatElem, SettingGetInt64Elem, SettingGetIntElem

Definition at line 333 of file LcSettingC_lc.h.

◆ LcSettingGetStringElemP()

LC_EXTERN MK_STRN LcSettingGetStringElemP ( LC_CFSN  setting,
MK_INT  idx 
)

Non-inline replacement for LcSettingGetStringElem

◆ LcSettingGetStringP()

LC_EXTERN MK_STRN LcSettingGetStringP ( LC_CFSN  setting)

Non-inline replacement for LcSettingGetString