MkBufferListC_Index_CC_API

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

Collaboration diagram for MkBufferListC_Index_CC_API:

Functions
MkBufferC *	ccmkkernel::MkBufferListC::IndexGetBUF (MK_NUM index)
	C++: MkBufferC* bfl.IndexGetBUF(MK_NUM index) → C-API get the index element from MkBufferListC ... if not available… create it. …
MkBufferC *	ccmkkernel::MkBufferListC::IndexExtract (MK_NUM index=0)
	C++: MkBufferC* bfl.IndexExtract(MK_NUM index = 0) → C-API extract (read & delete) the index object from bfl …
MkBufferC *	ccmkkernel::MkBufferListC::IndexGet (MK_NUM index) const
	C++: MkBufferC* bfl.IndexGet(MK_NUM index) → C-API get (read only) the index object from bfl …
void	ccmkkernel::MkBufferListC::IndexDelete (MK_NUM index, MK_NUM numitems=1, MK_BOOL doDelete=true)
	C++: bfl.IndexDelete(MK_NUM index, MK_NUM numitems = 1, MK_BOOL doDelete = true) → C-API delete the index'th list item from the MkBufferListS object …
MK_STRN	ccmkkernel::MkBufferListC::IndexGetSTR (MK_NUM index)
	C++: MK_STRN bfl.IndexGetSTR(MK_NUM index) → C-API get the index element from MkBufferListC ... as string. …
void	ccmkkernel::MkBufferListC::IndexSet (MK_NUM index, MkBufferC *buf)
	C++: bfl.IndexSet(MK_NUM index, MkBufferC* buf) → C-API set the index object from bfl …
void	ccmkkernel::MkBufferListC::IndexSet (MK_NUM index, const MkBufferC &buf)
	C++: bfl.IndexSet(MK_NUM index, MkBufferC* buf) → C-API set the index object from bfl …
void	ccmkkernel::MkBufferListC::IndexSetBUF (MK_NUM index, MkBufferC *buf)
	C++: bfl.IndexSetBUF(MK_NUM index, MkBufferC* buf) → C-API set the index element from MkBufferListC ... if not available… createspace …
void	ccmkkernel::MkBufferListC::IndexSetBUF (MK_NUM index, const MkBufferC &buf)
	C++: bfl.IndexSetBUF(MK_NUM index, MkBufferC* buf) → C-API set the index element from MkBufferListC ... if not available… createspace …
void	ccmkkernel::MkBufferListC::IndexSetSTR (MK_NUM index, MK_STRN str)
	C++: bfl.IndexSetSTR(MK_NUM index, MK_STRN str) → C-API set the index element from MkBufferListC ... to string… if not available… create space …
void	ccmkkernel::MkBufferListC::IndexSetSTR (MK_NUM index, const std::string &str)
	C++: bfl.IndexSetSTR(MK_NUM index, MK_STRN str) → 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

IndexDelete()

void ccmkkernel::MkBufferListC::IndexDelete ( MK_NUM index, MK_NUM numitems = 1, MK_BOOL doDelete = true )

inline

C++: bfl.IndexDelete(MK_NUM index, MK_NUM numitems = 1, MK_BOOL doDelete = true) → C-API
delete the index'th list item from the MkBufferListS object …

Definition at line 605 of file MkBufferListC_inline_cc.hh.

                                                                                          {
    MK_UNUSED auto bfl = getBFL();
    enum MkErrorE errVal = MkBufferListIndexDelete(bfl, index, numitems, doDelete);
    MkErrorC_Check(bfl, errVal);
  }

IndexExtract()

MkBufferC * ccmkkernel::MkBufferListC::IndexExtract ( MK_NUM index = 0 )

inline

C++: MkBufferC* bfl.IndexExtract(MK_NUM index = 0) → C-API
extract (read & delete) the index object from bfl …

Definition at line 585 of file MkBufferListC_inline_cc.hh.

                                                              {
    MK_UNUSED auto bfl = getBFL();
    MK_BUF val_out;
    enum MkErrorE errVal = MkBufferListIndexExtract(bfl, index, &val_out);
    MkErrorC_Check(bfl, errVal);
    return MkBufferC::MkBufferC_ObjNew(MK_RT_CALL val_out);
  }

IndexGet()

MkBufferC * ccmkkernel::MkBufferListC::IndexGet ( MK_NUM index ) const

inline

C++: MkBufferC* bfl.IndexGet(MK_NUM index) → C-API
get (read only) the index object from bfl …

Definition at line 594 of file MkBufferListC_inline_cc.hh.

                                                               {
    MK_UNUSED auto bfl = getBFLN();
    MK_BUF val_out;
    enum MkErrorE errVal = MkBufferListIndexGet(bfl, index, &val_out);
    MkErrorC_Check(bfl, errVal);
    return MkBufferC::MkBufferC_ObjNew(MK_RT_CALL val_out);
  }

IndexGetBUF()

MkBufferC * ccmkkernel::MkBufferListC::IndexGetBUF ( MK_NUM index )

inline

C++: MkBufferC* bfl.IndexGetBUF(MK_NUM index) → C-API
get the index element from MkBufferListC ... if not available… create it. …

Definition at line 576 of file MkBufferListC_inline_cc.hh.

                                                             {
    MK_UNUSED auto bfl = getBFL();
    MK_BUF __retVal__L = MkBufferListIndexGetBUF(bfl, index);
    return MkBufferC::MkBufferC_ObjNew(MK_RT_CALL __retVal__L);
  }

IndexGetSTR()

MK_STRN ccmkkernel::MkBufferListC::IndexGetSTR ( MK_NUM index )

inline

C++: MK_STRN bfl.IndexGetSTR(MK_NUM index) → C-API
get the index element from MkBufferListC ... as string. …

Definition at line 612 of file MkBufferListC_inline_cc.hh.

                                                          {
    MK_UNUSED auto bfl = getBFL();
    MK_STRN __retVal__L = MkBufferListIndexGetSTR(bfl, index);
    return __retVal__L;
  }

IndexSet() [1/2]

void ccmkkernel::MkBufferListC::IndexSet ( MK_NUM index, const MkBufferC & buf )

inline

C++: bfl.IndexSet(MK_NUM index, MkBufferC* buf) → C-API
set the index object from bfl …

Definition at line 627 of file MkBufferListC_inline_cc.hh.

                                                                          {
    MK_UNUSED auto bfl = getBFL();
    const MK_BUF buf_hdl = MkBufferC::getBUF(buf);
    enum MkErrorE errVal = MkBufferListIndexSet(bfl, index, buf_hdl);
    MkErrorC_Check(bfl, errVal);
  }

IndexSet() [2/2]

void ccmkkernel::MkBufferListC::IndexSet ( MK_NUM index, MkBufferC * buf )

inline

C++: bfl.IndexSet(MK_NUM index, MkBufferC* buf) → C-API
set the index object from bfl …

Definition at line 619 of file MkBufferListC_inline_cc.hh.

                                                                    {
    MK_UNUSED auto bfl = getBFL();
    MK_BUF buf_hdl = MkBufferC::getBUF(buf);
    enum MkErrorE errVal = MkBufferListIndexSet(bfl, index, buf_hdl);
    MkErrorC_Check(bfl, errVal);
  }

IndexSetBUF() [1/2]

void ccmkkernel::MkBufferListC::IndexSetBUF ( MK_NUM index, const MkBufferC & buf )

inline

C++: bfl.IndexSetBUF(MK_NUM index, MkBufferC* buf) → C-API
set the index element from MkBufferListC ... if not available… createspace …

Definition at line 642 of file MkBufferListC_inline_cc.hh.

                                                                             {
    MK_UNUSED auto bfl = getBFL();
    const MK_BUF buf_hdl = MkBufferC::getBUF(buf);
    MkBufferListIndexSetBUF(bfl, index, buf_hdl);
  }

IndexSetBUF() [2/2]

void ccmkkernel::MkBufferListC::IndexSetBUF ( MK_NUM index, MkBufferC * buf )

inline

C++: bfl.IndexSetBUF(MK_NUM index, MkBufferC* buf) → C-API
set the index element from MkBufferListC ... if not available… createspace …

Definition at line 635 of file MkBufferListC_inline_cc.hh.

                                                                       {
    MK_UNUSED auto bfl = getBFL();
    MK_BUF buf_hdl = MkBufferC::getBUF(buf);
    MkBufferListIndexSetBUF(bfl, index, buf_hdl);
  }

IndexSetSTR() [1/2]

void ccmkkernel::MkBufferListC::IndexSetSTR ( MK_NUM index, const std::string & str )

inline

C++: bfl.IndexSetSTR(MK_NUM index, MK_STRN str) → C-API
set the index element from MkBufferListC ... to string… if not available… create space …

Definition at line 655 of file MkBufferListC_inline_cc.hh.

                                                                             {
    MK_UNUSED auto bfl = getBFL();
    const MK_STRN str_hdl = str.c_str();
    MkBufferListIndexSetSTR(bfl, index, str_hdl);
  }

IndexSetSTR() [2/2]

void ccmkkernel::MkBufferListC::IndexSetSTR ( MK_NUM index, MK_STRN str )

inline

C++: bfl.IndexSetSTR(MK_NUM index, MK_STRN str) → C-API
set the index element from MkBufferListC ... to string… if not available… create space …

Definition at line 649 of file MkBufferListC_inline_cc.hh.

                                                                    {
    MK_UNUSED auto bfl = getBFL();
    MkBufferListIndexSetSTR(bfl, index, str);
  }