LcSettingC_Misc_TCL_API

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

Collaboration diagram for LcSettingC_Misc_TCL_API:

Functions
static OT_ProcRet	tcllcconfig_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	tcllcconfig_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	tcllcconfig_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	tcllcconfig_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	tcllcconfig_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 …
MK_DEPRECATED static MK_UNUSED OT_ProcRet	tcllcconfig_LcSettingC_Log (LcSettingC_ARGS)
static OT_ProcRet	tcllcconfig_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	tcllcconfig_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	tcllcconfig_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	tcllcconfig_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	tcllcconfig_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	tcllcconfig_LcSettingC_Type (LcSettingC_ARGS)
	Tcl: 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

tcllcconfig_LcSettingC_AddIfNotExists()

static OT_ProcRet tcllcconfig_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 746 of file LcSettingC_tcl.c.

                                                                  {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(2,2,AddIfNotExists_doc);
  MK_STRN name = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (name))
  enum LcConfigTypeE cfgtype = 0;
  OT_CHECK_REQUIRED(OT_CHECK_ENUM (LcConfigTypeE,cfgtype))
  OT_CHECK_NOARGS;
  LC_CFS retVal = LcSettingAddIfNotExists (hdl, name, cfgtype);
  OT_retObj_SET_CFS(retVal);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcSettingC_Exists()

static OT_ProcRet tcllcconfig_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 784 of file LcSettingC_tcl.c.

                                                          {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(Exists_doc);
  MK_STRN name = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (name))
  OT_CHECK_NOARGS;
  OT_retObj_SET_BOL(LcSettingExists (hdl, name));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcSettingC_Index()

static OT_ProcRet tcllcconfig_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 799 of file LcSettingC_tcl.c.

                                                         {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(Index_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_I32(LcSettingIndex (hdl));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcSettingC_Length()

static OT_ProcRet tcllcconfig_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 812 of file LcSettingC_tcl.c.

                                                          {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(Length_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_I32(LcSettingLength (hdl));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcSettingC_Log()

MK_DEPRECATED static MK_UNUSED OT_ProcRet tcllcconfig_LcSettingC_Log ( LcSettingC_ARGS )

static

Definition at line 826 of file LcSettingC_tcl.c.

{OT_ERROR_LNG_RETURN;}

tcllcconfig_LcSettingC_Name()

static OT_ProcRet tcllcconfig_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 829 of file LcSettingC_tcl.c.

                                                        {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(Name_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_STR(LcSettingName (hdl));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcSettingC_Parent()

static OT_ProcRet tcllcconfig_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 764 of file LcSettingC_tcl.c.

                                                          {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(Parent_doc);
  OT_CHECK_NOARGS;
  LC_CFS retVal = LcSettingParent (hdl);
  if (retVal == NULL) {
    OT_ERROR_SOFT_CONSTRUCTOR(LcSettingC);
    goto error;
  }
  OT_retObj_SET_CFS(retVal);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcSettingC_Remove()

static OT_ProcRet tcllcconfig_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 842 of file LcSettingC_tcl.c.

                                                          {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(Remove_doc);
  MK_STRN name = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (name))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,LcSettingRemove (hdl, name));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcSettingC_RemoveElem()

static OT_ProcRet tcllcconfig_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 858 of file LcSettingC_tcl.c.

                                                              {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(RemoveElem_doc);
  MK_I32 idx = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (idx))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,LcSettingRemoveElem (hdl, idx));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcSettingC_SourceFile()

static OT_ProcRet tcllcconfig_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 874 of file LcSettingC_tcl.c.

                                                              {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(SourceFile_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_STR(LcSettingSourceFile (hdl));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcSettingC_SourceLine()

static OT_ProcRet tcllcconfig_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 887 of file LcSettingC_tcl.c.

                                                              {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(SourceLine_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_I32(LcSettingSourceLine (hdl));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcSettingC_Type()

static OT_ProcRet tcllcconfig_LcSettingC_Type ( LcSettingC_ARGS )

static

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

Definition at line 900 of file LcSettingC_tcl.c.

                                                        {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(Type_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET(OT_NEW_Lc_enum_OBJ(ConfigTypeE,LcSettingType (hdl)));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}