MkBufferStreamC_Read_CS_API

MkBufferStreamC - various functions to 'read' data from a MkBufferStreamS … More...

Collaboration diagram for MkBufferStreamC_Read_CS_API:

Functions
MkBufferListC	csmkkernel.MkBufferStreamC.ReadALL (MkBufferListC val_inout=null)
	C#: MkBufferListC bus.ReadALL(MkBufferListC val_inout = null) → C-API get a temporary MkBufferListC from all data in the MkBufferStreamC …
MkBufferListC	csmkkernel.MkBufferStreamC.ReadBFL ()
	C#: MkBufferListC bus.ReadBFL() → C-API read a MkBufferListC from the MkBufferStreamC …
MkBufferC	csmkkernel.MkBufferStreamC.ReadBUF ()
	C#: MkBufferC bus.ReadBUF() → C-API read a val_out from the MkBufferStreamC …
MkTypeE	csmkkernel.MkBufferStreamC.ReadGetNextType ()
	C#: MkTypeE bus.ReadGetNextType() → C-API get the type (MkTypeE) of the next Item in the MkBufferStreamC or "0" if not available
int	csmkkernel.MkBufferStreamC.ReadGetNumItems ()
	C#: int bus.ReadGetNumItems() → C-API get the number of items left in the MkBufferStreamC …
bool	csmkkernel.MkBufferStreamC.ReadItemExists ()
	C#: bool bus.ReadItemExists() → C-API check if an item exists in the read-data-package …
void	csmkkernel.MkBufferStreamC.ReadL_END ()
	C#: bus.ReadL_END() → C-API END read a list-item-type from the MkBufferStreamC …
void	csmkkernel.MkBufferStreamC.ReadL_START (MkBufferC buf=null)
	C#: bus.ReadL_START(MkBufferC buf = null) → C-API START read a list-item-type from the MkBufferStreamC …
void	csmkkernel.MkBufferStreamC.ReadUndo ()
	C#: bus.ReadUndo() → C-API undo the last MkBufferStreamC READ function call …
byte[]	csmkkernel.MkBufferStreamC.ReadBIN ()
	C#: doc_mk_cs_BufferStreamReadBIN → C-API read a val_out from the MkBufferStreamC …
bool	csmkkernel.MkBufferStreamC.ReadBOL ()
	C#: doc_mk_cs_BufferStreamReadBOL → C-API read a val_out from the MkBufferStreamC …
double	csmkkernel.MkBufferStreamC.ReadDBL ()
	C#: doc_mk_cs_BufferStreamReadDBL → C-API read a val_out from the MkBufferStreamC …
float	csmkkernel.MkBufferStreamC.ReadFLT ()
	C#: doc_mk_cs_BufferStreamReadFLT → C-API read a val_out from the MkBufferStreamC …
int	csmkkernel.MkBufferStreamC.ReadI32 ()
	C#: doc_mk_cs_BufferStreamReadI32 → C-API read a val_out from the MkBufferStreamC …
long	csmkkernel.MkBufferStreamC.ReadI64 ()
	C#: doc_mk_cs_BufferStreamReadI64 → C-API read a val_out from the MkBufferStreamC …
byte	csmkkernel.MkBufferStreamC.ReadI8 ()
	C#: doc_mk_cs_BufferStreamReadI8 → C-API read a val_out from the MkBufferStreamC …
long	csmkkernel.MkBufferStreamC.ReadLONG ()
	C#: long bus.ReadLONG() → C-API read the long native object from the MkBufferStreamC …
string	csmkkernel.MkBufferStreamC.ReadSTR ()
	C#: doc_mk_cs_BufferStreamReadSTR → C-API read a val_out from the MkBufferStreamC …

Detailed Description

MkBufferStreamC - various functions to 'read' data from a MkBufferStreamS …

Read is done at the position of MkBufferStreamS::storage->cur. After read the cur is incemented with read-sizeof characters.

Function Documentation

ReadALL()

MkBufferListC csmkkernel.MkBufferStreamC.ReadALL ( MkBufferListC val_inout = null )

inline

C#: MkBufferListC bus.ReadALL(MkBufferListC val_inout = null) → C-API
get a temporary MkBufferListC from all data in the MkBufferStreamC …

Definition at line 202 of file MkBufferStreamC.cs.

                                                                   {
      IntPtr val_inout_hdl = MkBufferListC.getOBJ_null_allow(val_inout);
      MkErrorE errVal = Mk.MkBufferStreamReadALL(mkrt, hdl, ref val_inout_hdl);
      MkErrorC.Check(hdl, errVal);
      return MkBufferListC.MkBufferListC_ObjNew(val_inout_hdl);
    }

ReadBFL()

MkBufferListC csmkkernel.MkBufferStreamC.ReadBFL ( )

inline

C#: MkBufferListC bus.ReadBFL() → C-API
read a MkBufferListC from the MkBufferStreamC …

Definition at line 212 of file MkBufferStreamC.cs.

                                     {
      IntPtr val_out;
      MkErrorE errVal = Mk.MkBufferStreamReadBFL(mkrt, hdl, out val_out);
      MkErrorC.Check(hdl, errVal);
      return MkBufferListC.MkBufferListC_ObjNew(val_out);
    }

ReadBIN()

byte[] csmkkernel.MkBufferStreamC.ReadBIN ( )

inline

C#: doc_mk_cs_BufferStreamReadBIN → C-API
read a val_out from the MkBufferStreamC …

Definition at line 269 of file MkBufferStreamC.cs.

                              {
      Mk.MkBinaryR val_out_ref;
      MkErrorE errVal = Mk.MkBufferStreamReadBIN(mkrt, hdl, out val_out_ref);
      if (errVal > MkErrorE.CONTINUE) ErrorCheck(errVal);
      byte[] val_out = new byte[(int)val_out_ref.size];
      Marshal.Copy(val_out_ref.data,val_out,0,(int)val_out_ref.size);
      return val_out;
    }

ReadBOL()

bool csmkkernel.MkBufferStreamC.ReadBOL ( )

inline

C#: doc_mk_cs_BufferStreamReadBOL → C-API
read a val_out from the MkBufferStreamC …

Definition at line 279 of file MkBufferStreamC.cs.

                            {
      Byte val_out;
      MkErrorE errVal = Mk.MkBufferStreamReadBOL(mkrt, hdl, out val_out);
      MkErrorC.Check(hdl, errVal);
      return val_out != 0;
    }

ReadBUF()

MkBufferC csmkkernel.MkBufferStreamC.ReadBUF ( )

inline

C#: MkBufferC bus.ReadBUF() → C-API
read a val_out from the MkBufferStreamC …

Definition at line 220 of file MkBufferStreamC.cs.

                                 {
      IntPtr val_out;
      MkErrorE errVal = Mk.MkBufferStreamReadBUF(mkrt, hdl, out val_out);
      MkErrorC.Check(hdl, errVal);
      return MkBufferC.MkBufferC_ObjNew(val_out);
    }

ReadDBL()

double csmkkernel.MkBufferStreamC.ReadDBL ( )

inline

C#: doc_mk_cs_BufferStreamReadDBL → C-API
read a val_out from the MkBufferStreamC …

Definition at line 287 of file MkBufferStreamC.cs.

                              {
      Double val_out;
      MkErrorE errVal = Mk.MkBufferStreamReadDBL(mkrt, hdl, out val_out);
      MkErrorC.Check(hdl, errVal);
      return val_out;
    }

ReadFLT()

float csmkkernel.MkBufferStreamC.ReadFLT ( )

inline

C#: doc_mk_cs_BufferStreamReadFLT → C-API
read a val_out from the MkBufferStreamC …

Definition at line 295 of file MkBufferStreamC.cs.

                             {
      Single val_out;
      MkErrorE errVal = Mk.MkBufferStreamReadFLT(mkrt, hdl, out val_out);
      MkErrorC.Check(hdl, errVal);
      return val_out;
    }

ReadGetNextType()

MkTypeE csmkkernel.MkBufferStreamC.ReadGetNextType ( )

inline

C#: MkTypeE bus.ReadGetNextType() → C-API
get the type (MkTypeE) of the next Item in the MkBufferStreamC or "0" if not available

Definition at line 230 of file MkBufferStreamC.cs.

                                       {
      MkTypeE __retVal__L = Mk.MkBufferStreamReadGetNextType(mkrt, hdl);
      return __retVal__L;
    }

ReadGetNumItems()

int csmkkernel.MkBufferStreamC.ReadGetNumItems ( )

inline

C#: int bus.ReadGetNumItems() → C-API
get the number of items left in the MkBufferStreamC …

Definition at line 236 of file MkBufferStreamC.cs.

                                   {
      Int32 __retVal__L = Mk.MkBufferStreamReadGetNumItems(mkrt, hdl);
      return __retVal__L;
    }

ReadI32()

int csmkkernel.MkBufferStreamC.ReadI32 ( )

inline

C#: doc_mk_cs_BufferStreamReadI32 → C-API
read a val_out from the MkBufferStreamC …

Definition at line 303 of file MkBufferStreamC.cs.

                           {
      Int32 val_out;
      MkErrorE errVal = Mk.MkBufferStreamReadI32(mkrt, hdl, out val_out);
      MkErrorC.Check(hdl, errVal);
      return val_out;
    }

ReadI64()

long csmkkernel.MkBufferStreamC.ReadI64 ( )

inline

C#: doc_mk_cs_BufferStreamReadI64 → C-API
read a val_out from the MkBufferStreamC …

Definition at line 311 of file MkBufferStreamC.cs.

                            {
      Int64 val_out;
      MkErrorE errVal = Mk.MkBufferStreamReadI64(mkrt, hdl, out val_out);
      MkErrorC.Check(hdl, errVal);
      return val_out;
    }

ReadI8()

byte csmkkernel.MkBufferStreamC.ReadI8 ( )

inline

C#: doc_mk_cs_BufferStreamReadI8 → C-API
read a val_out from the MkBufferStreamC …

Definition at line 319 of file MkBufferStreamC.cs.

                           {
      Byte val_out;
      MkErrorE errVal = Mk.MkBufferStreamReadI8(mkrt, hdl, out val_out);
      MkErrorC.Check(hdl, errVal);
      return (byte)val_out;
    }

ReadItemExists()

bool csmkkernel.MkBufferStreamC.ReadItemExists ( )

inline

C#: bool bus.ReadItemExists() → C-API
check if an item exists in the read-data-package …

Definition at line 242 of file MkBufferStreamC.cs.

                                   {
      bool __retVal__L = Mk.MkBufferStreamReadItemExists(mkrt, hdl);
      return __retVal__L;
    }

ReadL_END()

void csmkkernel.MkBufferStreamC.ReadL_END ( )

inline

C#: bus.ReadL_END() → C-API
END read a list-item-type from the MkBufferStreamC …

Definition at line 248 of file MkBufferStreamC.cs.

                              {
      MkErrorE errVal = Mk.MkBufferStreamReadL_END(mkrt, hdl);
      MkErrorC.Check(hdl, errVal);
    }

ReadL_START()

void csmkkernel.MkBufferStreamC.ReadL_START ( MkBufferC buf = null )

inline

C#: bus.ReadL_START(MkBufferC buf = null) → C-API
START read a list-item-type from the MkBufferStreamC …

Definition at line 254 of file MkBufferStreamC.cs.

                                                    {
      IntPtr buf_hdl = MkBufferC.getOBJ_null_allow(buf);
      MkErrorE errVal = Mk.MkBufferStreamReadL_START(mkrt, hdl, buf_hdl);
      MkErrorC.Check(hdl, errVal);
    }

ReadLONG()

long csmkkernel.MkBufferStreamC.ReadLONG ( )

inline

C#: long bus.ReadLONG() → C-API
read the long native object from the MkBufferStreamC …

Definition at line 327 of file MkBufferStreamC.cs.

                             {
      long val_out;
      MkErrorE errVal = Mk.MkBufferStreamReadLONG(mkrt, hdl, out val_out);
      MkErrorC.Check(hdl, errVal);
      return val_out;
    }

ReadSTR()

string csmkkernel.MkBufferStreamC.ReadSTR ( )

inline

C#: doc_mk_cs_BufferStreamReadSTR → C-API
read a val_out from the MkBufferStreamC …

Definition at line 335 of file MkBufferStreamC.cs.

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

ReadUndo()

void csmkkernel.MkBufferStreamC.ReadUndo ( )

inline

C#: bus.ReadUndo() → C-API
undo the last MkBufferStreamC READ function call …

Definition at line 261 of file MkBufferStreamC.cs.

                             {
      MkErrorE errVal = Mk.MkBufferStreamReadUndo(mkrt, hdl);
      MkErrorC.Check(hdl, errVal);
    }