pantheios::util Namespace Reference

---

Detailed Description

The namespace within which utility functions are located.

These functions are not ordinarily called directly by Pantheios users

Classes
struct	auto_buffer_selector
	Type-generator template that deduces the appropriate specialisation of stlsoft::auto_buffer. More...
Functions
void	pantheios_onBailOut4 (int severity, char const *message, char const *processId, char const *qualifier)
	Prints a bail-out message to operating system-dependent facilities (e.g.
void	pantheios_onBailOut3 (int severity, char const *message, char const *processId)
	Prints a bail-out message to operating system-dependent facilities (e.g.
pan_char_t *	strdup_nothrow (pan_char_t const *s) throw ()
	Equivalent to pantheios_util_strdup_nothrow().
void	strfree (pan_char_t *s) throw ()
	Equivalent to pantheios_util_strfree().
stlsoft::ss_sint64_t	getCurrentProcessId ()
	Equivalent to pantheios_getCurrentProcessId().
stlsoft::ss_sint64_t	getCurrentThreadId ()
	Equivalent to pantheios_getCurrentThreadId().

---

Function Documentation

void pantheios::util::pantheios_onBailOut3	(	int	severity,
		char const *	message,
		char const *	processId
	)

Prints a bail-out message to operating system-dependent facilities (e.g.

console, file, debugger, event log, etc.) in the event that initialisation (of front-end and/or back-end(s)) does not succeed.

This is invoked within the core, and certain stock front-/back-ends, if initialisation fails. Implementors of custom front-/back-ends may also use it if they fail to initialise, in order to provide information that can be tracked by a user / system administrator.

Parameters:

	severity	The severity level at which the event will be represented to the operating-system dependent facilities
	message	The message to be emitted
	processId	An optional identifier of the process within which the subsystem has failed. May be NULL

Remarks:

On UNIX systems, this function will output to the console, the file "logging-bailout.txt" in the current directory, and to Syslog. On Windows systems, this function will output to the console, the file "logging-bailout.txt" in the current directory, the Windows debugger, and to the Windows Event Log.

See also:

pantheios_onBailOut4

Note:

This is equivalent to calling pantheios_onBailOut4() specifying NULL for the qualifier parameter

void pantheios::util::pantheios_onBailOut4	(	int	severity,
		char const *	message,
		char const *	processId,
		char const *	qualifier
	)

Prints a bail-out message to operating system-dependent facilities (e.g.

console, file, debugger, event log, etc.) in the event that initialisation (of front-end and/or back-end(s)) does not succeed.

This is invoked within the core, and certain stock front-/back-ends, if initialisation fails. Implementors of custom front-/back-ends may also use it if they fail to initialise, in order to provide information that can be tracked by a user / system administrator.

Parameters:

	severity	The severity level at which the event will be represented to the operating-system dependent facilities
	message	The message to be emitted
	processId	An optional identifier of the process within which the subsystem has failed. May be NULL
	qualifier	An optional additional qualifier (e.g. error string) that may be used to pass additional information about the reason why the subsystem has failed. May be NULL

Remarks:

On UNIX systems, this function will output to the console, the file "logging-bailout.txt" in the current directory, and to Syslog. On Windows systems, this function will output to the console, the file "logging-bailout.txt" in the current directory, the Windows debugger, and to the Windows Event Log.

See also:

pantheios_onBailOut3

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