LcSettingC_Get_C_API

LcSettingC - various functions to get data from a setting … More...

Collaboration diagram for LcSettingC_Get_C_API:

Functions
LC_CFS	LcSettingGetElem (LC_CFSN setting, MK_I32 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_I32 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_I32 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_PTR	LcSettingGetHookHide (LC_CFSN setting)
	These functions make it possible to attach arbitrary data to each setting structure, for instance a ''wrapper'' or ''peer'' object written in another programming language …
MK_I32	LcSettingGetInt (LC_CFSN setting)
	These functions return the value of the given setting …
MK_I64	LcSettingGetInt64 (LC_CFSN setting)
	These functions return the value of the given setting …
MK_I64	LcSettingGetInt64Elem (LC_CFSN setting, MK_I32 idx)
	These functions return the value at the specified index index in the setting setting …
MK_I32	LcSettingGetIntElem (LC_CFSN setting, MK_I32 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_I32 idx)
	These functions return the value at the specified index index in the setting setting …
LC_CFG	LcSettingGetConfig (LC_CFSN setting)
	addon - return the LcConfigC from the LcSettingC …

LcSettingC - LcSettingC_Get_C_API - function
LC_EXTERN LC_CFS	LcSettingGetElemP (LC_CFSN setting, MK_I32 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_I32 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_I32 idx)
	Non-inline replacement for LcSettingGetFloatElem …
LC_EXTERN enum LcConfigFormatE	LcSettingGetFormatP (LC_CFSN setting)
	Non-inline replacement for LcSettingGetFormat …
LC_EXTERN MK_PTR	LcSettingGetHookHideP (LC_CFSN setting)
	Non-inline replacement for LcSettingGetHookHide …
LC_EXTERN MK_I32	LcSettingGetIntP (LC_CFSN setting)
	Non-inline replacement for LcSettingGetInt …
LC_EXTERN MK_I64	LcSettingGetInt64P (LC_CFSN setting)
	Non-inline replacement for LcSettingGetInt64 …
LC_EXTERN MK_I64	LcSettingGetInt64ElemP (LC_CFSN setting, MK_I32 idx)
	Non-inline replacement for LcSettingGetInt64Elem …
LC_EXTERN MK_I32	LcSettingGetIntElemP (LC_CFSN setting, MK_I32 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_I32 idx)
	Non-inline replacement for LcSettingGetStringElem …

Detailed Description

LcSettingC - various functions to get data from a setting …

Function Documentation

LcSettingGetBool()

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 SettingGetString 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 111 of file LcSettingC_lc.h.

                                                       {
    LC_INSTANCE_HDL(setting);
    return (MK_BOOL)config_setting_get_bool(setting->nat);
  }

LcSettingGetBoolElem()

MK_BOOL LcSettingGetBoolElem ( LC_CFSN setting, MK_I32 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 SettingGetStringElem 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 117 of file LcSettingC_lc.h.

                                                                       {
    LC_INSTANCE_HDL(setting);
    return (MK_BOOL)config_setting_get_bool_elem(setting->nat, idx);
  }

LcSettingGetBoolElemP()

LC_EXTERN MK_BOOL LcSettingGetBoolElemP	(	LC_CFSN	setting,
		MK_I32	idx )

Non-inline replacement for LcSettingGetBoolElem …

LcSettingGetBoolP()

LC_EXTERN MK_BOOL LcSettingGetBoolP

(

LC_CFSN

setting

)

Non-inline replacement for LcSettingGetBool …

LcSettingGetConfig()

LC_CFG LcSettingGetConfig ( LC_CFSN setting )

inline

addon - return the LcConfigC from the LcSettingC …

Definition at line 507 of file LcSettingC_lc.h.

                                                      {
  return LcConfigC_ObjNew(setting->nat->config);
} 

LcSettingGetElem()

LC_CFS LcSettingGetElem ( LC_CFSN setting, MK_I32 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 97 of file LcSettingC_lc.h.

                                                                  {
    LC_INSTANCE_HDL(setting);
    return LcSettingC_ObjNew(config_setting_get_elem(setting->nat, (MK_U32)idx));
  }

LcSettingGetElemP()

LC_EXTERN LC_CFS LcSettingGetElemP	(	LC_CFSN	setting,
		MK_I32	idx )

Non-inline replacement for LcSettingGetElem …

LcSettingGetFloat()

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 SettingGetString 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 123 of file LcSettingC_lc.h.

                                                       {
    LC_INSTANCE_HDL(setting);
    return config_setting_get_float(setting->nat);
  }

LcSettingGetFloatElem()

MK_DBL LcSettingGetFloatElem ( LC_CFSN setting, MK_I32 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 SettingGetStringElem 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 129 of file LcSettingC_lc.h.

                                                                       {
    LC_INSTANCE_HDL(setting);
    return config_setting_get_float_elem(setting->nat, idx);
  }

LcSettingGetFloatElemP()

LC_EXTERN MK_DBL LcSettingGetFloatElemP	(	LC_CFSN	setting,
		MK_I32	idx )

Non-inline replacement for LcSettingGetFloatElem …

LcSettingGetFloatP()

LC_EXTERN MK_DBL LcSettingGetFloatP

(

LC_CFSN

setting

)

Non-inline replacement for LcSettingGetFloat …

LcSettingGetFormat()

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, SettingGetFormat returns the default format for the configuration, as set by ConfigSetDefaultFormat.

SettingSetFormat returns CONFIG_TRUE on success and CONFIG_FALSE on failure.

See also

SettingSetFormat

Definition at line 135 of file LcSettingC_lc.h.

                                                                      {
    LC_INSTANCE_HDL(setting);
    return (enum LcConfigFormatE)config_setting_get_format(setting->nat);
  }

LcSettingGetFormatP()

LC_EXTERN enum LcConfigFormatE LcSettingGetFormatP

(

LC_CFSN

setting

)

Non-inline replacement for LcSettingGetFormat …

LcSettingGetHookHide()

MK_PTR LcSettingGetHookHide ( LC_CFSN setting )

inline

These functions make it possible to attach arbitrary data to each setting structure, for instance a ''wrapper'' or ''peer'' object written in another programming language …

The destructor function, if one has been supplied via a call to config_set_destructor, will be called by the library to dispose of this data when the setting itself is destroyed. There is no default destructor.

See also

config_setting_set_hook

Definition at line 141 of file LcSettingC_lc.h.

                                                          {
    LC_INSTANCE_HDL(setting);
    return (MK_PTR)config_setting_get_hook(setting->nat);
  }

LcSettingGetHookHideP()

LC_EXTERN MK_PTR LcSettingGetHookHideP

(

LC_CFSN

setting

)

Non-inline replacement for LcSettingGetHookHide …

LcSettingGetInt()

MK_I32 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 SettingGetString 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 147 of file LcSettingC_lc.h.

                                                     {
    LC_INSTANCE_HDL(setting);
    return config_setting_get_int(setting->nat);
  }

LcSettingGetInt64()

MK_I64 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 SettingGetString 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 153 of file LcSettingC_lc.h.

                                                       {
    LC_INSTANCE_HDL(setting);
    return config_setting_get_int64(setting->nat);
  }

LcSettingGetInt64Elem()

MK_I64 LcSettingGetInt64Elem ( LC_CFSN setting, MK_I32 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 SettingGetStringElem 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 159 of file LcSettingC_lc.h.

                                                                       {
    LC_INSTANCE_HDL(setting);
    return config_setting_get_int64_elem(setting->nat, idx);
  }

LcSettingGetInt64ElemP()

LC_EXTERN MK_I64 LcSettingGetInt64ElemP	(	LC_CFSN	setting,
		MK_I32	idx )

Non-inline replacement for LcSettingGetInt64Elem …

LcSettingGetInt64P()

LC_EXTERN MK_I64 LcSettingGetInt64P

(

LC_CFSN

setting

)

Non-inline replacement for LcSettingGetInt64 …

LcSettingGetIntElem()

MK_I32 LcSettingGetIntElem ( LC_CFSN setting, MK_I32 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 SettingGetStringElem 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 165 of file LcSettingC_lc.h.

                                                                     {
    LC_INSTANCE_HDL(setting);
    return config_setting_get_int_elem(setting->nat, idx);
  }

LcSettingGetIntElemP()

LC_EXTERN MK_I32 LcSettingGetIntElemP	(	LC_CFSN	setting,
		MK_I32	idx )

Non-inline replacement for LcSettingGetIntElem …

LcSettingGetIntP()

LC_EXTERN MK_I32 LcSettingGetIntP

(

LC_CFSN

setting

)

Non-inline replacement for LcSettingGetInt …

LcSettingGetMember()

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 103 of file LcSettingC_lc.h.

                                                                      {
    LC_INSTANCE_HDL(setting);
    return LcSettingC_ObjNew(config_setting_get_member(setting->nat, name));
  }

LcSettingGetMemberP()

LC_EXTERN LC_CFS LcSettingGetMemberP	(	LC_CFSN	setting,
		MK_STRN	name )

Non-inline replacement for LcSettingGetMember …

LcSettingGetString()

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 SettingGetString 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 171 of file LcSettingC_lc.h.

                                                         {
    LC_INSTANCE_HDL(setting);
    MK_STRN __retVal__L = config_setting_get_string(setting->nat);
    return __retVal__L;
  }

LcSettingGetStringElem()

MK_STRN LcSettingGetStringElem ( LC_CFSN setting, MK_I32 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 SettingGetStringElem 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 178 of file LcSettingC_lc.h.

                                                                         {
    LC_INSTANCE_HDL(setting);
    MK_STRN __retVal__L = config_setting_get_string_elem(setting->nat, idx);
    return __retVal__L;
  }

LcSettingGetStringElemP()

LC_EXTERN MK_STRN LcSettingGetStringElemP	(	LC_CFSN	setting,
		MK_I32	idx )

Non-inline replacement for LcSettingGetStringElem …

LcSettingGetStringP()

LC_EXTERN MK_STRN LcSettingGetStringP

(

LC_CFSN

setting

)

Non-inline replacement for LcSettingGetString …