LcConfigC_Misc_CS_API

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

Collaboration diagram for LcConfigC_Misc_CS_API:

Functions
LcSettingC	cslcconfig.LcConfigC.RootSetting ()
	C#: LcSettingC config.RootSetting() → C-API This function, which is implemented as a macro, returns the root setting for the configuration config …
void	cslcconfig.LcConfigC.Clear ()
	C#: config.Clear() → C-API Since v1.7 This function clears the configuration config …
new void	cslcconfig.LcConfigC.Log (MkObjectC fmtobj=null, int debug=0, [CallerMemberName]string callfunc=null, int lvl=0)
	C#: cfg.Log(MkObjectC fmtobj = null, int debug = 0, [CallerMemberName]string callfunc = null, int lvl = 0) → C-API log the config …
void	cslcconfig.LcConfigC.ReadFile (string filename)
	C#: config.ReadFile(string filename) → C-API This function reads and parses a configuration from the file named filename into the configuration object config …
void	cslcconfig.LcConfigC.ReadString (string str)
	C#: config.ReadString(string str) → C-API This function reads and parses a configuration from the string str into the configuration object config …
void	cslcconfig.LcConfigC.WriteFile (string filename)
	C#: config.WriteFile(string filename) → C-API This function writes the configuration config to the file named filename …
string	cslcconfig.LcConfigC.WriteString ()
	C#: 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

Clear()

void cslcconfig.LcConfigC.Clear ( )

inline

C#: config.Clear() → C-API
Since v1.7 This function clears the configuration config …

Definition at line 303 of file LcConfigC.cs.

                          {
      Lc.LcConfigClear(hdl);
    }

Log()

new void cslcconfig.LcConfigC.Log ( MkObjectC fmtobj = null, int debug = 0, [CallerMemberName] string callfunc = null, int lvl = 0 )

inline

C#: cfg.Log(MkObjectC fmtobj = null, int debug = 0, [CallerMemberName]string callfunc = null, int lvl = 0) → C-API
log the config …

Definition at line 308 of file LcConfigC.cs.

                                                                                                                         {
      IntPtr fmtobj_hdl = MkObjectC.getOBJ_null_allow(fmtobj);
      if (debug > (int)(MkRuntimeC.DebugGet())) {return;}
      IntPtr callfunc_cstr = Marshal.StringToHGlobalAnsi(callfunc);
      Lc.LcConfigLog(mkrt, hdl, fmtobj_hdl, debug, callfunc_cstr, lvl);
      Marshal.FreeHGlobal(callfunc_cstr);
    }

ReadFile()

void cslcconfig.LcConfigC.ReadFile ( string filename )

inline

C#: config.ReadFile(string filename) → C-API
This function reads and parses a configuration from the file named filename into the configuration object config …

Definition at line 317 of file LcConfigC.cs.

                                            {
      IntPtr filename_cstr = Marshal.StringToHGlobalAnsi(filename);
      MkErrorE errVal = Lc.LcConfigReadFile(hdl, filename_cstr);
      Marshal.FreeHGlobal(filename_cstr);
      MkErrorC.Check(hdl, errVal);
    }

ReadString()

void cslcconfig.LcConfigC.ReadString ( string str )

inline

C#: config.ReadString(string str) → C-API
This function reads and parses a configuration from the string str into the configuration object config …

Definition at line 325 of file LcConfigC.cs.

                                         {
      IntPtr str_cstr = Marshal.StringToHGlobalAnsi(str);
      MkErrorE errVal = Lc.LcConfigReadString(hdl, str_cstr);
      Marshal.FreeHGlobal(str_cstr);
      MkErrorC.Check(hdl, errVal);
    }

RootSetting()

LcSettingC cslcconfig.LcConfigC.RootSetting ( )

inline

C#: LcSettingC config.RootSetting() → C-API
This function, which is implemented as a macro, returns the root setting for the configuration config …

Definition at line 295 of file LcConfigC.cs.

                                      {
      IntPtr __retVal__L = Lc.LcConfigRootSetting(hdl);
      return LcSettingC.LcSettingC_ObjNew(__retVal__L);
    }

WriteFile()

void cslcconfig.LcConfigC.WriteFile ( string filename )

inline

C#: config.WriteFile(string filename) → C-API
This function writes the configuration config to the file named filename …

Definition at line 333 of file LcConfigC.cs.

                                             {
      IntPtr filename_cstr = Marshal.StringToHGlobalAnsi(filename);
      MkErrorE errVal = Lc.LcConfigWriteFile(hdl, filename_cstr);
      Marshal.FreeHGlobal(filename_cstr);
      MkErrorC.Check(hdl, errVal);
    }

WriteString()

string cslcconfig.LcConfigC.WriteString ( )

inline

C#: string cfg.WriteString() → C-API
read the entire configuration cfg into the string val_out …

Definition at line 343 of file LcConfigC.cs.

                                  {
      IntPtr val_out;
      MkErrorE errVal = Lc.LcConfigWriteString(mkrt, hdl, out val_out);
      MkErrorC.Check(hdl, errVal);
      return Marshal.PtrToStringAnsi(val_out);
    }