gxlog.h File Reference

---

Detailed Description

Logging interface

The GX is the base system for the majority of the ARH Inc. products. It is a collection of loadable modules and library functions and gives an easy to program interface to the hardware devices.

This file contains the descriptions of classes and functions of the logging module.

Go to the source code of this file.

Classes
class	gxLog
	Class for the GX LOG functions. More...
Defines
#define	gx_emerg
	Writes an emergency item to the log with debug information in debug mode.
#define	gx_emergency   gx_emerg
	Writes an emergency item to the log with debug information in debug mode.
#define	gx_fatal
	Writes a fatal item to the log with debug information in debug mode.
#define	gx_error
	Writes an error item to the log with debug information in debug mode.
#define	gx_warn
	Writes a warning item to the log with debug information in debug mode.
#define	gx_warning   gx_warn
	Writes a warning item to the log with debug information in debug mode.
#define	gx_info
	Writes an information item to the log with debug information in debug mode.
#define	gx_info2
	Writes an information item to the log with debug information in debug mode.
#define	gx_info3
	Writes an information item to the log with debug information in debug mode.
#define	gx_debug
	Writes a debug item to the log with debug information.
#define	gx_debug2
	Writes a low-level debug item to the log with debug information.
Enumerations
enum	GX_LOGLEVELS {   GX_NONE = 0,   GX_EMERG,   GX_FATAL,   GX_ERROR,   GX_WARN,   GX_INFO,   GX_INFO2,   GX_INFO3,   GX_DEBUG,   GX_DEBUG2 }
	Enumerations for the log levels. More...
Functions
gxi32	gx_writelogv (gxHANDLE handle, gxi32 level, const char *file, gxi32 line, const char *function, const wchar_t *str, va_list args)
	Writes a log with debug information.
gxi32	gx_writelogv (gxHANDLE handle, gxi32 level, const wchar_t *str, va_list args)
	Writes a log.
gxi32	gx_writelogva (gxHANDLE handle, gxi32 level, const char *file, gxi32 line, const char *function, const char *str, va_list args)
	Writes a log with debug information.
gxi32	gx_writelogv (gxHANDLE handle, gxi32 level, const char *str, va_list args)
	Writes a log.
gxi32	gx_writelogv (gxHANDLE handle, gxi32 level, const char *file, gxi32 line, const char *function, const char *str, va_list args)
	Writes a log with debug information.
gxi32	gx_writelog (gxHANDLE handle, gxi32 level, const char *file, gxi32 line, const char *function, const wchar_t *str,...)
	Writes a log with debug information.
gxi32	gx_writelog (gxHANDLE handle, gxi32 level, const wchar_t *str,...)
	Writes a log.
gxi32	gx_writeloga (gxHANDLE handle, gxi32 level, const char *file, gxi32 line, const char *function, const char *str,...)
	Writes a log with debug information.
gxi32	gx_writelog (gxHANDLE handle, gxi32 level, const char *str,...)
	Writes a log.
gxi32	gx_writelog (gxHANDLE handle, gxi32 level, const char *file, gxi32 line, const char *function, const char *str,...)
	Writes a log with debug information.
gxi32	gx_writelogv (gxi32 level, const char *file, gxi32 line, const char *function, const wchar_t *str, va_list args)
	Writes a log with debug information.
gxi32	gx_writelogv (gxi32 level, const wchar_t *str, va_list args)
	Writes a log.
gxi32	gx_writelogv (gxi32 level, const char *file, gxi32 line, const char *function, const char *str, va_list args)
	Writes a log with debug information.
gxi32	gx_writelogv (gxi32 level, const char *str, va_list args)
	Writes a log with debug information.
gxi32	gx_writelog (gxi32 level, const char *file, gxi32 line, const char *function, const wchar_t *str,...)
	Writes a log with debug information.
gxi32	gx_writelog (gxi32 level, const wchar_t *str,...)
	Writes a log with debug information.
gxi32	gx_writelog (gxi32 level, const char *file, gxi32 line, const char *function, const char *str,...)
	Writes a log with debug information.
gxi32	gx_writelog (gxi32 level, const char *str,...)
	Writes a log.

---

Define Documentation

#define gx_emerg

Value:

gxlog._Set(GX_EMERG, __FILE__, __LINE__, _GX_FUNCTION_), \
            gxlog._WriteLog

Writes an emergency item to the log with debug information in debug mode.

Warning:

The 'gxlog' class must be defined. (gxLog gxlog)

#define gx_emergency   gx_emerg

Writes an emergency item to the log with debug information in debug mode.

Warning:

The 'gxlog' class must be defined. (gxLog gxlog)

#define gx_fatal

Value:

gxlog._Set(GX_FATAL, __FILE__, __LINE__, _GX_FUNCTION_), \
            gxlog._WriteLog

Writes a fatal item to the log with debug information in debug mode.

Warning:

The 'gxlog' class must be defined. (gxLog gxlog)

#define gx_error

Value:

gxlog._Set(GX_ERROR, __FILE__, __LINE__, _GX_FUNCTION_), \
            gxlog._WriteLog

Writes an error item to the log with debug information in debug mode.

Warning:

The 'gxlog' class must be defined. (gxLog gxlog)

#define gx_warn

Value:

gxlog._Set(GX_WARN, __FILE__, __LINE__, _GX_FUNCTION_), \
            gxlog._WriteLog

Writes a warning item to the log with debug information in debug mode.

Warning:

The 'gxlog' class must be defined. (gxLog gxlog)

#define gx_warning   gx_warn

Writes a warning item to the log with debug information in debug mode.

Warning:

The 'gxlog' class must be defined. (gxLog gxlog)

#define gx_info

Value:

gxlog._Set(GX_INFO, __FILE__, __LINE__, _GX_FUNCTION_), \
            gxlog._WriteLog

Writes an information item to the log with debug information in debug mode.

Warning:

The 'gxlog' class must be defined. (gxLog gxlog)

#define gx_info2

Value:

gxlog._Set(GX_INFO2, __FILE__, __LINE__, _GX_FUNCTION_), \
            gxlog._WriteLog

Writes an information item to the log with debug information in debug mode.

Warning:

The 'gxlog' class must be defined. (gxLog gxlog)

#define gx_info3

Value:

gxlog._Set(GX_INFO3, __FILE__, __LINE__, _GX_FUNCTION_), \
            gxlog._WriteLog

Writes an information item to the log with debug information in debug mode.

Warning:

The 'gxlog' class must be defined. (gxLog gxlog)

#define gx_debug

Value:

gxlog._Set(GX_DEBUG, __FILE__, __LINE__, _GX_FUNCTION_), \
            gxlog._WriteLog

Writes a debug item to the log with debug information.

Only works in debug mode.

Warning:

The 'gxlog' class must be defined. (gxLog gxlog)

#define gx_debug2

Value:

gxlog._Set(GX_DEBUG2, __FILE__, __LINE__, _GX_FUNCTION_), \
            gxlog._WriteLog

Writes a low-level debug item to the log with debug information.

Only works in debug mode.

Warning:

The 'gxlog' class must be defined. (gxLog gxlog)

---

Enumeration Type Documentation

enum GX_LOGLEVELS

Enumerations for the log levels.

Enumerator:

GX_NONE	No log messages.
GX_EMERG	Emergency messages, application broken and probably loss of data.
GX_FATAL	Fatal error, the application can not be continued.
GX_ERROR	Normal error, the application can be continued or terminated with error.
GX_WARN	Warning messages, the application can be continued.
GX_INFO	Information 1.
GX_INFO2	Information 2.
GX_INFO3	Information 3.
GX_DEBUG	Normal debug. (Only if the NDEBUG was not defined)
GX_DEBUG2	Debug in low-level mode. (Only if the NDEBUG was not defined)