This documenta- tion describes the current state of development.
Note that interfaces and functionality may still change.

Prokee Modules:

open all | close all

GUI Elements:

open all | close all

GUI Interactions:

open all | close all

GUI Layouts:

open all | close all

Games/Demos:

open all | close all

Third Party Libraries:

open all | close all

Information about this Website / Informationen zu dieser Webseite:

In case of any questions, or comments, please feel free to contact me via email at apoll500@gmail.com.

Module levelstr [Version: v01]

[Documentation]

[Details]

[Wiki]

[Tests]

This documentation describes the Prokee module interface.

Templates

Show templates with parameter T set to: (T), (char), (char16_t), (char32_t), (wchar_t )

Static Template Methods:

level2_free
void levelstr::level2_free(char16_t **itemlist)

level2_replaceItem_realloc
bool levelstr::level2_replaceItem_realloc(char16_t **itemlist,const char16_t *old_item,const char16_t *new_item)

level2_setItem_realloc
bool levelstr::level2_setItem_realloc(int itemid,char16_t **itemlist,const char16_t *item)

level2_setItem_malloc
bool levelstr::level2_setItem_malloc(int itemid,char16_t **itemlist,const char16_t *item)

level2_addItem_malloc
bool levelstr::level2_addItem_malloc(char16_t **itemlist,const char16_t *item)

level2_create
char16_t **levelstr::level2_create(int ln,char16_t ***itemlist)

level2_freeItem
bool levelstr::level2_freeItem(int itemid,char16_t **itemlist)

Motivation

Static Template Methods

level2_free

Signature:

void levelstr::level2_free(char16_t **itemlist)

Parameters:

Type	Name	Direction	Description
char16_t **	itemlist	[IN]	itemlist

level2_replaceItem_realloc

Signature:

bool levelstr::level2_replaceItem_realloc(char16_t **itemlist,const char16_t *old_item,const char16_t *new_item)

Parameters:

Type	Name	Direction	Description
char16_t **	itemlist	[IN]	itemlist
const char16_t *	old_item	[IN]	old_item
const char16_t *	new_item	[IN]	new_item

level2_setItem_realloc

Signature:

bool levelstr::level2_setItem_realloc(int itemid,char16_t **itemlist,const char16_t *item)

Parameters:

Type	Name	Direction	Description
int	itemid		itemid
char16_t **	itemlist	[IN]	itemlist
const char16_t *	item	[IN]	item

level2_setItem_malloc

Signature:

bool levelstr::level2_setItem_malloc(int itemid,char16_t **itemlist,const char16_t *item)

Parameters:

Type	Name	Direction	Description
int	itemid		itemid
char16_t **	itemlist	[IN]	itemlist
const char16_t *	item	[IN]	item

level2_addItem_malloc

Signature:

bool levelstr::level2_addItem_malloc(char16_t **itemlist,const char16_t *item)

Parameters:

Type	Name	Direction	Description
char16_t **	itemlist	[IN]	itemlist
const char16_t *	item	[IN]	item

level2_create

Signature:

char16_t **levelstr::level2_create(int ln,char16_t ***itemlist)

Parameters:

Type	Name	Direction	Description
int	ln		ln
char16_t ***	itemlist	[IN/OUT]	itemlist

Return value:
The function returns NULL, if ln≤0. The function may also return NULL, if memory allocation fails. On successful execution, the function returns a pointer to the new allocated memory. All bytes of this memory space are initializes with value 0.

Examples:

char **itemlist;
levelstr::level2_create(3,&itemlist);
levelstr::level2_addItem_malloc(itemlist,"HELLO");
levelstr::level2_addItem_malloc(itemlist,"WORLD");
levelstr::level2_addItem_malloc(itemlist,"!");

Memory is allocated for each string as illustrated below. Mind the difference to the result of explode().

level2_freeItem

Removes an item from the list.

Signature:

bool levelstr::level2_freeItem(int itemid,char16_t **itemlist)

Parameters:

Type	Name	Direction	Description
int	itemid		itemid
char16_t **	itemlist	[IN]	itemlist

Return value:
If itemid is out of range, the function returns false. If the function returns true, the item could be removed. The last item of the remaining list is moved to the place of the removed item to prevent gaps. Mind that this may change the order of the remaining items.