error_init_std_format()

ERROR_$INIT_STD_FORMAT            Domain/OS             ERROR_$INIT_STD_FORMAT


NAME
     error_$init_std_format - initialize standard error reporting

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

     void error_$init_std_format(
          stream_$id_t &stream_id,
          char &prefix_char,
          error_$string_t command_name,
          short &command_length)

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

     procedure error_$init_std_format(
          in stream_id: stream_$id_t;
          in prefix_char: char;
          in command_name: univ error_$string_t;
          in command_length: integer);

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

           integer*2 stream_id, command_length
           character prefix_char*1, command_name*80

           call error_$init_std_format(stream_id, prefix_char,
          &                            command_name, command_length)

DESCRIPTION
     Error_$init_std_format establishes a reporting stream and text fields for
     use in standard error messages.  Subsequent calls to error_$std_format
     use the values supplied with error_$init_std_format.

     The stream ID, prefix character, and command name are used in calls to
     error_$std_format from the program level that called
     error_$init_std_format, or higher program levels, until the process calls
     error_$init_std_format again.

     The standard format for error messages produced by Aegis software is
     prefix_char(command_name) FILE_NAME - STATUS MESSAGE (MODULE / SUBSYSTEM)

     stream_id
          The ID of the stream for error_$std_format to use in writing error
          messages, usually ios_$errout.  Subsequent calls to
          error_$std_format will write to stream_id.

     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 error messages, usually the name of the
          program that generated the error.  It can be up to 80 bytes long.

     command_length
          The number of bytes in command_name.

SEE ALSO
     error_$print_format.
Museum
