LcSettingC_Misc_CS_API

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

Collaboration diagram for LcSettingC_Misc_CS_API:

Functions
LcSettingC	cslcconfig.LcSettingC.AddIfNotExists (string name, LcConfigTypeE cfgtype)
	C#: LcSettingC setting.AddIfNotExists(string name, LcConfigTypeE cfgtype) → C-API addon - add name with type only if not exists in the setting …
LcSettingC	cslcconfig.LcSettingC.Parent ()
	C#: LcSettingC setting.Parent() → C-API This function returns the parent setting of the given setting, or NULL if setting is the root setting …
bool	cslcconfig.LcSettingC.Exists (string name)
	C#: bool setting.Exists(string name) → C-API addon - return true if name exists in the setting otherwise false …
int	cslcconfig.LcSettingC.Index ()
	C#: int setting.Index() → C-API This function returns the index of the given setting within its parent setting …
int	cslcconfig.LcSettingC.Length ()
	C#: int setting.Length() → C-API This function returns the number of settings in a group, or the number of elements in a list or array …
string	cslcconfig.LcSettingC.Name ()
	C#: string setting.Name() → C-API This function returns the name of the given setting, or NULL if the setting has no name …
void	cslcconfig.LcSettingC.Remove (string name)
	C#: parent.Remove(string name) → C-API This function removes and destroys the setting named name from the parent setting parent, which must be a group …
void	cslcconfig.LcSettingC.RemoveElem (int idx)
	C#: parent.RemoveElem(int 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 …
string	cslcconfig.LcSettingC.SourceFile ()
	C#: string 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 …
int	cslcconfig.LcSettingC.SourceLine ()
	C#: int 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	cslcconfig.LcSettingC.Type ()
	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()

LcSettingC cslcconfig.LcSettingC.AddIfNotExists ( string name, LcConfigTypeE cfgtype )

inline

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

Definition at line 392 of file LcSettingC.cs.

                                                                           {
      IntPtr name_cstr = Marshal.StringToHGlobalAnsi(name);
      IntPtr __retVal__L = Lc.LcSettingAddIfNotExists(hdl, name_cstr, cfgtype);
      Marshal.FreeHGlobal(name_cstr);
      return LcSettingC.LcSettingC_ObjNew(__retVal__L);
    }

Exists()

bool cslcconfig.LcSettingC.Exists ( string name )

inline

C#: bool setting.Exists(string name) → C-API
addon - return true if name exists in the setting otherwise false …

Definition at line 411 of file LcSettingC.cs.

                                      {
      IntPtr name_cstr = Marshal.StringToHGlobalAnsi(name);
      bool __retVal__L = Lc.LcSettingExists(hdl, name_cstr);
      Marshal.FreeHGlobal(name_cstr);
      return __retVal__L;
    }

Index()

int cslcconfig.LcSettingC.Index ( )

inline

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

Definition at line 419 of file LcSettingC.cs.

                         {
      Int32 __retVal__L = Lc.LcSettingIndex(hdl);
      return __retVal__L;
    }

Length()

int cslcconfig.LcSettingC.Length ( )

inline

C#: int 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 425 of file LcSettingC.cs.

                          {
      Int32 __retVal__L = Lc.LcSettingLength(hdl);
      return __retVal__L;
    }

Name()

string cslcconfig.LcSettingC.Name ( )

inline

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

Definition at line 433 of file LcSettingC.cs.

                           {
      IntPtr __retVal__L = Lc.LcSettingName(hdl);
      return Marshal.PtrToStringAnsi(__retVal__L);
    }

Parent()

LcSettingC cslcconfig.LcSettingC.Parent ( )

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 400 of file LcSettingC.cs.

                                 {
      IntPtr __retVal__L = Lc.LcSettingParent(hdl);
      if (__retVal__L == IntPtr.Zero) {
        throw new MkInitSoftError("LcSettingC.Parent");
      }
      return LcSettingC.LcSettingC_ObjNew(__retVal__L);
    }

Remove()

void cslcconfig.LcSettingC.Remove ( string name )

inline

C#: parent.Remove(string 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 439 of file LcSettingC.cs.

                                      {
      IntPtr name_cstr = Marshal.StringToHGlobalAnsi(name);
      MkErrorE errVal = Lc.LcSettingRemove(hdl, name_cstr);
      Marshal.FreeHGlobal(name_cstr);
      MkErrorC.Check(hdl, errVal);
    }

RemoveElem()

void cslcconfig.LcSettingC.RemoveElem ( int idx )

inline

C#: parent.RemoveElem(int 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 447 of file LcSettingC.cs.

                                      {
      MkErrorE errVal = Lc.LcSettingRemoveElem(hdl, idx);
      MkErrorC.Check(hdl, errVal);
    }

SourceFile()

string cslcconfig.LcSettingC.SourceFile ( )

inline

C#: string 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 453 of file LcSettingC.cs.

                                 {
      IntPtr __retVal__L = Lc.LcSettingSourceFile(hdl);
      return Marshal.PtrToStringAnsi(__retVal__L);
    }

SourceLine()

int cslcconfig.LcSettingC.SourceLine ( )

inline

C#: int 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 459 of file LcSettingC.cs.

                              {
      Int32 __retVal__L = Lc.LcSettingSourceLine(hdl);
      return __retVal__L;
    }

Type()

LcConfigTypeE cslcconfig.LcSettingC.Type ( )

inline

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

Definition at line 465 of file LcSettingC.cs.

                                  {
      LcConfigTypeE __retVal__L = Lc.LcSettingType(hdl);
      return __retVal__L;
    }