/[ascend]/trunk/base/generic/utilities/ascPanic.h
ViewVC logotype

Diff of /trunk/base/generic/utilities/ascPanic.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 40 by jds, Sat Jan 22 14:22:13 2005 UTC revision 54 by jds, Tue Aug 2 11:20:09 2005 UTC
# Line 1  Line 1 
1  /**   /*
2   *  Ascend Panic   *  Ascend Panic
3   *  by Mark Thomas   *  by Mark Thomas
4   *  Created: 1997.05.15   *  Created: 1997.05.15
# Line 25  Line 25 
25   *  along with the program; if not, write to the Free Software Foundation,   *  along with the program; if not, write to the Free Software Foundation,
26   *  Inc., 675 Mass Ave, Cambridge, MA 02139 USA.  Check the file named   *  Inc., 675 Mass Ave, Cambridge, MA 02139 USA.  Check the file named
27   *  COPYING.   *  COPYING.
  *  
28   */   */
29    
30  #ifndef _ASCPANIC_H  /** @file
31  #define _ASCPANIC_H   *  Ascend Panic - Fatal Error Handling.
32     *  <pre>
 /**  
33   *  To include this header file, you must include the following:   *  To include this header file, you must include the following:
34   *      #include <stdarg.h>   *      #include <stdarg.h>
35     *      #include "utilities/ascConfig.h"
36   *      #include "compiler/compiler.h"   *      #include "compiler/compiler.h"
37   *      #include "compiler/ascpanic.h"   *      #include "compiler/ascPanic.h"
38     *  </pre>
39   */   */
40    
41    #ifndef _ASCPANIC_H
42    #define _ASCPANIC_H
43    
44  /**  /**
45   * Asc_Panic( status, function, format, args )   * <!--  Asc_Panic( status, function, format, args )                   -->
46   *      int status;   * <!--       int status;                                              -->
47   *      CONST char *function   * <!--       CONST char *function                                     -->
48   *      CONST char *format   * <!--       CONST char *format                                       -->
49   *      VAR_ARGS args   * <!--       VAR_ARGS args                                            -->
50   *   *
51   *  This function prints the arguments "args" using the format string   *  This function prints the arguments "args" using the format string
52   *  "format" to the ASCERR file handle.  The first line of the panic   *  "format" to the ASCERR file handle.  The first line of the panic
# Line 53  Line 55 
55   *  valid file pointer, the message will not be printed.  Either way,   *  valid file pointer, the message will not be printed.  Either way,
56   *  if an panic output file location has been specified with the   *  if an panic output file location has been specified with the
57   *  Asc_PanicSetOutfile() function, the panic message is also stored   *  Asc_PanicSetOutfile() function, the panic message is also stored
58   *  there.  Under Windows, we also pop up a MessageBox containing the   *  there.  Under Windows, we also pop up a MessageBox containing the
59   *  message.  Finally, we exit the program with the status "status".   *  message.  Finally, we exit the program with the status "status".<br><br>
60   *   *
61   *  Side Effects: Exits the program.   *  Side Effects: Exits the program.
62   */   */
63  extern void Asc_Panic(CONST int status, CONST char *function,  extern void Asc_Panic(CONST int status, CONST char *function,
64                        CONST char *format, ...);                        CONST char *format, ...);
65    
66    /**
67  /**   *  <!--  Asc_PanicSetOutfile(filename)                                -->
68   *  Asc_PanicSetOutfile(filename)   *  <!--      CONST char *filename;                                    -->
  *      CONST char *filename;  
69   *   *
70   *  Calling this function with a non-NULL "filename" will cause   *  Calling this function with a non-NULL "filename" will cause
71   *  Asc_Panic() to write panic messages to "filename" in addition to the   *  Asc_Panic() to write panic messages to "filename" in addition to the
# Line 74  extern void Asc_Panic(CONST int status, Line 75  extern void Asc_Panic(CONST int status,
75   */   */
76  extern void Asc_PanicSetOutfile(CONST char *filename);  extern void Asc_PanicSetOutfile(CONST char *filename);
77    
78  #endif  /** _ASCPANIC_H */  #endif  /* _ASCPANIC_H */
79    

Legend:
Removed from v.40  
changed lines
  Added in v.54

john.pye@anu.edu.au
ViewVC Help
Powered by ViewVC 1.1.22