Museum

ERRLOG_$INTRO                     Domain/OS                      ERRLOG_$INTRO


NAME
     intro - Domain/OS error logging

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/errlog.h>

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/errlog.ins.pas';

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/errlog.ins.ftn'

DESCRIPTION
     The errlog_$ calls facilitate the logging of program status by imposing a
     consistent format on error, fault, and traceback information.  They also
     provide routine management of error log files by dropping old entries
     from the log when the log file gets too big.

     The following is a list of the error_$ calls.

          errlog_$close          close an error log
          errlog_$fault_status   log a fault status
          errlog_$open           open an error log file and log an error
          errlog_$traceback      log a stack traceback

     In addition to the fault and traceback information generated by the
     errlog_$fault_status and errlog_$traceback calls, a program can put other
     data in an error log by passing the stream ID returned by error_$open to
     other write calls, such as error_$ or vfmt_$ calls.

   Data Types
     errlog_$option_t
          An enumerated type for modifying error logging behavior.  It takes
          one of the following values:

          errlog_$silent
               Do not alert user to error logging.

          errlog_$no_header
               Do not write a standard entry header.

          errlog_$no_divert
               Do not divert log entries to ios_$stderr if the log file cannot
               be opened.

     errlog_$option_set_t
          A small set of type errlog_$option_t used to pass options to
          errlog_$open.  I takes a combination of the following values:

          errlog_$silent
               Do not alert user to error logging.

          errlog_$no_header
               Do not write a standard entry header.

          errlog_$no_divert
               Do not divert log entries to ios_$stderr if the log file cannot
               be opened.

     errlog_$tb_opt_t
          An enumerated type for modifying how a traceback is logged.  There
          is currently only one possible value:

          errlog_$fault_tb
               Start the traceback at the last fault that occurred in the cal-
               ling process.  This option is most useful within a fault
               handler.

     errlog_$tb_opt_set_t
          A small set of type errlog_$tb_opt_t used to pass options to
          errlog_$traceback.  There is currently only one possible value:

          errlog_$fault_tb
               Start the traceback at the last fault that occurred in the cal-
               ling process.  This option is most useful within a fault
               handler.