System Error Log Message Types

There are four types of log entries. More...

Macros
#define	SYSLOG_ERROR   0x00000001
	An error message. More...
#define	SYSLOG_WARN   0x00000002
	An example of this type is a message telling the user the MAX file just loaded is obsolete and needs to be resaved. More...
#define	SYSLOG_INFO   0x00000004
	An example of this is a message indicating a new MAX file has been loaded. More...
#define	SYSLOG_DEBUG   0x00000008
	This message type is for anything you think might help trace problems that the user has with your code. More...
#define	SYSLOG_STARTBATCH   0x00000010
	The next three defines are used when you want to send a large number of messages to the logger to prevent it from continually opening/closing the log for performance reason. More...
#define	SYSLOG_BATCH   0x00000020
	Used to mark messages that are sent in batch. More...
#define	SYSLOG_ENDBATCH   0x00000040
	Used to mark the end an batch message. More...
#define	SYSLOG_BROADCAST   0x00010000
#define	SYSLOG_MR   0x00020000
#define	SYSLOG_IGNORE_VERBOSITY   0x00040000
	Used with SYSLOG_BROADCAST to force the display of important messages that are not errors or warnings. More...

Detailed Description

There are four types of log entries.

In the preference dialog, the user can select what types of log entries they want to be generated. This is how users control the verbosity of the log file in some meaningful way. Developers are encouraged to be very verbose about information and debug messages – the Log() functions should be used to record any events out of the ordinary. As the user can elect to ignore these messages they are perfect for troubleshooting. The values can be OR'd together.

SYSLOG_DEBUG messages are also always sent to the debugger output using DebugPrint()

See also

Class LogSys

Macro Definition Documentation

SYSLOG_ERROR

#define SYSLOG_ERROR   0x00000001

An error message.

An example of this type is a fatal error.

Note

Do NOT pass in a string longer than 8192 characters when passing in this type (Otherwise you will crash).

SYSLOG_WARN

#define SYSLOG_WARN   0x00000002

An example of this type is a message telling the user the MAX file just loaded is obsolete and needs to be resaved.

This option may not be selected by the MAX user via the UI but it is available for use (it's used internally often). A warning message.

SYSLOG_INFO

#define SYSLOG_INFO   0x00000004

An example of this is a message indicating a new MAX file has been loaded.

An information message.

SYSLOG_DEBUG

#define SYSLOG_DEBUG   0x00000008

This message type is for anything you think might help trace problems that the user has with your code.

Message will also be sent to the debugger output using DebugPrint(). A debug message.

SYSLOG_STARTBATCH

#define SYSLOG_STARTBATCH   0x00000010

The next three defines are used when you want to send a large number of messages to the logger to prevent it from continually opening/closing the log for performance reason.

The first message's type should be OR'd with SYSLOG_STARTBATCH The following messages should be OR's with SYSLOG_BATCH And when you are done sending messages the last one should be OR's with SYSLOG_ENDBATCH

logger->LogEntry(SYSLOG_INFO|SYSLOG_STARTBATCH,...); logger->LogEntry(SYSLOG_INFO|SYSLOG_BATCH,...); logger->LogEntry(SYSLOG_INFO|SYSLOG_BATCH,...); logger->LogEntry(SYSLOG_INFO|SYSLOG_BATCH,...); logger->LogEntry(SYSLOG_INFO|SYSLOG_ENDBATCH,...);

SYSLOG_BATCH

#define SYSLOG_BATCH   0x00000020

Used to mark messages that are sent in batch.

SYSLOG_ENDBATCH

#define SYSLOG_ENDBATCH   0x00000040

Used to mark the end an batch message.

SYSLOG_BROADCAST

#define SYSLOG_BROADCAST   0x00010000

SYSLOG_MR

#define SYSLOG_MR   0x00020000

SYSLOG_IGNORE_VERBOSITY

#define SYSLOG_IGNORE_VERBOSITY   0x00040000

Used with SYSLOG_BROADCAST to force the display of important messages that are not errors or warnings.