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

---

Detailed Description

Back-end library that provides a custom implementation of the SysLog-protocol for Windows.

Modules
	Pantheios Windows syslog Stock Back-end Flags
	Flags for the Pantheios Windows-SysLog Stock Back-end.
	Pantheios Windows syslog Facility Codes
	Facility levels for the Pantheios Windows-SysLog Stock Back-end.
Classes
struct	pan_be_WindowsSyslog_init_t
	Structure used for specifying initialisation information to the be.WindowsSyslog library. More...
Functions
void	pantheios_be_WindowsSyslog_getAppInit (int backEndId, pan_be_WindowsSyslog_init_t *init)
	Callback function defined by the application, invoked when the API is initialised with a NULL init parameter.
void	pantheios_be_WindowsSyslog_getDefaultAppInit (pan_be_WindowsSyslog_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_WindowsSyslog_init().
int	pantheios_be_WindowsSyslog_init (PAN_CHAR_T const *processIdentity, int id, pan_be_WindowsSyslog_init_t const *init, void *reserved, void **ptoken)
	Implements the functionality for pantheios_be_init() over the Windows-SysLog API.
void	pantheios_be_WindowsSyslog_uninit (void *token)
	Implements the functionality for pantheios_be_uninit() over the Windows-SysLog API.
int	pantheios_be_WindowsSyslog_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-SysLog API.

---

Function Documentation

void pantheios_be_WindowsSyslog_getAppInit	(	int	backEndId,
		pan_be_WindowsSyslog_init_t *	init
	)

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

Note:

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

void pantheios_be_WindowsSyslog_getDefaultAppInit

(

pan_be_WindowsSyslog_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_WindowsSyslog_init().

Note:

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

int pantheios_be_WindowsSyslog_init	(	PAN_CHAR_T const *	processIdentity,
		int	id,
		pan_be_WindowsSyslog_init_t const *	init,
		void *	reserved,
		void **	ptoken
	)

Implements the functionality for pantheios_be_init() over the Windows-SysLog API.

Remarks:

This function will fail to initialise if the host does not have network connectivity. Users should consider using with be.N and applying the PANTHEIOS_BE_N_F_IGNORE_INIT_FAILURE and PANTHEIOS_BE_N_F_INIT_ONLY_IF_PREVIOUS_FAILED flags, so that initialisation failure will not prevent the application from initialising.

int pantheios_be_WindowsSyslog_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-SysLog API.

void pantheios_be_WindowsSyslog_uninit

(

void *

token

)

Implements the functionality for pantheios_be_uninit() over the Windows-SysLog API.

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