vblcconfig 9.0
Loading...
Searching...
No Matches
Functions
LcSettingC_Misc_CS_API

various functions to perform misc operationis on a LcSettingC More...

+ Collaboration diagram for LcSettingC_Misc_CS_API:

Functions

LcSettingC csmsgque.lcconfig.LcSettingC.AddIfNotExists (string name, LcConfigTypeE cfgtype)
  Vb.Net: setting.AddIfNotExists(name As String, cfgtype As LcConfigTypeE) As LcSettingC C-API
addon - add name with type only if not exists in the setting
 
LcSettingC csmsgque.lcconfig.LcSettingC.Parent ()
  Vb.Net: setting.Parent() As LcSettingC C-API
This function returns the parent setting of the given setting, or NULL if setting is the root setting …
 
bool csmsgque.lcconfig.LcSettingC.Exists (string name)
  Vb.Net: setting.Exists(name As String) As Boolean C-API
addon - return true if name exists in the setting otherwise false
 
int csmsgque.lcconfig.LcSettingC.Index ()
  Vb.Net: setting.Index() As Integer C-API
This function returns the index of the given setting within its parent setting …
 
int csmsgque.lcconfig.LcSettingC.Length ()
  Vb.Net: setting.Length() As Integer C-API
This function returns the number of settings in a group, or the number of elements in a list or array …
 
new void csmsgque.lcconfig.LcSettingC.Log (MkObjectC fmtobj=null, int debug=0, [CallerMemberName]string callfunc=null, int lvl=0)
  Vb.Net: setting.Log(Optional fmtobj As MkObjectC = null, Optional debug As Integer = 0, Optional callfunc As String = FUNC, Optional lvl As Integer = 0) C-API
log the setting
 
string csmsgque.lcconfig.LcSettingC.Name ()
  Vb.Net: setting.Name() As String C-API
This function returns the name of the given setting, or NULL if the setting has no name …
 
void csmsgque.lcconfig.LcSettingC.Remove (string name)
  Vb.Net: parent.Remove(name As String) C-API
This function removes and destroys the setting named name from the parent setting parent, which must be a group …
 
void csmsgque.lcconfig.LcSettingC.RemoveElem (int idx)
  Vb.Net: parent.RemoveElem(idx As Integer) 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 csmsgque.lcconfig.LcSettingC.SourceFile ()
  Vb.Net: setting.SourceFile() As String 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 csmsgque.lcconfig.LcSettingC.SourceLine ()
  Vb.Net: setting.SourceLine() As Integer 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 csmsgque.lcconfig.LcSettingC.Type ()
  Vb.Net: setting.Type() As LcConfigTypeE C-API
This function returns the type of the given setting
 

Detailed Description

various functions to perform misc operationis on a LcSettingC

Function Documentation

◆ AddIfNotExists()

LcSettingC csmsgque.lcconfig.LcSettingC.AddIfNotExists ( string  name,
LcConfigTypeE  cfgtype 
)
inline

Vb.Net: setting.AddIfNotExists(name As String, cfgtype As LcConfigTypeE) As LcSettingC C-API
addon - add name with type only if not exists in the setting

Definition at line 342 of file LcSettingC.cs.

◆ Exists()

bool csmsgque.lcconfig.LcSettingC.Exists ( string  name)
inline

Vb.Net: setting.Exists(name As String) As Boolean C-API
addon - return true if name exists in the setting otherwise false

Definition at line 360 of file LcSettingC.cs.

◆ Index()

int csmsgque.lcconfig.LcSettingC.Index ( )
inline

Vb.Net: setting.Index() As Integer C-API
This function returns the index of the given setting within its parent setting …

Definition at line 366 of file LcSettingC.cs.

◆ Length()

int csmsgque.lcconfig.LcSettingC.Length ( )
inline

Vb.Net: setting.Length() As Integer 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 372 of file LcSettingC.cs.

◆ Log()

new void csmsgque.lcconfig.LcSettingC.Log ( MkObjectC  fmtobj = null,
int  debug = 0,
[CallerMemberName] string  callfunc = null,
int  lvl = 0 
)
inline

◆ Name()

string csmsgque.lcconfig.LcSettingC.Name ( )
inline

Vb.Net: setting.Name() As String C-API
This function returns the name of the given setting, or NULL if the setting has no name …

Definition at line 385 of file LcSettingC.cs.

◆ Parent()

LcSettingC csmsgque.lcconfig.LcSettingC.Parent ( )
inline

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

Definition at line 348 of file LcSettingC.cs.

◆ Remove()

void csmsgque.lcconfig.LcSettingC.Remove ( string  name)
inline

Vb.Net: parent.Remove(name As String) C-API
This function removes and destroys the setting named name from the parent setting parent, which must be a group …

Definition at line 391 of file LcSettingC.cs.

◆ RemoveElem()

void csmsgque.lcconfig.LcSettingC.RemoveElem ( int  idx)
inline

Vb.Net: parent.RemoveElem(idx As Integer) 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 397 of file LcSettingC.cs.

◆ SourceFile()

string csmsgque.lcconfig.LcSettingC.SourceFile ( )
inline

Vb.Net: setting.SourceFile() As String 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 403 of file LcSettingC.cs.

◆ SourceLine()

int csmsgque.lcconfig.LcSettingC.SourceLine ( )
inline

Vb.Net: setting.SourceLine() As Integer 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 409 of file LcSettingC.cs.

◆ Type()

LcConfigTypeE csmsgque.lcconfig.LcSettingC.Type ( )
inline

Vb.Net: setting.Type() As LcConfigTypeE C-API
This function returns the type of the given setting

Definition at line 415 of file LcSettingC.cs.