error — Apollo




SYSCALLS/ERROR - error reporting module     81/06/28


Include files:

    Fortran:    /sys/ins/error.ins.ftn
    Pascal:     /sys/ins/error.ins.pas


Procedures and functions:

    code = error_$code (status)
        Returns code field from status.  (Intended for Fortran users.)

    error_$fail (status), fail = ...
        Returns fail bit from status.  (Intended for Fortran users.)

    error_$find_text (status, subsys_p, sybsys_l, module_p, module_l,
                      code_p, code_l)
        Finds text associated with given status code and returns pointers and
        lengths for each component.

    error_$get_text (status, subsys, subsys_l, module, module_l, code, code_l)
        Finds text associated with given status and returns text strings and lengths
        for each component.

    error_$module (status), module = ...
        Returns module field from status.  (Intended for Fortran users.)

    error_$subsys (status), subsys = ...
        Returns the subsystem field of the supplied status.  (Intended for Fortran
        users.)

    error_$print (status)
        Prints the text message associated with the status on error-out.

    error_$print_name (status, name, namelength)
        Prints a name, then the text message associated with the status on error-out.

    error_$print_format (status, stream_id, init_char, cmd_name, cmd_len, cntrl_string,
                         a1, a2, a3, ..., a10)
        Prints an error message in the standard error reporting format. The stream_id
        is usually errout (3), init_char is usually '?'.   If status  or cmd_len are
        zero, those fields are not printed.  cntrl_string is a vfmt-style string used
        to format and print a variable number of arguments (a1..a10).

    error_$init_std_format (stream_id, init_char, cmd_name, cmd_len)
        Initializes data to be used in subsequent error_$std_format calls. Multiple
        calls on the same program level overwrite existing data.

    error_$std_format (status, cntrl_string, a1, a2, a3, ..., a10)
        Prints an error message in the standard error reporting format, using the
        initialized data from error_$init_std_format call.  Use of this call and
        error_$init_std_format is equivalent to using error_$print_format.
Museum
