Changeset 753 for trunk/archive/pslib/include/psError.h

Timestamp:

May 20, 2004, 6:12:37 PM (22 years ago)

Author:

eugene

Message:

substantial API changes based on change to PSLib SDRS

File:

• trunk/archive/pslib/include/psError.h (modified) (1 diff)

trunk/archive/pslib/include/psError.h

@@ -12 +12 @@
 
 typedef struct {
-    psErrorCode code;                   // An error code
-    const char *descrip;                // the associated description
+    psErrorCode code;                   ///< An error code
+    const char *descrip;                ///< the associated description
 } psErrorDescription;
 
 typedef struct {
-    char *name;                         // category of code that caused the error
-    psErrorCode code;                   // class of error (equivalent to errno)
-    char *msg;                          // the message associated with the error
+    char *name;                         ///< category of code that caused the error
+    psErrorCode code;                   ///< class of error (equivalent to errno)
+    char *msg;                          ///< the message associated with the error
 } psErr;
-
-typedef enum {
-    PS_OLD_ERROR = 0,                   ///< This is an old error, and should append to the error stack
-    PS_NEW_ERROR = 1,                   ///< This is a new error and should clear the error stack
-} psErrorStatus;
 
 /// Prints an error message and doesn't abort; returns code
 int psError(const char *name,           ///< Category of code that caused the error
             psErrorCode code,           ///< class of error (equivalent to errno)
-            psErrorStatus status,       ///< is this a new error?
+            int new,                    ///< is this a new error?
             const char *fmt,            ///< Format
-            ...                         ///< Extra arguments to use format
-    );
+            ...)                        ///< Extra arguments to use format
+;
 
 void p_psErrorRegister(const psErrorDescription *errors, ///< register a set of errors
-                       int nerror);                    ///< number of errors
+                       int nerror)      ///< number of errors
+;
 
-const psErr *psErrorGet(int which);     // return specified error (or an "error" with code PS_ERR_NONE)
-const psErr *psErrorLast(void);         // return last error (or an "error" with code PS_ERR_NONE)
+///< return specified error (or an "error" with code PS_ERR_NONE)
+const psErr *psErrorGet(int which);     
 
-void psErrorClear(void);                ///< Clear the error stack
+///< return last error (or an "error" with code PS_ERR_NONE)
+const psErr *psErrorLast(void);         
 
-const char *psErrorCodeString(psErrorCode code);        ///< return the string associated with the error code
-void psErrorStackPrint(FILE *fd, const char *fmt, ...); ///< print the errorstack to this file descriptor
-void psErrorVStackPrint(FILE *fd,       //< write to this file descriptor
-                        const char *fmt,//< format for any header information; may be NULL
-                        va_list ap);    //< arguments for format
+///< Clear the error stack
+void psErrorClear(void);                
+
+///< return the string associated with the error code
+const char *psErrorCodeString(psErrorCode code);        
+
+///< print the errorstack to this file descriptor
+void psErrorStackPrint(FILE *fd,        ///< write to this file descriptor
+                       const char *fmt, ///< format for any header information; may be NULL
+                       ...)             ///< arguments for format
+;       
+
+///< print the errorstack to this file descriptor (stdargs version)
+void psErrorStackPrintV(FILE *fd,       ///< write to this file descriptor
+                        const char *fmt,///< format for any header information; may be NULL
+                        va_list ap)     ///< arguments for format
+;
+
 
 #endif