LcSettingC_Misc_RB_API

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

Collaboration diagram for LcSettingC_Misc_RB_API:

Functions
static OT_ProcRet	rblcconfig_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	rblcconfig_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	rblcconfig_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	rblcconfig_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	rblcconfig_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 …
MK_DEPRECATED static MK_UNUSED OT_ProcRet	rblcconfig_LcSettingC_Log (LcSettingC_ARGS)
static OT_ProcRet	rblcconfig_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	rblcconfig_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	rblcconfig_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	rblcconfig_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	rblcconfig_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	rblcconfig_LcSettingC_Type (LcSettingC_ARGS)
	Ruby: 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

rblcconfig_LcSettingC_AddIfNotExists()

static OT_ProcRet rblcconfig_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 633 of file LcSettingC_rb.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);
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rblcconfig_LcSettingC_Exists()

static OT_ProcRet rblcconfig_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 664 of file LcSettingC_rb.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));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rblcconfig_LcSettingC_Index()

static OT_ProcRet rblcconfig_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 676 of file LcSettingC_rb.c.

                                                         {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(Index_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_I32(LcSettingIndex (hdl));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rblcconfig_LcSettingC_Length()

static OT_ProcRet rblcconfig_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 686 of file LcSettingC_rb.c.

                                                          {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(Length_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_I32(LcSettingLength (hdl));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rblcconfig_LcSettingC_Log()

MK_DEPRECATED static MK_UNUSED OT_ProcRet rblcconfig_LcSettingC_Log ( LcSettingC_ARGS )

static

Definition at line 697 of file LcSettingC_rb.c.

{OT_ERROR_LNG_RETURN;}

rblcconfig_LcSettingC_Name()

static OT_ProcRet rblcconfig_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 700 of file LcSettingC_rb.c.

                                                        {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(Name_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_STR(LcSettingName (hdl));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rblcconfig_LcSettingC_Parent()

static OT_ProcRet rblcconfig_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 648 of file LcSettingC_rb.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);
  }
  OT_retObj_SET_CFS(retVal);
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rblcconfig_LcSettingC_Remove()

static OT_ProcRet rblcconfig_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 710 of file LcSettingC_rb.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;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rblcconfig_LcSettingC_RemoveElem()

static OT_ProcRet rblcconfig_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 723 of file LcSettingC_rb.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;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rblcconfig_LcSettingC_SourceFile()

static OT_ProcRet rblcconfig_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 736 of file LcSettingC_rb.c.

                                                              {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(SourceFile_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_STR(LcSettingSourceFile (hdl));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rblcconfig_LcSettingC_SourceLine()

static OT_ProcRet rblcconfig_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 746 of file LcSettingC_rb.c.

                                                              {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(SourceLine_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_I32(LcSettingSourceLine (hdl));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rblcconfig_LcSettingC_Type()

static OT_ProcRet rblcconfig_LcSettingC_Type ( LcSettingC_ARGS )

static

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

Definition at line 756 of file LcSettingC_rb.c.

                                                        {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(Type_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET(OT_NEW_Lc_enum_OBJ(ConfigTypeE,LcSettingType (hdl)));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}