include/pantheios/backends/bec.Win32Debugger.h File Reference

Detailed Description

[C, C++] Pantheios Win32 Debugger Back-end Common API

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

Go to the source code of this file.

Classes

struct  pan_be_Win32Debugger_init_t
 Structure used for specifying initialisation information to the be.Win32Debugger library. More...

Defines

#define PANTHEIOS_BE_WIN32DEBUGGER_F_NO_PROCESS_ID   (0x00000001)
 Causes the Pantheios Win32 Debugger Stock Back-end to omit the process identity from emitted log statements.
#define PANTHEIOS_BE_WIN32DEBUGGER_F_NO_TIME   (0x00000002)
 Causes the Pantheios Win32 Debugger Stock Back-end to omit the time from emitted log statements.
#define PANTHEIOS_BE_WIN32DEBUGGER_F_NO_SEVERITY   (0x00000004)
 Causes the Pantheios Win32 Debugger Stock Back-end to omit the severity from emitted log statements.
#define PANTHEIOS_BE_WIN32DEBUGGER_F_USE_SYSTEM_TIME   (0x00000008)
 Causes the Pantheios Win32 Debugger Stock Back-end to use system time, rather than local time, from emitted log statements.

Functions

void pantheios_be_Win32Debugger_getAppInit (int backEndId, pan_be_Win32Debugger_init_t *init)
 Callback function defined by the application, invoked when the API is initialised with a NULL init parameter.
void pantheios_be_Win32Debugger_getDefaultAppInit (pan_be_Win32Debugger_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_Win32Debugger_init().
int pantheios_be_Win32Debugger_init (char const *processIdentity, int id, pan_be_Win32Debugger_init_t const *init, void *reserved, void **ptoken)
 Implements the functionality for pantheios_be_init() over the Win32 Debugger API.
void pantheios_be_Win32Debugger_uninit (void *token)
 Implements the functionality for pantheios_be_uninit() over the Win32 Debugger API.
int pantheios_be_Win32Debugger_logEntry (void *feToken, void *beToken, int severity, char const *entry, size_t cchEntry)
 Implements the functionality for pantheios_be_logEntry() over the Win32 Debugger API.

Function Documentation

void pantheios_be_Win32Debugger_getAppInit (  int  backEndId,
pan_be_Win32Debugger_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_Win32Debugger_getDefaultAppInit (  pan_be_Win32Debugger_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_Win32Debugger_init().

pantheios Library documentation © Matthew Wilson, 2006 SourceForge.net Logo