error_print_format()

ERROR_$PRINT_FORMAT               Domain/OS                ERROR_$PRINT_FORMAT


NAME
     error_$print_format - print an error message in standard format

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

     void error_$print_format(
          status_$t &status,
          stream_$id_t &stream_id,
          char &prefix_char,
          error_$string_t command_name,
          short &name_length,
          error_$string_t control_string,
          ...)

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

     procedure error_$print_format(
          in status: univ status_$t;
          in stream_id: stream_$id_t;
          in prefix_char: char;
          in command_name: univ error_$string_t;
          in name_length: integer;
          in control_string: univ error_$string_t;
          in a1,a2,a3,a4,a5,a6,a7,a8,a9,a10: univ error_$integer32);

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

           integer*2 nchar
           parameter (nchar = 128)

           integer*4 status
           integer*2 stream_id, name_length
           character prefix_char*1, command_name*80, control_string*(nchar)

           integer*4 a1, a2, a3, a4, a5, a6, a7, a8, a9, a10

           call error_$print_format(status, stream_id, prefix_char, command_name,
          &                         name_length, control_string, a1, a2, a3, a4,
          &                         a5, a6, a7, a8, a9, a10)

DESCRIPTION
     Error_$print_format prints an error message in the standard format used
     by Domain/OS software followed by the text defined by control_string and
     the rest of the arguments.

     Error_$print_format can take up to 16 arguments, though the first 6, up
     to control_string, are mandatory.

     status
          The completion status from a Domain/OS call.

     stream_id
          The stream on which to write the error output, usually ios_$errout.

     prefix_char
          The prefix character of the error format.  For system messages, this
          value is usually a question mark (?).

     command_name
          A short string to print in the error message, usually the name of
          the program that generated the error.  It can be up to 80 bytes
          long.

     name_length
          The number of bytes in command_name.

     control_string
          A Variable Formatter (VFMT) control string for formatting the rest
          of the arguments.  There must be a format directive in
          control_string for each argument to be printed.

     a1, a2, ..., a10
          Up to 10 arguments to be formatted using control_string.

SEE ALSO
     error_$print, error_$print_name, vfmt_$intro.
Museum
