LcConfigC_Misc_TCL_API

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

Collaboration diagram for LcConfigC_Misc_TCL_API:

Functions
static OT_ProcRet	tcllcconfig_LcConfigC_RootSetting (LcConfigC_ARGS)
	Tcl: LcSettingC [$config RootSetting] → C-API This function, which is implemented as a macro, returns the root setting for the configuration config …
static OT_ProcRet	tcllcconfig_LcConfigC_Clear (LcConfigC_ARGS)
	Tcl: $config Clear → C-API Since v1.7 This function clears the configuration config …
static OT_ProcRet	tcllcconfig_LcConfigC_Log (LcConfigC_ARGS)
	Tcl: $cfg Log ?fmtobj:MkObjectC="MK_NULL"? ?debug:int32=0? ?callfunc:string="MK_NULL"? ?lvl:int32=0? → C-API log the config …
static OT_ProcRet	tcllcconfig_LcConfigC_ReadFile (LcConfigC_ARGS)
	Tcl: $config ReadFile filename:string → C-API This function reads and parses a configuration from the file named filename into the configuration object config …
static OT_ProcRet	tcllcconfig_LcConfigC_ReadString (LcConfigC_ARGS)
	Tcl: $config ReadString str:string → C-API This function reads and parses a configuration from the string str into the configuration object config …
static OT_ProcRet	tcllcconfig_LcConfigC_WriteFile (LcConfigC_ARGS)
	Tcl: $config WriteFile filename:string → C-API This function writes the configuration config to the file named filename …
static OT_ProcRet	tcllcconfig_LcConfigC_WriteString (LcConfigC_ARGS)
	Tcl: string [$cfg WriteString] → C-API read the entire configuration cfg into the string val_out …

Detailed Description

LcConfigC - various functions to perform misc operations …

Function Documentation

tcllcconfig_LcConfigC_Clear()

static OT_ProcRet tcllcconfig_LcConfigC_Clear ( LcConfigC_ARGS )

static

Tcl: $config Clear → C-API
Since v1.7 This function clears the configuration config …

Definition at line 533 of file LcConfigC_tcl.c.

                                                       {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(Clear_doc);
  OT_CHECK_NOARGS;
  LcConfigClear (hdl);
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcConfigC_Log()

static OT_ProcRet tcllcconfig_LcConfigC_Log ( LcConfigC_ARGS )

static

Tcl: $cfg Log ?fmtobj:MkObjectC="MK_NULL"? ?debug:int32=0? ?callfunc:string="MK_NULL"? ?lvl:int32=0? → C-API
log the config …

Definition at line 547 of file LcConfigC_tcl.c.

                                                     {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,4,Log_doc);
  MK_OBJN fmtobj = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_OBJN (fmtobj,MK_NULL_YES))
  MK_DBG debug = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (debug))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_I32 lvl = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (lvl))
  OT_CHECK_NOARGS;
  if (debug > MkRuntimeDebugGet()) {
    OT_retObj_SET_None;
    goto end;
  }
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  LcConfigLog (hdl, fmtobj, debug, callfunc, lvl);
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

tcllcconfig_LcConfigC_ReadFile()

static OT_ProcRet tcllcconfig_LcConfigC_ReadFile ( LcConfigC_ARGS )

static

Tcl: $config ReadFile filename:string → C-API
This function reads and parses a configuration from the file named filename into the configuration object config …

Definition at line 575 of file LcConfigC_tcl.c.

                                                          {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(ReadFile_doc);
  MK_STRN filename = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (filename))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,LcConfigReadFile (hdl, filename));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcConfigC_ReadString()

static OT_ProcRet tcllcconfig_LcConfigC_ReadString ( LcConfigC_ARGS )

static

Tcl: $config ReadString str:string → C-API
This function reads and parses a configuration from the string str into the configuration object config …

Definition at line 591 of file LcConfigC_tcl.c.

                                                            {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(ReadString_doc);
  MK_STRN str = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (str))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,LcConfigReadString (hdl, str));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcConfigC_RootSetting()

static OT_ProcRet tcllcconfig_LcConfigC_RootSetting ( LcConfigC_ARGS )

static

Tcl: LcSettingC [$config RootSetting] → C-API
This function, which is implemented as a macro, returns the root setting for the configuration config …

Definition at line 517 of file LcConfigC_tcl.c.

                                                             {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(RootSetting_doc);
  OT_CHECK_NOARGS;
  LC_CFS retVal = LcConfigRootSetting (hdl);
  OT_retObj_SET_CFS(retVal);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcConfigC_WriteFile()

static OT_ProcRet tcllcconfig_LcConfigC_WriteFile ( LcConfigC_ARGS )

static

Tcl: $config WriteFile filename:string → C-API
This function writes the configuration config to the file named filename …

Definition at line 607 of file LcConfigC_tcl.c.

                                                           {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(WriteFile_doc);
  MK_STRN filename = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (filename))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,LcConfigWriteFile (hdl, filename));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tcllcconfig_LcConfigC_WriteString()

static OT_ProcRet tcllcconfig_LcConfigC_WriteString ( LcConfigC_ARGS )

static

Tcl: string [$cfg WriteString] → C-API
read the entire configuration cfg into the string val_out …

Definition at line 625 of file LcConfigC_tcl.c.

                                                             {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(WriteString_doc);
  OT_CHECK_NOARGS;
  MK_STRN val_out;
  MkErrorC_Check(hdl,LcConfigWriteString (hdl, &val_out));
  OT_retObj_SET_STR(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}