perllcconfig 9.0
Loading...
Searching...
No Matches
Functions
LcSettingC_Misc_PL_API

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

Functions

void LcSettingC_AddIfNotExists (LcSettingC hdl, MK_STRN name, LcConfigTypeE cfgtype)
  Perl: LcSettingC $setting->AddIfNotExists(string name, LcConfigTypeE cfgtype) C-API
addon - add name with type only if not exists in the setting
 
void LcSettingC_Parent (LcSettingC hdl)
  Perl: LcSettingC $setting->Parent() C-API
This function returns the parent setting of the given setting, or NULL if setting is the root setting …
 
void LcSettingC_Exists (LcSettingC hdl, MK_STRN name)
  Perl: bool $setting->Exists(string name) C-API
addon - return true if name exists in the setting otherwise false
 
void LcSettingC_Index (LcSettingC hdl)
  Perl: int32 $setting->Index() C-API
This function returns the index of the given setting within its parent setting …
 
void LcSettingC_Length (LcSettingC hdl)
  Perl: 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 …
 
void LcSettingC_Log (LcSettingC hdl, MkObjectC fmtobj=NULL, MK_DBG debug=0, MK_STRN callfunc=NULL, MK_INT lvl=0)
  Perl: $setting->Log(MkObjectC fmtobj = undef, int32 debug = 0, string callfunc = NULL, int32 lvl = 0) C-API
log the setting
 
void LcSettingC_Name (LcSettingC hdl)
  Perl: string $setting->Name() C-API
This function returns the name of the given setting, or NULL if the setting has no name …
 
void LcSettingC_Remove (LcSettingC hdl, MK_STRN name)
  Perl: $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 LcSettingC_RemoveElem (LcSettingC hdl, MK_INT idx)
  Perl: $parent->RemoveElem(int32 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 …
 
void LcSettingC_SourceFile (LcSettingC hdl)
  Perl: 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 …
 
void LcSettingC_SourceLine (LcSettingC hdl)
  Perl: 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 …
 
void LcSettingC_Type (LcSettingC hdl)
  Perl: 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

◆ LcSettingC_AddIfNotExists()

void LcSettingC_AddIfNotExists ( LcSettingC  hdl,
MK_STRN  name,
LcConfigTypeE  cfgtype 
)

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

Definition at line 366 of file LcSettingC_perl.xsh.

◆ LcSettingC_Exists()

void LcSettingC_Exists ( LcSettingC  hdl,
MK_STRN  name 
)

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

Definition at line 390 of file LcSettingC_perl.xsh.

◆ LcSettingC_Index()

void LcSettingC_Index ( LcSettingC  hdl)

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

Definition at line 399 of file LcSettingC_perl.xsh.

◆ LcSettingC_Length()

void LcSettingC_Length ( LcSettingC  hdl)

Perl: 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 408 of file LcSettingC_perl.xsh.

◆ LcSettingC_Log()

void LcSettingC_Log ( LcSettingC  hdl,
MkObjectC  fmtobj = NULL,
MK_DBG  debug = 0,
MK_STRN  callfunc = NULL,
MK_INT  lvl = 0 
)

◆ LcSettingC_Name()

void LcSettingC_Name ( LcSettingC  hdl)

Perl: 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 429 of file LcSettingC_perl.xsh.

◆ LcSettingC_Parent()

void LcSettingC_Parent ( LcSettingC  hdl)

Perl: 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 376 of file LcSettingC_perl.xsh.

◆ LcSettingC_Remove()

void LcSettingC_Remove ( LcSettingC  hdl,
MK_STRN  name 
)

Perl: $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 438 of file LcSettingC_perl.xsh.

◆ LcSettingC_RemoveElem()

void LcSettingC_RemoveElem ( LcSettingC  hdl,
MK_INT  idx 
)

Perl: $parent->RemoveElem(int32 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 448 of file LcSettingC_perl.xsh.

◆ LcSettingC_SourceFile()

void LcSettingC_SourceFile ( LcSettingC  hdl)

Perl: 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 458 of file LcSettingC_perl.xsh.

◆ LcSettingC_SourceLine()

void LcSettingC_SourceLine ( LcSettingC  hdl)

Perl: 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 467 of file LcSettingC_perl.xsh.

◆ LcSettingC_Type()

void LcSettingC_Type ( LcSettingC  hdl)

Perl: LcConfigTypeE $setting->Type() C-API
This function returns the type of the given setting

Definition at line 476 of file LcSettingC_perl.xsh.