error_find_text()

ERROR_$FIND_TEXT                  Domain/OS                   ERROR_$FIND_TEXT


NAME
     error_$find_text - find error reporting text

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

     void error_$find_text(
          status_$t &status,
          error_$string_t *subsys_p,
          short *subsys_l,
          error_$string_t *module_p,
          short *module_l,
          error_$string_t *code_p,
          short *code_l)

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

     procedure error_$find_text(
          in status: status_$t;
          out subsys_p: univ_ptr;
          out subsys_l: integer;
          out module_p: univ_ptr;
          out module_l: integer;
          out code_p: univ_ptr;
          out code_l: integer);

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

           integer*4 status
           integer*2 subsys_l, module_l, code_l
           character subsys_text*80, module_text*80, code_text*80

           integer*4 subsys_p, module_p, code_p
           pointer /subsys_p/ subsys_text
           pointer /module_p/ module_text
           pointer /code_p/ code_text

           call error_$find_text(status, subsys_p, subsys_l, module_p,
          &                      module_l, code_p, code_l)

DESCRIPTION
     Error_$find_text supplies pointers to predefined strings for reporting
     the completion status of a Domain/OS call.  The strings pointed to are up
     to 80 bytes long and not null terminated.  A program should check the
     length arguments (subsys_l, module_l, and code_l) before dereferencing
     the pointers supplied by error_$find_text.

     status
          The completion status from a Domain/OS call.

     subsys_p
          A pointer to the name of the subsystem associated with the subsys
          field in status.

     subsys_l
          The number of bytes that subsys_p points to.  A subsys_l of 0 indi-
          cates that the completion status passed in status is invalid, and
          subsys_p, module_p, and code_p will not point to any useful informa-
          tion.

     module_p
          A pointer to the name of the module associated with the modc field
          in status.

     module_l
          The number of bytes that module_p points to.  A module_l of 0 indi-
          cates that the modc and code fields of the completion status passed
          in status are invalid, and module_p and code_p will not point to any
          useful information.

     code_p
          A pointer to the diagnostic text associated with the code field in
          status.

     code_l
          The number of bytes that code_p points to.  A code_l of 0 indicates
          that the code field of the completion status passed in status is
          invalid, and code_p will not point to any useful information.

NOTES
     The pointer extension to standard FORTRAN makes it possible to call
     error_$find_text from FORTRAN programs, but error_$get_text is generally
     more convenient.

SEE ALSO
     error_$get_text, status_$intro.
Museum
