00001 /*HEAD ERROR_DECODE HHH SYSS */ 00002 /*CLASS ERROR */ 00003 /*============================================================================== 00004 00005 Copyright (c) 1998,1999 Unigraphics Solutions Inc. 00006 Unpublished - All rights reserved 00007 00008 ================================================================================ 00009 File description: 00010 Function prototypes for the named module or functional area. 00011 00012 ================================================================================ 00013 Date Name Description of Change 00014 13-Nov-1998 Jack Marr Move contents from error.h 00015 18-Nov-1998 Jack Marr Add ERROR_OK from error_bases.h 00016 25-Jan-1999 Adrian Brown Create in Jeeves 00017 08-Mar-1999 Reger Decorate prototypes with UGEXPORT; 00018 include unidefs.h for UGEXPORT 00019 18-Mar-1999 Gary Smethers V16 phase 5 CCR 00020 12-Oct-1999 Lavarini Use SYSSEXPORT to decorate prototypes 00021 29-Oct-1999 Gary Smethers V16 phase 20 CCR 00022 NX 2 00023 08-Jul-2002 Lavarini Add ERROR_ask_fail_message() 00024 28-Jul-2005 BJS Provide out of memory code registration mechanism 00025 $HISTORY$ 00026 ==============================================================================*/ 00027 00028 #ifndef ERROR_DECODE_H_INCLUDED 00029 #define ERROR_DECODE_H_INCLUDED 00030 00031 #include <libsyss_exports.h> 00032 00033 /* <MRA> 11-Jan-93 00034 Routines written to decode error numbers into useful strings. 00035 See error_decode.c for details. 00036 00037 <JLM> 13-Nov-98 00038 Prototypes for registration functions and types moved to 00039 error_decode_privileged.h. 00040 */ 00041 00042 extern SYSSEXPORT char * ERROR_decode(int code); 00043 00044 /* <KEK> 15-Nov-93 00045 Return the error base of the given error code. Returns 0 if no error base 00046 is found or if the error is an internal error. 00047 */ 00048 extern SYSSEXPORT int ERROR_ask_base(int code); 00049 00050 /* <DJL> 08-Jul-2002 00051 This function was renamed from ASSY_get_fail_message(). There needs to 00052 be more standardized method of getting error messages. The return 00053 char * is NOT freed after use. This function calls both ERROR_decode() 00054 and CFI_decode_error(). 00055 */ 00056 extern SYSSEXPORT char * ERROR_ask_fail_message ( int code ); 00057 00058 // <BJS> 25-Jul-2005 00059 // Register a given error code as signifying out of memory of some sort. 00060 extern SYSSEXPORT void ERROR_register_out_of_memory_code(int code); 00061 00062 // <BJS> 25-Jul-2005 00063 // Test if a given error code is some sort of out of memory code 00064 extern SYSSEXPORT logical ERROR_is_out_of_memory_code(int code); 00065 00066 /* <JLM> 18-Nov-98 Add the ubiquitous ERROR_OK */ 00067 00068 #define ERROR_OK 0 00069 00070 #undef EXPORTLIBRARY 00071 00072 #endif /* ERROR_DECODE_H_INCLUDED */