Changeset 964 for trunk/psLib/src/sys/psLogMsg.h

Timestamp:

Jun 9, 2004, 2:09:55 PM (22 years ago)

Author:

gusciora

Message:

Renamed psLog messages, commented the psHash code.

File:

• trunk/psLib/src/sys/psLogMsg.h (modified) (2 diffs)

trunk/psLib/src/sys/psLogMsg.h

@@ -15 +15 @@
  */
 
-/// Sets the log destination
-int psSetLogDestination(int dest);
+/// This procedure sets the destination for future log messages.  Currently
+/// the destination is specified by an integer which can have the following
+/// pre-defined values: PS_LOG_NONE, PS_LOG_TO_STDOUT, and PS_LOG_TO_STDERR.
+/// IN future versions, this procedure will take a character string as an
+/// argument which can specify more general log destinations.
+int psLogSetDestination(int dest);
 
-/// Sets the log level
-int psSetLogLevel(int level);
+/// This procedure sets the global level for future log messages.  Future
+/// log messages, each with a log level of mylevel, will only be logged if
+/// their mylevel is less than the current log level set by this procedure.
+/// Ie. higher values set by this procedure will cause more log messages to
+/// be displayed.
+int psLogSetLevel(int level);
 
-/// sets the log format
-void psSetLogFormat(const char *fmt);
+/// This procedure sets the log format for future log messages.  The argument
+/// must be a character string consistsing of the letters H (host), L
+/// (level), M (message), N (name), and T (time).  The default is "THLNM".
+/// Deleting a letter from the string will cause the associated information
+/// to not be logged.
+void psLogSetFormat(const char *fmt);
 
-/// Logs a message
+
+/// This procedure logs a message to the destination set by a prior
+/// call to psLogSetDestination(), if myLevel is less than the level
+/// specified by a prior call to psLogSetLevel().  The message is specified
+/// with a printf-stype string an arguments.
 void psLogMsg(const char *name,     ///< name of the log source
               int myLevel,          ///< severity level of this log message
@@ -30 +46 @@
 ;
 
-/// Logs a message from varargs
+
+
+/// This procedure is functionally equivalent to psLogMsg(), except that
+/// it takes a va_list as the message paramater, not a printf-style string.
 void psVLogMsg(const char *name, ///< name of the log source
                int myLevel,      ///< severity level of this log message