pantheios/backends/bec.COMErrorObject.h File Reference

---

Detailed Description

[C, C++] Pantheios COM Error Object Back-end Common API

#include <pantheios/pantheios.h>
#include <pantheios/backend.h>

Go to the source code of this file.

Classes
struct	pan_be_COMErrorObject_init_t
	Structure used for specifying initialisation information to the be.COMErrorObject library. More...
Defines
#define	PANTHEIOS_BE_COMERROROBJECT_F_DONT_OVERWRITE_EXISTING   (0x00100000)
	Prevents the Pantheios COM Error Object Stock Back-end from writing to the COM Error Object if there is an existing error object set (for the calling thread).
Functions
void	pantheios_be_COMErrorObject_getAppInit (int backEndId, pan_be_COMErrorObject_init_t *init)
	Callback function defined by the application, invoked when the API is initialised with a NULL init parameter.
void	pantheios_be_COMErrorObject_getDefaultAppInit (pan_be_COMErrorObject_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_COMErrorObject_init().
int	pantheios_be_COMErrorObject_init (PAN_CHAR_T const *processIdentity, int id, pan_be_COMErrorObject_init_t const *init, void *reserved, void **ptoken)
	Implements the functionality for pantheios_be_init() over the COM Error Object API.
void	pantheios_be_COMErrorObject_uninit (void *token)
	Implements the functionality for pantheios_be_uninit() over the COM Error Object API.
int	pantheios_be_COMErrorObject_logEntry (void *feToken, void *beToken, int severity, PAN_CHAR_T const *entry, size_t cchEntry)
	Implements the functionality for pantheios_be_logEntry() over the COM Error Object API.
int	pantheios_be_COMErrorObject_parseArgs (size_t numArgs, pantheios::pan_slice_t *const args, pan_be_COMErrorObject_init_t *init)
	Parses the be.COMErrorObject back-end flags.

---

Function Documentation

void pantheios_be_COMErrorObject_getAppInit	(	int	backEndId,
		pan_be_COMErrorObject_init_t *	init
	)

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

Note:

When using explicit initialisation, this function must be defined, but will not be invoked.

void pantheios_be_COMErrorObject_getDefaultAppInit

(

pan_be_COMErrorObject_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_COMErrorObject_init().

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