error_fail() — Apollo

ERROR_$FAIL                       Domain/OS                        ERROR_$FAIL


NAME
     error_$fail - test the fail bit in a completion status

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

     boolean error_$fail(status_$t &status)

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

     function error_$fail(in status: status_$t): boolean;

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

           logical fail
           integer*4 status

           fail = error_$fail(status)

DESCRIPTION
     Error_$fail returns true if the fail bit is set in status, and returns
     false if the fail bit is not set.

     Error_$fail is provided as an aid to interpreting completion status in C
     and FORTRAN, though it may be called from Pascal as well.  In Pascal with
     status declared as type status_$t, error_$fail(status) just returns
     status.fail.

     status
          The completion status from a Domain/OS call.

SEE ALSO
     status_$intro.
Museum
