Changeset 4972 for trunk/psLib/src/sys/psTrace.h

Timestamp:

Sep 7, 2005, 2:27:50 PM (21 years ago)

Author:

drobbin

Message:

Added psTraceSetFormat as outlined from SDRS 15

File:

• trunk/psLib/src/sys/psTrace.h (modified) (3 diffs)

trunk/psLib/src/sys/psTrace.h

@@ -9 +9 @@
  *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.37 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-09-07 00:15:48 $
+ *  @version $Revision: 1.38 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-09-08 00:27:50 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -59 +59 @@
 p_psComponent;
 
+#ifdef DOXYGEN
+/** This procedure sets the trace format for future trace 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.  This procedure does not alter the order in which
+ *  the messages are displayed.
+ *
+ *  @return bool:       True if successful, otherwise false.
+ */
+bool psTraceSetFormat(
+    const char *format                 ///< Specifies the system trace format
+);
+
 /** Sends a trace message. */
-#ifdef DOXYGEN
 void psTrace(
     const char *facil,                 ///< facilty of interest
@@ -79 +92 @@
 #ifndef SWIG
 #define psTrace(facil, level, ...) p_psTrace(facil, level, __VA_ARGS__)
+/** Sends a trace message. */
+void psTraceV(
+    const char *facil,                 ///< facilty of interest
+    int level,                         ///< desired trace level
+    const char *format,                ///< printf-style format command
+    va_list ap                         ///< varargs argument list
+);
+
 #endif /* SWIG */