API_HighLvl::lib

Collaboration diagram for API_HighLvl::lib:

Namespaces
	xref_spr_markup
	Code documentation and markup
	xref_spr_sysdep
	Handling platform dependent features
	xref_spr_c_ext
	Compiler hints and C-extensions

Modules
	API_HighLvl::lib::core
	API_HighLvl::lib::cwr
	API_HighLvl::lib::data
	API_HighLvl::lib::nn

Typedefs
typedef struct SprMsgId	SprMsgId
typedef struct SprKeySet	SprKeySet
typedef char *	SprDynStr

Detailed Description

Typedef Documentation

typedef struct SprMsgId SprMsgId

Opaque structure to identify each routine and thread to the message system. For more info, see msg.c

typedef struct SprKeySet SprKeySet

The basic key-set type (an opaque type). For more info, see keyset.c

typedef char* SprDynStr

The basic type for dynamic strings which is a 100% compatible with that standard type used for standard C-strings (char*). In other words, wherever a C-strings is needed (function arguments, ...), a SprDynStr can be used instead. However, when a SprDynStr is needed, you must use a SprDynStr. Using a char* instead will lead to undefined behaviour. When a SprDynStr is no longer needed, it must be freed using spr_dynstr_free(); using spr_free() or free() will lead to memory corruption. For more info, see dynmem.c