ITK Function Reference
(V10000.1.0.60_20160308.00)
error_decode.h
Go to the documentation of this file.
1 /*HEAD ERROR_DECODE HHH SYSS */
2 /*CLASS ERROR */
3 /*==============================================================================
4 
5  Copyright (c) 1998,1999 Unigraphics Solutions Inc.
6  Unpublished - All rights reserved
7 
8 ================================================================================
9 File description:
10  Function prototypes for the named module or functional area.
11 
12 ================================================================================
13  Date Name Description of Change
14 13-Nov-1998 Jack Marr Move contents from error.h
15 18-Nov-1998 Jack Marr Add ERROR_OK from error_bases.h
16 25-Jan-1999 Adrian Brown Create in Jeeves
17 08-Mar-1999 Reger Decorate prototypes with UGEXPORT;
18  include unidefs.h for UGEXPORT
19 18-Mar-1999 Gary Smethers V16 phase 5 CCR
20 12-Oct-1999 Lavarini Use SYSSEXPORT to decorate prototypes
21 29-Oct-1999 Gary Smethers V16 phase 20 CCR
22 NX 2
23 08-Jul-2002 Lavarini Add ERROR_ask_fail_message()
24 28-Jul-2005 BJS Provide out of memory code registration mechanism
25 $HISTORY$
26 ==============================================================================*/
27 
28 #ifndef ERROR_DECODE_H_INCLUDED
29 #define ERROR_DECODE_H_INCLUDED
30 
31 #include <libsyss_exports.h>
32 
33 /* <MRA> 11-Jan-93
34  Routines written to decode error numbers into useful strings.
35  See error_decode.c for details.
36 
37  <JLM> 13-Nov-98
38  Prototypes for registration functions and types moved to
39  error_decode_privileged.h.
40 */
41 
42 extern SYSSEXPORT char * ERROR_decode(int code);
43 
44 /* <KEK> 15-Nov-93
45  Return the error base of the given error code. Returns 0 if no error base
46  is found or if the error is an internal error.
47 */
48 extern SYSSEXPORT int ERROR_ask_base(int code);
49 
50 /* <DJL> 08-Jul-2002
51  This function was renamed from ASSY_get_fail_message(). There needs to
52  be more standardized method of getting error messages. The return
53  char * is NOT freed after use. This function calls both ERROR_decode()
54  and CFI_decode_error().
55 */
56 extern SYSSEXPORT char * ERROR_ask_fail_message ( int code );
57 
58 // <BJS> 25-Jul-2005
59 // Register a given error code as signifying out of memory of some sort.
60 extern SYSSEXPORT void ERROR_register_out_of_memory_code(int code);
61 
62 // <BJS> 25-Jul-2005
63 // Test if a given error code is some sort of out of memory code
64 extern SYSSEXPORT logical ERROR_is_out_of_memory_code(int code);
65 
66 /* <JLM> 18-Nov-98 Add the ubiquitous ERROR_OK */
67 
68 #define ERROR_OK 0
69 
70 #undef EXPORTLIBRARY
71 
72 #endif /* ERROR_DECODE_H_INCLUDED */