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

---

Detailed Description

Back-end library that outputs to the Windows console, colour-coding based on severity level.

Modules
	Pantheios Windows Console Stock Back-end Flags
	Flags for the Pantheios Windows Console Stock Back-end.
Classes
struct	pan_be_WindowsConsole_init_t
	Structure used for specifying initialisation information to the be.WindowsConsole library. More...
Functions
void	pantheios_be_WindowsConsole_getAppInit (int backEndId, pan_be_WindowsConsole_init_t *init)
	Callback function defined by the application, invoked when the API is initialised with a NULL init parameter.
void	pantheios_be_WindowsConsole_getDefaultAppInit (pan_be_WindowsConsole_init_t *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_WindowsConsole_init().
int	pantheios_be_WindowsConsole_init (PAN_CHAR_T const *processIdentity, int id, pan_be_WindowsConsole_init_t const *init, void *param, void **ptoken)
	Implements the functionality for pantheios_be_init() over the Windows Console API.
void	pantheios_be_WindowsConsole_uninit (void *token)
	Implements the functionality for pantheios_be_uninit() over the Windows Console API.
int	pantheios_be_WindowsConsole_logEntry (void *feToken, void *beToken, int severity, PAN_CHAR_T const *entry, size_t cchEntry)
	Implements the functionality for pantheios_be_logEntry() over the Windows Console API.

---

Function Documentation

void pantheios_be_WindowsConsole_getAppInit	(	int	backEndId,
		pan_be_WindowsConsole_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_WindowsConsole_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!

Examples:

cpp/backends/example.cpp.backends.callback/example.cpp.backends.callback.cpp.

void pantheios_be_WindowsConsole_getDefaultAppInit

(

pan_be_WindowsConsole_init_t *

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_WindowsConsole_init().

Note:

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

int pantheios_be_WindowsConsole_init	(	PAN_CHAR_T const *	processIdentity,
		int	id,
		pan_be_WindowsConsole_init_t const *	init,
		void *	param,
		void **	ptoken
	)

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

int pantheios_be_WindowsConsole_logEntry	(	void *	feToken,
		void *	beToken,
		int	severity,
		PAN_CHAR_T const *	entry,
		size_t	cchEntry
	)

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

void pantheios_be_WindowsConsole_uninit

(

void *

token

)

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

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