Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Examples

pglog.h File Reference


Detailed Description

ParaGUI logging facility.

This header declares the PG_LogConsole namespace and all functions for log processing.


Namespaces

namespace  PG_LogConsole

Defines

#define PG_LOGMTH_STDOUT   1
 Logmethod: STDOUT.

#define PG_LOGMTH_STDERR   2
 Logmethod: STDERR.

#define PG_LOGMTH_CONSOLE   4
 Logmethod: CONSOLE.


Enumerations

enum  PG_LOG_LEVEL {
  PG_LOG_NONE, PG_LOG_ERR, PG_LOG_WRN, PG_LOG_MSG,
  PG_LOG_DBG
}
 ParaGUI logging level. More...


Functions

void PG_Log (PG_LOG_LEVEL id, const char *Text,...)
 Log a message.

void PG_LogMSG (const char *fmt,...)
 Log a message with log level "message".

void PG_LogERR (const char *fmt,...)
 Log a message with log level "error".

void PG_LogWRN (const char *fmt,...)
 Log a message with log level "warning".

void PG_LogDBG (const char *fmt,...)
 Log a message with log level "debug".


Define Documentation

#define PG_LOGMTH_CONSOLE   4
 

Logmethod: CONSOLE.

Send all log messages to the console window.

#define PG_LOGMTH_STDERR   2
 

Logmethod: STDERR.

Send all log messages to stderr.

#define PG_LOGMTH_STDOUT   1
 

Logmethod: STDOUT.

Send all log messages to stdout.


Enumeration Type Documentation

enum PG_LOG_LEVEL
 

ParaGUI logging level.

Enumeration values:
PG_LOG_NONE  log nothing
PG_LOG_ERR  only errors
PG_LOG_WRN  errors and warnings
PG_LOG_MSG  display errors, warnings and messages
PG_LOG_DBG  log everything


Function Documentation

void PG_Log PG_LOG_LEVEL  id,
const char *  Text,
... 
 

Log a message.

Parameters:
id the log level id of the message
Text a printf format string, arbitrary arguments may follow

void PG_LogDBG const char *  fmt,
... 
 

Log a message with log level "debug".

Parameters:
fmt printf format string
Examples:
paratest.cpp.

void PG_LogERR const char *  fmt,
... 
 

Log a message with log level "error".

Parameters:
fmt printf format string
Examples:
dblbuffer.cpp, and paratest.cpp.

void PG_LogMSG const char *  fmt,
... 
 

Log a message with log level "message".

Parameters:
fmt printf format log string
Examples:
dblbuffer.cpp, and paratest.cpp.

void PG_LogWRN const char *  fmt,
... 
 

Log a message with log level "warning".

Parameters:
fmt printf format string


The ParaGUI Project - Alexander Pipelka