MkBufferListC_Index_TCL_API

MkBufferListC - various functions to access a MkBufferListS by index … More...

Collaboration diagram for MkBufferListC_Index_TCL_API:

Functions
static OT_ProcRet	tclmkkernel_MkBufferListC_IndexGetBUF (MkBufferListC_ARGS)
	Tcl: MkBufferC [$bfl IndexGetBUF index:int32] → C-API get the index element from MkBufferListC ... if not available… create it. …
static OT_ProcRet	tclmkkernel_MkBufferListC_IndexExtract (MkBufferListC_ARGS)
	Tcl: MkBufferC [$bfl IndexExtract ?index:int32=0?] → C-API extract (read & delete) the index object from bfl …
static OT_ProcRet	tclmkkernel_MkBufferListC_IndexGet (MkBufferListC_ARGS)
	Tcl: MkBufferC [$bfl IndexGet index:int32] → C-API get (read only) the index object from bfl …
static OT_ProcRet	tclmkkernel_MkBufferListC_IndexDelete (MkBufferListC_ARGS)
	Tcl: $bfl IndexDelete index:int32 ?numitems:int32=1? ?doDelete:bool=true? → C-API delete the index'th list item from the MkBufferListS object …
static OT_ProcRet	tclmkkernel_MkBufferListC_IndexGetSTR (MkBufferListC_ARGS)
	Tcl: string [$bfl IndexGetSTR index:int32] → C-API get the index element from MkBufferListC ... as string. …
static OT_ProcRet	tclmkkernel_MkBufferListC_IndexSet (MkBufferListC_ARGS)
	Tcl: $bfl IndexSet index:int32 buf:MkBufferC → C-API set the index object from bfl …
static OT_ProcRet	tclmkkernel_MkBufferListC_IndexSetBUF (MkBufferListC_ARGS)
	Tcl: $bfl IndexSetBUF index:int32 buf:MkBufferC → C-API set the index element from MkBufferListC ... if not available… createspace …
static OT_ProcRet	tclmkkernel_MkBufferListC_IndexSetSTR (MkBufferListC_ARGS)
	Tcl: $bfl IndexSetSTR index:int32 str:string → C-API set the index element from MkBufferListC ... to string… if not available… create space …

Detailed Description

MkBufferListC - various functions to access a MkBufferListS by index …

Function Documentation

tclmkkernel_MkBufferListC_IndexDelete()

static OT_ProcRet tclmkkernel_MkBufferListC_IndexDelete ( MkBufferListC_ARGS )

static

Tcl: $bfl IndexDelete index:int32 ?numitems:int32=1? ?doDelete:bool=true? → C-API
delete the index'th list item from the MkBufferListS object …

Definition at line 857 of file MkBufferListC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(1,3,IndexDelete_doc);
  MK_NUM index = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (index))
  MK_NUM numitems = 1;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (numitems))
  MK_BOOL doDelete = true;
  OT_CHECK_OPTIONAL(OT_CHECK_bool (doDelete))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MkBufferListIndexDelete (hdl, index, numitems, doDelete));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferListC_IndexExtract()

static OT_ProcRet tclmkkernel_MkBufferListC_IndexExtract ( MkBufferListC_ARGS )

static

Tcl: MkBufferC [$bfl IndexExtract ?index:int32=0?] → C-API
extract (read & delete) the index object from bfl …

Definition at line 821 of file MkBufferListC_tcl.c.

                                                                      {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,1,IndexExtract_doc);
  MK_NUM index = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (index))
  OT_CHECK_NOARGS;
  MK_BUF val_out;
  MkErrorC_Check(hdl,MkBufferListIndexExtract (hdl, index, &val_out));
  OT_retObj_SET_BUF(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferListC_IndexGet()

static OT_ProcRet tclmkkernel_MkBufferListC_IndexGet ( MkBufferListC_ARGS )

static

Tcl: MkBufferC [$bfl IndexGet index:int32] → C-API
get (read only) the index object from bfl …

Definition at line 838 of file MkBufferListC_tcl.c.

                                                                  {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(IndexGet_doc);
  MK_NUM index = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (index))
  OT_CHECK_NOARGS;
  MK_BUF val_out;
  MkErrorC_Check(hdl,MkBufferListIndexGet (hdl, index, &val_out));
  OT_retObj_SET_BUF(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferListC_IndexGetBUF()

static OT_ProcRet tclmkkernel_MkBufferListC_IndexGetBUF ( MkBufferListC_ARGS )

static

Tcl: MkBufferC [$bfl IndexGetBUF index:int32] → C-API
get the index element from MkBufferListC ... if not available… create it. …

Definition at line 803 of file MkBufferListC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(IndexGetBUF_doc);
  MK_NUM index = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (index))
  OT_CHECK_NOARGS;
  MK_BUF retVal = MkBufferListIndexGetBUF (hdl, index);
  OT_retObj_SET_BUF(retVal);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferListC_IndexGetSTR()

static OT_ProcRet tclmkkernel_MkBufferListC_IndexGetSTR ( MkBufferListC_ARGS )

static

Tcl: string [$bfl IndexGetSTR index:int32] → C-API
get the index element from MkBufferListC ... as string. …

Definition at line 877 of file MkBufferListC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(IndexGetSTR_doc);
  MK_NUM index = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (index))
  OT_CHECK_NOARGS;
  OT_retObj_SET_STR(MkBufferListIndexGetSTR (hdl, index));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferListC_IndexSet()

static OT_ProcRet tclmkkernel_MkBufferListC_IndexSet ( MkBufferListC_ARGS )

static

Tcl: $bfl IndexSet index:int32 buf:MkBufferC → C-API
set the index object from bfl …

Definition at line 892 of file MkBufferListC_tcl.c.

                                                                  {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(2,2,IndexSet_doc);
  MK_NUM index = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (index))
  MK_BUF buf = 0;
  OT_CHECK_REQUIRED(OT_CHECK_BUF (buf,MK_NULL_NO))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MkBufferListIndexSet (hdl, index, buf));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferListC_IndexSetBUF()

static OT_ProcRet tclmkkernel_MkBufferListC_IndexSetBUF ( MkBufferListC_ARGS )

static

Tcl: $bfl IndexSetBUF index:int32 buf:MkBufferC → C-API
set the index element from MkBufferListC ... if not available… createspace …

Definition at line 910 of file MkBufferListC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(2,2,IndexSetBUF_doc);
  MK_NUM index = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (index))
  MK_BUF buf = 0;
  OT_CHECK_REQUIRED(OT_CHECK_BUF (buf,MK_NULL_NO))
  OT_CHECK_NOARGS;
  MkBufferListIndexSetBUF (hdl, index, buf);
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferListC_IndexSetSTR()

static OT_ProcRet tclmkkernel_MkBufferListC_IndexSetSTR ( MkBufferListC_ARGS )

static

Tcl: $bfl IndexSetSTR index:int32 str:string → C-API
set the index element from MkBufferListC ... to string… if not available… create space …

Definition at line 928 of file MkBufferListC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(2,2,IndexSetSTR_doc);
  MK_NUM index = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (index))
  MK_STRN str = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (str))
  OT_CHECK_NOARGS;
  MkBufferListIndexSetSTR (hdl, index, str);
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}