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

Collaboration diagram for MkBufferListC_Index_C_API:

Functions
enum MkErrorE	MkBufferListIndexDelete_RT (MK_RT mkrt, MK_BFL const bfl, const MK_NUM index, const MK_NUM numitems, const bool doDelete)
	delete the index'th list item from the MkBufferListS object …

enum MkErrorE	MkBufferListIndexExtract_RT (MK_RT mkrt, MK_BFL const bfl, MK_NUM const index, MK_BUF *const val_out)
	extract (read & delete) the index object from bfl …

enum MkErrorE	MkBufferListIndexGet_RT (MK_RT mkrt, MK_BFLN const bfl, MK_NUM const index, MK_BUF *const val_out)
	get (read only) the index object from bfl …

enum MkErrorE	MkBufferListIndexSet_RT (MK_RT mkrt, MK_BFL const bfl, MK_NUM const index, MK_BUF const buf)
	set the index object from bfl …

MK_BUF	MkBufferListIndexGetBUF_RT (MK_RT mkrt, MK_BFL const bfl, MK_NUM index)
	get the index element from MkBufferListC ... if not available… create it. …

void	MkBufferListIndexSetBUF_RT (MK_RT mkrt, MK_BFL const bfl, MK_NUM const index, MK_BUF const buf)
	set the index element from MkBufferListC ... if not available… createspace …

MK_STRN	MkBufferListIndexGetSTR_RT (MK_RT mkrt, MK_BFL const bfl, MK_NUM const index)
	get the index element from MkBufferListC ... as string. …

void	MkBufferListIndexSetSTR_RT (MK_RT mkrt, MK_BFL const bfl, MK_NUM const index, MK_STRN const str)
	set the index element from MkBufferListC ... to string… if not available… create space …

MkBufferListC - MkBufferListC_Index_C_API - overload
#define	MkBufferListIndexGetBUF_NULL(...)

#define	MkBufferListIndexGetBUF(...)

#define	MkBufferListIndexExtract_NULL(...)

#define	MkBufferListIndexExtract(...)

#define	MkBufferListIndexExtract_2(bfl, val_out)

#define	MkBufferListIndexExtract_E(...)

#define	MkBufferListIndexExtract_C(...)

#define	MkBufferListIndexExtract_e(...)

#define	MkBufferListIndexGet_NULL(...)

#define	MkBufferListIndexGet(...)

#define	MkBufferListIndexGet_E(...)

#define	MkBufferListIndexGet_C(...)

#define	MkBufferListIndexGet_e(...)

#define	MkBufferListIndexDelete_NULL(...)

#define	MkBufferListIndexDelete(...)

#define	MkBufferListIndexDelete_3(bfl, index, numitems)

#define	MkBufferListIndexDelete_2(bfl, index)

#define	MkBufferListIndexDelete_E(...)

#define	MkBufferListIndexDelete_C(...)

#define	MkBufferListIndexGetSTR_NULL(...)

#define	MkBufferListIndexGetSTR(...)

#define	MkBufferListIndexSet_NULL(...)

#define	MkBufferListIndexSet(...)

#define	MkBufferListIndexSet_E(...)

#define	MkBufferListIndexSet_C(...)

#define	MkBufferListIndexSetBUF_NULL(...)

#define	MkBufferListIndexSetBUF(...)

#define	MkBufferListIndexSetSTR_NULL(...)

#define	MkBufferListIndexSetSTR(...)

Detailed Description

MkBufferListC - various functions to access a MkBufferListS by index …

Macro Definition Documentation

◆ MkBufferListIndexDelete

#define MkBufferListIndexDelete ( ... )

Value:

MkBufferListIndexDelete_RT(MK_RT_CALL __VA_ARGS__)

MkBufferListIndexDelete_RT

enum MkErrorE MkBufferListIndexDelete_RT(MK_RT mkrt, MK_BFL const bfl, const MK_NUM index, const MK_NUM numitems, const bool doDelete)

delete the index'th list item from the MkBufferListS object …

MK_RT_CALL

#define MK_RT_CALL

Definition LibMkKernel_mk.h:895

Definition at line 516 of file kernel_overload_mk.h.

◆ MkBufferListIndexDelete_2

#define MkBufferListIndexDelete_2	(		bfl,
			index )

Value:

MkBufferListIndexDelete(bfl,index,1,true)

MkBufferListIndexDelete

#define MkBufferListIndexDelete(...)

Definition kernel_overload_mk.h:516

Definition at line 518 of file kernel_overload_mk.h.

◆ MkBufferListIndexDelete_3

#define MkBufferListIndexDelete_3	(	bfl,
		index,
		numitems )

Value:

MkBufferListIndexDelete(bfl,index,numitems,true)

Definition at line 517 of file kernel_overload_mk.h.

◆ MkBufferListIndexDelete_C

#define MkBufferListIndexDelete_C ( ... )

Value:

if (MkErrorCheckI(MkBufferListIndexDelete(__VA_ARGS__)))

MkErrorCheckI

#define MkErrorCheckI(err)

Definition LibMkKernel_mk.h:11100

Definition at line 520 of file kernel_overload_mk.h.

◆ MkBufferListIndexDelete_E

#define MkBufferListIndexDelete_E ( ... )

Value:

MkErrorCheck(MkBufferListIndexDelete(__VA_ARGS__))

MkErrorCheck

#define MkErrorCheck(err)

check return-code and goto error on error …

Definition LibMkKernel_mk.h:11111

Definition at line 519 of file kernel_overload_mk.h.

◆ MkBufferListIndexDelete_NULL

#define MkBufferListIndexDelete_NULL ( ... )

Value:

MkBufferListIndexDelete_RT(MK_RT_CALL_NULL __VA_ARGS__)

MK_RT_CALL_NULL

#define MK_RT_CALL_NULL

Definition LibMkKernel_mk.h:899

Definition at line 515 of file kernel_overload_mk.h.

◆ MkBufferListIndexExtract

#define MkBufferListIndexExtract ( ... )

Value:

MkBufferListIndexExtract_RT(MK_RT_CALL __VA_ARGS__)

MkBufferListIndexExtract_RT

enum MkErrorE MkBufferListIndexExtract_RT(MK_RT mkrt, MK_BFL const bfl, MK_NUM const index, MK_BUF *const val_out)

extract (read & delete) the index object from bfl …

Definition at line 503 of file kernel_overload_mk.h.

◆ MkBufferListIndexExtract_2

#define MkBufferListIndexExtract_2	(		bfl,
			val_out )

Value:

MkBufferListIndexExtract(bfl,0,val_out)

MkBufferListIndexExtract

#define MkBufferListIndexExtract(...)

Definition kernel_overload_mk.h:503

Definition at line 504 of file kernel_overload_mk.h.

◆ MkBufferListIndexExtract_C

#define MkBufferListIndexExtract_C ( ... )

Value:

if (MkErrorCheckI(MkBufferListIndexExtract(__VA_ARGS__)))

Definition at line 506 of file kernel_overload_mk.h.

◆ MkBufferListIndexExtract_E

#define MkBufferListIndexExtract_E ( ... )

Value:

MkErrorCheck(MkBufferListIndexExtract(__VA_ARGS__))

Definition at line 505 of file kernel_overload_mk.h.

◆ MkBufferListIndexExtract_e

#define MkBufferListIndexExtract_e ( ... )

Value:

MK_EMBEDDED(MK_BUF,MkBufferListIndexExtract,__VA_ARGS__)

MkBufferS

The ABSTRACT-CLASS used to store a native-type-data-item defined by PRIMITIVE TYPE …

Definition LibMkKernel_mk.h:5783

Definition at line 507 of file kernel_overload_mk.h.

◆ MkBufferListIndexExtract_NULL

#define MkBufferListIndexExtract_NULL ( ... )

Value:

MkBufferListIndexExtract_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 502 of file kernel_overload_mk.h.

◆ MkBufferListIndexGet

#define MkBufferListIndexGet ( ... )

Value:

MkBufferListIndexGet_RT(MK_RT_CALL __VA_ARGS__)

MkBufferListIndexGet_RT

enum MkErrorE MkBufferListIndexGet_RT(MK_RT mkrt, MK_BFLN const bfl, MK_NUM const index, MK_BUF *const val_out)

get (read only) the index object from bfl …

Definition at line 509 of file kernel_overload_mk.h.

◆ MkBufferListIndexGet_C

#define MkBufferListIndexGet_C ( ... )

Value:

if (MkErrorCheckI(MkBufferListIndexGet(__VA_ARGS__)))

MkBufferListIndexGet

#define MkBufferListIndexGet(...)

Definition kernel_overload_mk.h:509

Definition at line 511 of file kernel_overload_mk.h.

◆ MkBufferListIndexGet_E

#define MkBufferListIndexGet_E ( ... )

Value:

MkErrorCheck(MkBufferListIndexGet(__VA_ARGS__))

Definition at line 510 of file kernel_overload_mk.h.

◆ MkBufferListIndexGet_e

#define MkBufferListIndexGet_e ( ... )

Value:

MK_EMBEDDED(MK_BUF,MkBufferListIndexGet,__VA_ARGS__)

Definition at line 512 of file kernel_overload_mk.h.

◆ MkBufferListIndexGet_NULL

#define MkBufferListIndexGet_NULL ( ... )

Value:

MkBufferListIndexGet_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 508 of file kernel_overload_mk.h.

◆ MkBufferListIndexGetBUF

#define MkBufferListIndexGetBUF ( ... )

Value:

MkBufferListIndexGetBUF_RT(MK_RT_CALL __VA_ARGS__)

MkBufferListIndexGetBUF_RT

MK_BUF MkBufferListIndexGetBUF_RT(MK_RT mkrt, MK_BFL const bfl, MK_NUM index)

get the index element from MkBufferListC ... if not available… create it. …

Definition at line 499 of file kernel_overload_mk.h.

◆ MkBufferListIndexGetBUF_NULL

#define MkBufferListIndexGetBUF_NULL ( ... )

Value:

MkBufferListIndexGetBUF_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 498 of file kernel_overload_mk.h.

◆ MkBufferListIndexGetSTR

#define MkBufferListIndexGetSTR ( ... )

Value:

MkBufferListIndexGetSTR_RT(MK_RT_CALL __VA_ARGS__)

MkBufferListIndexGetSTR_RT

MK_STRN MkBufferListIndexGetSTR_RT(MK_RT mkrt, MK_BFL const bfl, MK_NUM const index)

get the index element from MkBufferListC ... as string. …

Definition at line 522 of file kernel_overload_mk.h.

◆ MkBufferListIndexGetSTR_NULL

#define MkBufferListIndexGetSTR_NULL ( ... )

Value:

MkBufferListIndexGetSTR_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 521 of file kernel_overload_mk.h.

◆ MkBufferListIndexSet

#define MkBufferListIndexSet ( ... )

Value:

MkBufferListIndexSet_RT(MK_RT_CALL __VA_ARGS__)

MkBufferListIndexSet_RT

enum MkErrorE MkBufferListIndexSet_RT(MK_RT mkrt, MK_BFL const bfl, MK_NUM const index, MK_BUF const buf)

set the index object from bfl …

Definition at line 524 of file kernel_overload_mk.h.

◆ MkBufferListIndexSet_C

#define MkBufferListIndexSet_C ( ... )

Value:

if (MkErrorCheckI(MkBufferListIndexSet(__VA_ARGS__)))

MkBufferListIndexSet

#define MkBufferListIndexSet(...)

Definition kernel_overload_mk.h:524

Definition at line 526 of file kernel_overload_mk.h.

◆ MkBufferListIndexSet_E

#define MkBufferListIndexSet_E ( ... )

Value:

MkErrorCheck(MkBufferListIndexSet(__VA_ARGS__))

Definition at line 525 of file kernel_overload_mk.h.

◆ MkBufferListIndexSet_NULL

#define MkBufferListIndexSet_NULL ( ... )

Value:

MkBufferListIndexSet_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 523 of file kernel_overload_mk.h.

◆ MkBufferListIndexSetBUF

#define MkBufferListIndexSetBUF ( ... )

Value:

MkBufferListIndexSetBUF_RT(MK_RT_CALL __VA_ARGS__)

MkBufferListIndexSetBUF_RT

void MkBufferListIndexSetBUF_RT(MK_RT mkrt, MK_BFL const bfl, MK_NUM const index, MK_BUF const buf)

set the index element from MkBufferListC ... if not available… createspace …

Definition at line 528 of file kernel_overload_mk.h.

◆ MkBufferListIndexSetBUF_NULL

#define MkBufferListIndexSetBUF_NULL ( ... )

Value:

MkBufferListIndexSetBUF_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 527 of file kernel_overload_mk.h.

◆ MkBufferListIndexSetSTR

#define MkBufferListIndexSetSTR ( ... )

Value:

MkBufferListIndexSetSTR_RT(MK_RT_CALL __VA_ARGS__)

MkBufferListIndexSetSTR_RT

void MkBufferListIndexSetSTR_RT(MK_RT mkrt, MK_BFL const bfl, MK_NUM const index, MK_STRN const str)

set the index element from MkBufferListC ... to string… if not available… create space …

Definition at line 530 of file kernel_overload_mk.h.

◆ MkBufferListIndexSetSTR_NULL

#define MkBufferListIndexSetSTR_NULL ( ... )

Value:

MkBufferListIndexSetSTR_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 529 of file kernel_overload_mk.h.

Function Documentation

◆ MkBufferListIndexDelete_RT()

enum MkErrorE MkBufferListIndexDelete_RT	(	MK_RT	mkrt,
		MK_BFL const	bfl,
		const MK_NUM	index,
		const MK_NUM	numitems,
		const bool	doDelete )

delete the index'th list item from the MkBufferListS object …

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	bfl	the MkBufferListS instance to work on
[in]	index	an integer index to access an object in an array by position, start=0, end=-1
	numitems	delete number of items
	doDelete	if doDelete == `true` delete the MkBufferC object, associated with the index, too

Returns: The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk

◆ MkBufferListIndexExtract_RT()

enum MkErrorE MkBufferListIndexExtract_RT	(	MK_RT	mkrt,
		MK_BFL const	bfl,
		MK_NUM const	index,
		MK_BUF *const	val_out )

extract (read & delete) the index object from bfl …

If the index is not available, this is an error

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	bfl	the MkBufferListS instance to work on
[in]	index	an integer index to access an object in an array by position, start=0, end=-1
[out]	val_out	the MkBuffer64S object to return

Returns: The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk

Attention: 1. val_out is owned by the caller and have to be freed.
2. val_out will allways be set to MK_NULL first.

See also: BufferListDelete

◆ MkBufferListIndexGet_RT()

enum MkErrorE MkBufferListIndexGet_RT	(	MK_RT	mkrt,
		MK_BFLN const	bfl,
		MK_NUM const	index,
		MK_BUF *const	val_out )

get (read only) the index object from bfl …

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	bfl	the MkBufferListS instance to work on
[in]	index	an integer index to access an object in an array by position, start=0, end=-1
[out]	val_out	the MkBufferC to return

Returns: The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk

Attention: 1. val_out is owned by the MkBufferListC and must NOT be freed.
2. val_out will allways be set to MK_NULL first.
3. it is an error if index is not available.

See also: BufferListIndexGetBUF

◆ MkBufferListIndexGetBUF_RT()

MK_BUF MkBufferListIndexGetBUF_RT	(	MK_RT	mkrt,
		MK_BFL const	bfl,
		MK_NUM	index )

get the index element from MkBufferListC ... if not available… create it. …

The buffer returned is still owned by bfl.

index	starting	first	next...	mode
`+0 < idx < (+)~`	begin	0	1, 2, 3 ...	access idx from begin
`-1 < idx < (-)~`	end	-1	-2, -3, -4 ...	append idx to the end

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	bfl	the MkBufferListS instance to work on
[in]	index	an integer index to access an object in an array by position, start=0, end=-1

Returns: the MkBufferC requested

See also: BufferListIndexGet

◆ MkBufferListIndexGetSTR_RT()

MK_STRN MkBufferListIndexGetSTR_RT	(	MK_RT	mkrt,
		MK_BFL const	bfl,
		MK_NUM const	index )

get the index element from MkBufferListC ... as string. …

for details please refer to BufferListIndexGetBUF.

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	bfl	the MkBufferListS instance to work on
[in]	index	an integer index to access an object in an array by position, start=0, end=-1

Returns: the string requested or an EMPTY-STRING on error

◆ MkBufferListIndexSet_RT()

enum MkErrorE MkBufferListIndexSet_RT	(	MK_RT	mkrt,
		MK_BFL const	bfl,
		MK_NUM const	index,
		MK_BUF const	buf )

set the index object from bfl …

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	bfl	the MkBufferListS instance to work on
[in]	index	an integer index to access an object in an array by position, start=0, end=-1
[in]	buf	the MkBufferS instance to work on

Returns: The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk

Attention: It is an error if index is not available.

See also: BufferListIndexSetBUF

◆ MkBufferListIndexSetBUF_RT()

void MkBufferListIndexSetBUF_RT	(	MK_RT	mkrt,
		MK_BFL const	bfl,
		MK_NUM const	index,
		MK_BUF const	buf )

set the index element from MkBufferListC ... if not available… createspace …

cursize will be >= index+1
size will be >= index+1
cursize <= X < index+1 -> the missing buffer will be created

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	bfl	the MkBufferListS instance to work on
[in]	index	an integer index to access an object in an array by position, start=0, end=-1
[in]	buf	the MkBufferS instance to work on

◆ MkBufferListIndexSetSTR_RT()

void MkBufferListIndexSetSTR_RT	(	MK_RT	mkrt,
		MK_BFL const	bfl,
		MK_NUM const	index,
		MK_STRN const	str )

set the index element from MkBufferListC ... to string… if not available… create space …

for details please refer to BufferListIndexGetBUF

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	bfl	the MkBufferListS instance to work on
[in]	index	an integer index to access an object in an array by position, start=0, end=-1
[in]	str	the string to set

Functions

MkBufferListC - MkBufferListC_Index_C_API - overload

Detailed Description

Macro Definition Documentation

◆ MkBufferListIndexDelete

◆ MkBufferListIndexDelete_2

◆ MkBufferListIndexDelete_3

◆ MkBufferListIndexDelete_C

◆ MkBufferListIndexDelete_E

◆ MkBufferListIndexDelete_NULL

◆ MkBufferListIndexExtract

◆ MkBufferListIndexExtract_2

◆ MkBufferListIndexExtract_C

◆ MkBufferListIndexExtract_E

◆ MkBufferListIndexExtract_e

◆ MkBufferListIndexExtract_NULL

◆ MkBufferListIndexGet

◆ MkBufferListIndexGet_C

◆ MkBufferListIndexGet_E

◆ MkBufferListIndexGet_e

◆ MkBufferListIndexGet_NULL

◆ MkBufferListIndexGetBUF

◆ MkBufferListIndexGetBUF_NULL

◆ MkBufferListIndexGetSTR

◆ MkBufferListIndexGetSTR_NULL

◆ MkBufferListIndexSet

◆ MkBufferListIndexSet_C

◆ MkBufferListIndexSet_E

◆ MkBufferListIndexSet_NULL

◆ MkBufferListIndexSetBUF

◆ MkBufferListIndexSetBUF_NULL

◆ MkBufferListIndexSetSTR

◆ MkBufferListIndexSetSTR_NULL

Function Documentation

◆ MkBufferListIndexDelete_RT()

◆ MkBufferListIndexExtract_RT()

◆ MkBufferListIndexGet_RT()

◆ MkBufferListIndexGetBUF_RT()

◆ MkBufferListIndexGetSTR_RT()

◆ MkBufferListIndexSet_RT()

◆ MkBufferListIndexSetBUF_RT()

◆ MkBufferListIndexSetSTR_RT()