MqBufferLS API
[MqBufferS API]

the MqBufferLS API is used to manage an array of MqBufferS items. More...

Classes
struct	MqBufferLS
	the object to manage an array of MqBufferS items. More...
Typedefs
typedef MqBufferLS	MqBufferLS
	the object to manage an array of MqBufferS items.
Functions
MQ_EXTERN MqBufferLSP	MqBufferLCreate (MqErrorSP const error, const MQ_SIZE size)
	create and initialize a MqBufferLS object
MQ_EXTERN MqBufferLSP	MqBufferLCreateArgv (MqErrorSP const error, int argc, char **argv)
	create and initialize a MqBufferLS object with argc/argv data
MQ_EXTERN void	MqBufferLDeleteStatic (MqBufferLSP buf)
	delete a statically created MqBufferLS object
MQ_EXTERN void	MqBufferLDelete (MqBufferLSP *bufP)
	delete a dynamically created MqBufferLS object
MQ_EXTERN void	MqBufferLAppend (MqBufferLSP const buf, MqBufferSP in)
	append a MqBufferS item to a MqBufferLS
MQ_EXTERN void	MqBufferLAppendFromString (MqBufferLSP const buf, MQ_STR string, char separator)
	append a string of items with separator to a MqBufferLS
MQ_EXTERN void	MqBufferLAppendH2 (register MqBufferLSP const buf, const MQ_STR option, const MQ_INT2 val)
	append a pair of (MQ_STR / MQ_INT2) to a MqBufferLS
MQ_EXTERN void	MqBufferLAppendHP (register MqBufferLSP const buf, const MQ_STR option, const MQ_PTR val)
	append a pair of (MQ_STR / MQ_PTR) to a MqBufferLS
MQ_EXTERN void	MqBufferLAppendHC (register MqBufferLSP const buf, const MQ_STR option, const MQ_STR val)
	append a pair of (MQ_STR / MQ_STR) to a MqBufferLS
MQ_EXTERN MqErrorE	MqBufferLCheckOptionO (MqBufferLSP const argv, const MQ_STR option, MQ_INT2 *var, MQ_INT2 def)
	search for boolean option in MqBufferLS and fill MQ_INT2 with 1 or 0
MQ_EXTERN MqErrorE	MqBufferLCheckOption2 (MqBufferLSP const argv, const MQ_STR option, MQ_INT2 *int2)
	search for option with MQ_INT2 argument in a MqBufferLS
MQ_EXTERN MqErrorE	MqBufferLCheckOption4 (MqBufferLSP const argv, const MQ_STR option, MQ_INT4 *var)
	search for option with MQ_INT4 argument in a MqBufferLS
MQ_EXTERN MqErrorE	MqBufferLCheckOptionP (MqBufferLSP const argv, const MQ_STR option, MQ_PTR *var)
	search for option with MQ_PTR argument in a MqBufferLS
MQ_EXTERN MqErrorE	MqBufferLCheckOptionU (MqBufferLSP const argv, const MQ_STR option, MqBufferSP *var)
	search for option with MqBufferS argument in a MqBufferLS
MQ_EXTERN MqErrorE	MqBufferLDeleteItem (MqBufferLSP const buf, MQ_SIZE index)
	delete list item on index from a MqBufferLS
MQ_EXTERN MQ_SIZE	MqBufferLSearchC (MqBufferLSP const buf, const MQ_STR str, const MQ_SIZE startindex)
	search MQ_STR item from a MqBufferLS starting at startindex
MQ_EXTERN MQ_SIZE	MqBufferLSearch4 (MqBufferLSP const buf, MQ_INT4 val, MQ_SIZE startindex)
	search MQ_INT4 item from a MqBufferLS starting at startindex
MQ_EXTERN MQ_SIZE	MqBufferLSearchP (MqBufferLSP const buf, MQ_PTR ptr)
	search MQ_PTR item from a MqBufferLS
MQ_EXTERN void	MqBufferLLog (MqBufferLSP const buf, const char *func)
	output a MqBufferLS object for debugging purpose
MQ_EXTERN void	MqBufferLSetError (MqBufferLSP const buf, MqErrorSP const error)
	set the MqErrorS object for all items in MqBufferLS and the MqBufferLS object itself

---

Detailed Description

the MqBufferLS API is used to manage an array of MqBufferS items.

the memory is allocated and extended dynamically.

---

Typedef Documentation

typedef struct MqBufferLS MqBufferLS

the object to manage an array of MqBufferS items. every MqBufferLS is able to store a infinite number of MqBufferS objects using dynamic allocation. the MqBufferS objects are stored in a flat array of MqBufferS object pointers. to access an object only the data or the cur member is used (e.g. data[index]). in difference to the data member the cur member has a floating position to implement an increment/decrement like behaviour

---

Function Documentation

MQ_EXTERN MQ_SIZE MqBufferLSearch4 (  MqBufferLSP const   buf, MQ_INT4  val, MQ_SIZE  startindex )

search MQ_INT4 item from a MqBufferLS starting at startindex Return values: the  index found or -1 if not found

MQ_EXTERN MQ_SIZE MqBufferLSearchC (  MqBufferLSP const   buf, const MQ_STR  str, const MQ_SIZE  startindex )

search MQ_STR item from a MqBufferLS starting at startindex Return values: the  index found or -1 if not found

MQ_EXTERN MQ_SIZE MqBufferLSearchP (  MqBufferLSP const   buf, MQ_PTR  ptr )

search MQ_PTR item from a MqBufferLS Return values: the  index found or -1 if not found

---