Pantheios Console Stock Back-end
[Pantheios Stock Back-ends]

---

Detailed Description

Back-end library that outputs to the console, providing colour-coding options as available on the given platform.

Note:

The Console back-end does not actually exist; rather it is the Pantheios Windows Console Stock Back-end for Windows, or the Pantheios fprintf() Stock Back-end otherwise. All types, functions and constants are actually those of the underlying platform-specific back-end.

Modules
	Pantheios Console Stock Back-end Flags
	Flags for the Pantheios Console Stock Back-end.
Defines
#define	pantheios_be_console_getDefaultAppInit(init)   pantheios_be_fprintf_getAppInit(init)
	Fills out a copy of the initialisation structure with default values (representative of the default behaviour of the library), ready to be customised and passed to the API initialiser function pantheios_be_console_init().
#define	pantheios_be_console_init   pantheios_be_fprintf_init
	Implements the functionality for pantheios_be_init() over the Console API.
#define	pantheios_be_console_uninit   pantheios_be_fprintf_uninit
	Implements the functionality for pantheios_be_uninit() over the Console API.
#define	pantheios_be_console_logEntry   pantheios_be_fprintf_logEntry
	Implements the functionality for pantheios_be_logEntry() over the Console API.
Typedefs
typedef pan_be_fprintf_init_t	pan_be_console_init_t
	Structure used for specifying initialisation information to the be.console library.
Functions
void	pantheios_be_console_getAppInit (int backEndId, pan_be_console_init_t *init)
	Callback function defined by the application, invoked when the API is initialised with a NULL init parameter.

---

Define Documentation

#define pantheios_be_console_getDefaultAppInit

(

init

)

pantheios_be_fprintf_getAppInit(init)

Fills out a copy of the initialisation structure with default values (representative of the default behaviour of the library), ready to be customised and passed to the API initialiser function pantheios_be_console_init().

Note:

This function should not be called on an already-initialised instance, as is the case in the implementation of the pantheios_be_console_getAppInit() function, as it will already have been called by pantheios_be_console_init() prior to the callback.

#define pantheios_be_console_init   pantheios_be_fprintf_init

Implements the functionality for pantheios_be_init() over the Console API.

#define pantheios_be_console_logEntry   pantheios_be_fprintf_logEntry

Implements the functionality for pantheios_be_logEntry() over the Console API.

#define pantheios_be_console_uninit   pantheios_be_fprintf_uninit

Implements the functionality for pantheios_be_uninit() over the Console API.

---

Typedef Documentation

typedef pan_be_fprintf_init_t pan_be_console_init_t

Structure used for specifying initialisation information to the be.console library.

---

Function Documentation

void pantheios_be_console_getAppInit	(	int	backEndId,
		pan_be_console_init_t *	init
	)

Callback function defined by the application, invoked when the API is initialised with a NULL init parameter.

Parameters:

	backEndId	The back-end identifier passed to the back-end during its initialisation.
	init	A pointer to an already-initialised instance of pan_be_console_init_t.

If any application-specific changes are required they can be made to the structure to which init points, which will already have been initialised. These changes will then be incorporated into the back-end state, and reflected in its behaviour.

If no changes are required, then the function can be a simple stub, containing no instructions.

Note:

This function is only required when the callback version of the library is used.

Exceptions:

throw()

This function must not throw any exceptions!

Warning:

This function will be called during the initialisation of Pantheios, and so must not make any calls into Pantheios, either directly or indirectly!

Note:

This function is actually an alias for the actual console required, depending on your operating system. If your operating system is Windows, then you are actually using the Pantheios Windows Console Stock Back-end, which means that the name of the callback function will be pantheios_be_WindowsConsole_getAppInit(); if your operating system is UNIX, then you are actually using the Pantheios fprintf() Stock Back-end, which means that the name of the callback function will be pantheios_be_fprintf_getAppInit().

pantheios Library documentation © Matthew Wilson & Synesis Software, 2006-2011