rblcconfig 9.0
Loading...
Searching...
No Matches
Functions
LcSettingC_Misc_RB_API

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

+ Collaboration diagram for LcSettingC_Misc_RB_API:

Functions

static OT_ProcRet rb_lcconfig_LcSettingC_AddIfNotExists (LcSettingC_ARGS)
  Ruby: LcSettingC setting.AddIfNotExists(name:string, cfgtype:LcConfigTypeE) C-API
addon - add name with type only if not exists in the setting
 
static OT_ProcRet rb_lcconfig_LcSettingC_Parent (LcSettingC_ARGS)
  Ruby: 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 rb_lcconfig_LcSettingC_Exists (LcSettingC_ARGS)
  Ruby: bool setting.Exists(name:string) C-API
addon - return true if name exists in the setting otherwise false
 
static OT_ProcRet rb_lcconfig_LcSettingC_Index (LcSettingC_ARGS)
  Ruby: int32 setting.Index() C-API
This function returns the index of the given setting within its parent setting …
 
static OT_ProcRet rb_lcconfig_LcSettingC_Length (LcSettingC_ARGS)
  Ruby: 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 rb_lcconfig_LcSettingC_Log (LcSettingC_ARGS)
  Ruby: setting.Log(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string=""?, ?lvl:int32=0?) C-API
log the setting
 
static OT_ProcRet rb_lcconfig_LcSettingC_Name (LcSettingC_ARGS)
  Ruby: 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 rb_lcconfig_LcSettingC_Remove (LcSettingC_ARGS)
  Ruby: 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 rb_lcconfig_LcSettingC_RemoveElem (LcSettingC_ARGS)
  Ruby: 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 rb_lcconfig_LcSettingC_SourceFile (LcSettingC_ARGS)
  Ruby: 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 rb_lcconfig_LcSettingC_SourceLine (LcSettingC_ARGS)
  Ruby: 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 rb_lcconfig_LcSettingC_Type (LcSettingC_ARGS)
  Ruby: 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

◆ rb_lcconfig_LcSettingC_AddIfNotExists()

static OT_ProcRet rb_lcconfig_LcSettingC_AddIfNotExists ( LcSettingC_ARGS  )
static

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

Definition at line 684 of file LcSettingC_ruby.c.

◆ rb_lcconfig_LcSettingC_Exists()

static OT_ProcRet rb_lcconfig_LcSettingC_Exists ( LcSettingC_ARGS  )
static

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

Definition at line 723 of file LcSettingC_ruby.c.

◆ rb_lcconfig_LcSettingC_Index()

static OT_ProcRet rb_lcconfig_LcSettingC_Index ( LcSettingC_ARGS  )
static

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

Definition at line 738 of file LcSettingC_ruby.c.

◆ rb_lcconfig_LcSettingC_Length()

static OT_ProcRet rb_lcconfig_LcSettingC_Length ( LcSettingC_ARGS  )
static

Ruby: 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 751 of file LcSettingC_ruby.c.

◆ rb_lcconfig_LcSettingC_Log()

static OT_ProcRet rb_lcconfig_LcSettingC_Log ( LcSettingC_ARGS  )
static

◆ rb_lcconfig_LcSettingC_Name()

static OT_ProcRet rb_lcconfig_LcSettingC_Name ( LcSettingC_ARGS  )
static

Ruby: 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 791 of file LcSettingC_ruby.c.

◆ rb_lcconfig_LcSettingC_Parent()

static OT_ProcRet rb_lcconfig_LcSettingC_Parent ( LcSettingC_ARGS  )
static

Ruby: 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 702 of file LcSettingC_ruby.c.

◆ rb_lcconfig_LcSettingC_Remove()

static OT_ProcRet rb_lcconfig_LcSettingC_Remove ( LcSettingC_ARGS  )
static

Ruby: 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 804 of file LcSettingC_ruby.c.

◆ rb_lcconfig_LcSettingC_RemoveElem()

static OT_ProcRet rb_lcconfig_LcSettingC_RemoveElem ( LcSettingC_ARGS  )
static

Ruby: 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 820 of file LcSettingC_ruby.c.

◆ rb_lcconfig_LcSettingC_SourceFile()

static OT_ProcRet rb_lcconfig_LcSettingC_SourceFile ( LcSettingC_ARGS  )
static

Ruby: 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 836 of file LcSettingC_ruby.c.

◆ rb_lcconfig_LcSettingC_SourceLine()

static OT_ProcRet rb_lcconfig_LcSettingC_SourceLine ( LcSettingC_ARGS  )
static

Ruby: 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 849 of file LcSettingC_ruby.c.

◆ rb_lcconfig_LcSettingC_Type()

static OT_ProcRet rb_lcconfig_LcSettingC_Type ( LcSettingC_ARGS  )
static

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

Definition at line 862 of file LcSettingC_ruby.c.