LcSettingC_Misc_CC_API

LcSettingC - various functions to perform misc operations … More...

Collaboration diagram for LcSettingC_Misc_CC_API:

Functions
LcSettingC *	cclcconfig::LcSettingC::AddIfNotExists (MK_STRN name, LcConfigTypeE cfgtype)
	C++: LcSettingC* setting.AddIfNotExists(MK_STRN name, LcConfigTypeE cfgtype) → C-API addon - add name with type only if not exists in the setting …
LcSettingC *	cclcconfig::LcSettingC::AddIfNotExists (const std::string &name, LcConfigTypeE cfgtype)
	C++: LcSettingC* setting.AddIfNotExists(MK_STRN name, LcConfigTypeE cfgtype) → C-API addon - add name with type only if not exists in the setting …
LcSettingC *	cclcconfig::LcSettingC::Parent () const
	C++: LcSettingC* setting.Parent() → C-API This function returns the parent setting of the given setting, or NULL if setting is the root setting …
MK_BOOL	cclcconfig::LcSettingC::Exists (MK_STRN name)
	C++: MK_BOOL setting.Exists(MK_STRN name) → C-API addon - return true if name exists in the setting otherwise false …
MK_BOOL	cclcconfig::LcSettingC::Exists (const std::string &name)
	C++: MK_BOOL setting.Exists(MK_STRN name) → C-API addon - return true if name exists in the setting otherwise false …
MK_I32	cclcconfig::LcSettingC::Index () const
	C++: MK_I32 setting.Index() → C-API This function returns the index of the given setting within its parent setting …
MK_I32	cclcconfig::LcSettingC::Length () const
	C++: MK_I32 setting.Length() → C-API This function returns the number of settings in a group, or the number of elements in a list or array …
MK_STRN	cclcconfig::LcSettingC::Name () const
	C++: MK_STRN setting.Name() → C-API This function returns the name of the given setting, or NULL if the setting has no name …
void	cclcconfig::LcSettingC::Remove (MK_STRN name)
	C++: parent.Remove(MK_STRN name) → C-API This function removes and destroys the setting named name from the parent setting parent, which must be a group …
void	cclcconfig::LcSettingC::Remove (const std::string &name)
	C++: parent.Remove(MK_STRN name) → C-API This function removes and destroys the setting named name from the parent setting parent, which must be a group …
void	cclcconfig::LcSettingC::RemoveElem (MK_I32 idx)
	C++: parent.RemoveElem(MK_I32 idx) → C-API This function removes the child setting at the given index index from the setting parent, which must be a group, list, or array …
MK_STRN	cclcconfig::LcSettingC::SourceFile () const
	C++: MK_STRN setting.SourceFile() → C-API This function returns the name of the file from which the setting setting was read, or NULL if the setting was not read from a file …
MK_I32	cclcconfig::LcSettingC::SourceLine () const
	C++: MK_I32 setting.SourceLine() → C-API This function returns the line number of the configuration file or stream at which the setting setting was read, or 0 if no line number is available …
LcConfigTypeE	cclcconfig::LcSettingC::Type () const
	C++: LcConfigTypeE setting.Type() → C-API This function returns the type of the given setting …

Detailed Description

LcSettingC - various functions to perform misc operations …

Function Documentation

AddIfNotExists() [1/2]

LcSettingC * cclcconfig::LcSettingC::AddIfNotExists ( const std::string & name, LcConfigTypeE cfgtype )

inline

C++: LcSettingC* setting.AddIfNotExists(MK_STRN name, LcConfigTypeE cfgtype) → C-API
addon - add name with type only if not exists in the setting …

Definition at line 425 of file LcSettingC_inline_cc.hh.

                                                                                              {
    MK_UNUSED auto setting = getCFS();
    const MK_STRN name_hdl = name.c_str();
    LC_CFS __retVal__L = LcSettingAddIfNotExists(setting, name_hdl, cfgtype);
    return LcSettingC::LcSettingC_ObjNew(MK_RT_CALL __retVal__L);
  }

AddIfNotExists() [2/2]

LcSettingC * cclcconfig::LcSettingC::AddIfNotExists ( MK_STRN name, LcConfigTypeE cfgtype )

inline

C++: LcSettingC* setting.AddIfNotExists(MK_STRN name, LcConfigTypeE cfgtype) → C-API
addon - add name with type only if not exists in the setting …

Definition at line 418 of file LcSettingC_inline_cc.hh.

                                                                                     {
    MK_UNUSED auto setting = getCFS();
    LC_CFS __retVal__L = LcSettingAddIfNotExists(setting, name, cfgtype);
    return LcSettingC::LcSettingC_ObjNew(MK_RT_CALL __retVal__L);
  }

Exists() [1/2]

MK_BOOL cclcconfig::LcSettingC::Exists ( const std::string & name )

inline

C++: MK_BOOL setting.Exists(MK_STRN name) → C-API
addon - return true if name exists in the setting otherwise false …

Definition at line 452 of file LcSettingC_inline_cc.hh.

                                                           {
    MK_UNUSED auto setting = getCFS();
    const MK_STRN name_hdl = name.c_str();
    MK_BOOL __retVal__L = LcSettingExists(setting, name_hdl);
    return __retVal__L;
  }

Exists() [2/2]

MK_BOOL cclcconfig::LcSettingC::Exists ( MK_STRN name )

inline

C++: MK_BOOL setting.Exists(MK_STRN name) → C-API
addon - return true if name exists in the setting otherwise false …

Definition at line 445 of file LcSettingC_inline_cc.hh.

                                                  {
    MK_UNUSED auto setting = getCFS();
    MK_BOOL __retVal__L = LcSettingExists(setting, name);
    return __retVal__L;
  }

Index()

MK_I32 cclcconfig::LcSettingC::Index ( ) const

inline

C++: MK_I32 setting.Index() → C-API
This function returns the index of the given setting within its parent setting …

Definition at line 460 of file LcSettingC_inline_cc.hh.

                                         {
    MK_UNUSED auto setting = getCFSN();
    MK_I32 __retVal__L = LcSettingIndex(setting);
    return __retVal__L;
  }

Length()

MK_I32 cclcconfig::LcSettingC::Length ( ) const

inline

C++: MK_I32 setting.Length() → C-API
This function returns the number of settings in a group, or the number of elements in a list or array …

Definition at line 467 of file LcSettingC_inline_cc.hh.

                                          {
    MK_UNUSED auto setting = getCFSN();
    MK_I32 __retVal__L = LcSettingLength(setting);
    return __retVal__L;
  }

Name()

MK_STRN cclcconfig::LcSettingC::Name ( ) const

inline

C++: MK_STRN setting.Name() → C-API
This function returns the name of the given setting, or NULL if the setting has no name …

Definition at line 478 of file LcSettingC_inline_cc.hh.

                                         {
    MK_UNUSED auto setting = getCFSN();
    MK_STRN __retVal__L = LcSettingName(setting);
    return __retVal__L;
  }

Parent()

LcSettingC * cclcconfig::LcSettingC::Parent ( ) const

inline

C++: LcSettingC* setting.Parent() → C-API
This function returns the parent setting of the given setting, or NULL if setting is the root setting …

Definition at line 433 of file LcSettingC_inline_cc.hh.

                                               {
    MK_UNUSED auto setting = getCFSN();
    LC_CFS __retVal__L = LcSettingParent(setting);
    if (__retVal__L == NULL) {
      throw MkInitSoftError("LcSettingC::Parent");
    }
    return LcSettingC::LcSettingC_ObjNew(MK_RT_CALL __retVal__L);
  }

Remove() [1/2]

void cclcconfig::LcSettingC::Remove ( const std::string & name )

inline

C++: parent.Remove(MK_STRN name) → C-API
This function removes and destroys the setting named name from the parent setting parent, which must be a group …

Definition at line 492 of file LcSettingC_inline_cc.hh.

                                                        {
    MK_UNUSED auto parent = getCFS();
    const MK_STRN name_hdl = name.c_str();
    enum MkErrorE errVal = LcSettingRemove(parent, name_hdl);
    MkErrorC_Check(parent, errVal);
  }

Remove() [2/2]

void cclcconfig::LcSettingC::Remove ( MK_STRN name )

inline

C++: parent.Remove(MK_STRN name) → C-API
This function removes and destroys the setting named name from the parent setting parent, which must be a group …

Definition at line 485 of file LcSettingC_inline_cc.hh.

                                               {
    MK_UNUSED auto parent = getCFS();
    enum MkErrorE errVal = LcSettingRemove(parent, name);
    MkErrorC_Check(parent, errVal);
  }

RemoveElem()

void cclcconfig::LcSettingC::RemoveElem ( MK_I32 idx )

inline

C++: parent.RemoveElem(MK_I32 idx) → C-API
This function removes the child setting at the given index index from the setting parent, which must be a group, list, or array …

Definition at line 500 of file LcSettingC_inline_cc.hh.

                                                 {
    MK_UNUSED auto parent = getCFS();
    enum MkErrorE errVal = LcSettingRemoveElem(parent, idx);
    MkErrorC_Check(parent, errVal);
  }

SourceFile()

MK_STRN cclcconfig::LcSettingC::SourceFile ( ) const

inline

C++: MK_STRN setting.SourceFile() → C-API
This function returns the name of the file from which the setting setting was read, or NULL if the setting was not read from a file …

Definition at line 507 of file LcSettingC_inline_cc.hh.

                                               {
    MK_UNUSED auto setting = getCFSN();
    MK_STRN __retVal__L = LcSettingSourceFile(setting);
    return __retVal__L;
  }

SourceLine()

MK_I32 cclcconfig::LcSettingC::SourceLine ( ) const

inline

C++: MK_I32 setting.SourceLine() → C-API
This function returns the line number of the configuration file or stream at which the setting setting was read, or 0 if no line number is available …

Definition at line 514 of file LcSettingC_inline_cc.hh.

                                              {
    MK_UNUSED auto setting = getCFSN();
    MK_I32 __retVal__L = LcSettingSourceLine(setting);
    return __retVal__L;
  }

Type()

LcConfigTypeE cclcconfig::LcSettingC::Type ( ) const

inline

C++: LcConfigTypeE setting.Type() → C-API
This function returns the type of the given setting …

Definition at line 521 of file LcSettingC_inline_cc.hh.

                                               {
    MK_UNUSED auto setting = getCFSN();
    enum LcConfigTypeE __retVal__L = LcSettingType(setting);
    return __retVal__L;
  }