tcllcconfig 9.0
Loading...
Searching...
No Matches
Functions
LcSettingC_Misc_TCL_API

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

+ Collaboration diagram for LcSettingC_Misc_TCL_API:

Functions

static OT_ProcRet tcl_lcconfig_LcSettingC_AddIfNotExists (LcSettingC_ARGS)
  Tcl: LcSettingC [$setting AddIfNotExists name:string cfgtype:LcConfigTypeE] C-API
addon - add name with type only if not exists in the setting
 
static OT_ProcRet tcl_lcconfig_LcSettingC_Parent (LcSettingC_ARGS)
  Tcl: LcSettingC [$setting Parent] C-API
This function returns the parent setting of the given setting, or NULL if setting is the root setting …
 
static OT_ProcRet tcl_lcconfig_LcSettingC_Exists (LcSettingC_ARGS)
  Tcl: bool [$setting Exists name:string] C-API
addon - return true if name exists in the setting otherwise false
 
static OT_ProcRet tcl_lcconfig_LcSettingC_Index (LcSettingC_ARGS)
  Tcl: int32 [$setting Index] C-API
This function returns the index of the given setting within its parent setting …
 
static OT_ProcRet tcl_lcconfig_LcSettingC_Length (LcSettingC_ARGS)
  Tcl: int32 [$setting Length] C-API
This function returns the number of settings in a group, or the number of elements in a list or array …
 
static OT_ProcRet tcl_lcconfig_LcSettingC_Log (LcSettingC_ARGS)
  Tcl: $setting Log ?fmtobj:MkObjectC=""? ?debug:int32=0? ?callfunc:string=""? ?lvl:int32=0? C-API
log the setting
 
static OT_ProcRet tcl_lcconfig_LcSettingC_Name (LcSettingC_ARGS)
  Tcl: string [$setting Name] C-API
This function returns the name of the given setting, or NULL if the setting has no name …
 
static OT_ProcRet tcl_lcconfig_LcSettingC_Remove (LcSettingC_ARGS)
  Tcl: $parent Remove name:string C-API
This function removes and destroys the setting named name from the parent setting parent, which must be a group …
 
static OT_ProcRet tcl_lcconfig_LcSettingC_RemoveElem (LcSettingC_ARGS)
  Tcl: $parent RemoveElem idx:int32 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 …
 
static OT_ProcRet tcl_lcconfig_LcSettingC_SourceFile (LcSettingC_ARGS)
  Tcl: 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 …
 
static OT_ProcRet tcl_lcconfig_LcSettingC_SourceLine (LcSettingC_ARGS)
  Tcl: int32 [$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 …
 
static OT_ProcRet tcl_lcconfig_LcSettingC_Type (LcSettingC_ARGS)
  Tcl: LcConfigTypeE [$setting Type] C-API
This function returns the type of the given setting
 

Detailed Description

various functions to perform misc operationis on a LcSettingC

Function Documentation

◆ tcl_lcconfig_LcSettingC_AddIfNotExists()

static OT_ProcRet tcl_lcconfig_LcSettingC_AddIfNotExists ( LcSettingC_ARGS  )
static

Tcl: LcSettingC [$setting AddIfNotExists name:string cfgtype:LcConfigTypeE] C-API
addon - add name with type only if not exists in the setting

Definition at line 709 of file LcSettingC_tcl.c.

◆ tcl_lcconfig_LcSettingC_Exists()

static OT_ProcRet tcl_lcconfig_LcSettingC_Exists ( LcSettingC_ARGS  )
static

Tcl: bool [$setting Exists name:string] C-API
addon - return true if name exists in the setting otherwise false

Definition at line 748 of file LcSettingC_tcl.c.

◆ tcl_lcconfig_LcSettingC_Index()

static OT_ProcRet tcl_lcconfig_LcSettingC_Index ( LcSettingC_ARGS  )
static

Tcl: int32 [$setting Index] C-API
This function returns the index of the given setting within its parent setting …

Definition at line 763 of file LcSettingC_tcl.c.

◆ tcl_lcconfig_LcSettingC_Length()

static OT_ProcRet tcl_lcconfig_LcSettingC_Length ( LcSettingC_ARGS  )
static

Tcl: int32 [$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 776 of file LcSettingC_tcl.c.

◆ tcl_lcconfig_LcSettingC_Log()

static OT_ProcRet tcl_lcconfig_LcSettingC_Log ( LcSettingC_ARGS  )
static

◆ tcl_lcconfig_LcSettingC_Name()

static OT_ProcRet tcl_lcconfig_LcSettingC_Name ( LcSettingC_ARGS  )
static

Tcl: 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 816 of file LcSettingC_tcl.c.

◆ tcl_lcconfig_LcSettingC_Parent()

static OT_ProcRet tcl_lcconfig_LcSettingC_Parent ( LcSettingC_ARGS  )
static

Tcl: 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 727 of file LcSettingC_tcl.c.

◆ tcl_lcconfig_LcSettingC_Remove()

static OT_ProcRet tcl_lcconfig_LcSettingC_Remove ( LcSettingC_ARGS  )
static

Tcl: $parent Remove name: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 829 of file LcSettingC_tcl.c.

◆ tcl_lcconfig_LcSettingC_RemoveElem()

static OT_ProcRet tcl_lcconfig_LcSettingC_RemoveElem ( LcSettingC_ARGS  )
static

Tcl: $parent RemoveElem idx:int32 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 845 of file LcSettingC_tcl.c.

◆ tcl_lcconfig_LcSettingC_SourceFile()

static OT_ProcRet tcl_lcconfig_LcSettingC_SourceFile ( LcSettingC_ARGS  )
static

Tcl: 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 861 of file LcSettingC_tcl.c.

◆ tcl_lcconfig_LcSettingC_SourceLine()

static OT_ProcRet tcl_lcconfig_LcSettingC_SourceLine ( LcSettingC_ARGS  )
static

Tcl: int32 [$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 874 of file LcSettingC_tcl.c.

◆ tcl_lcconfig_LcSettingC_Type()

static OT_ProcRet tcl_lcconfig_LcSettingC_Type ( LcSettingC_ARGS  )
static

Tcl: LcConfigTypeE [$setting Type] C-API
This function returns the type of the given setting

Definition at line 887 of file LcSettingC_tcl.c.