STATUS_$INTRO Domain/OS STATUS_$INTRO
NAME
intro - status reporting types and constants
SYNOPSIS (C)
#include <apollo/base.h>
SYNOPSIS (Pascal)
%include '/sys/ins/base.ins.pas';
SYNOPSIS (FORTRAN)
%include '/sys/ins/base.ins.ftn'
DESCRIPTION
Most system calls supply their completion status in status_$t format.
The status_$t type and the constant status_$ok are defined to help evalu-
ate the status information supplied by system calls.
Constants
status_$ok
A constant used to check status. If the all instance of a comple-
tion status is equal to status_$ok, then the system call that sup-
plied it was successful.
Data Types
status_$t
This is a variant record type with two instances. One instance has
only one member, named all. The other instance has four members,
named fail, code, modc, and subsys. Variables of the status_$t type
require four bytes of storage.
all All 32 bits in the status code. If all is equal to status_$ok,
the system call that supplied the status was successful.
fail The field labeled "f" in the diagram is the fail bit. If fail
is set, the error was not within the scope of the module
invoked, but occurred within a lower-level module.
subsys
This indicates the subsystem that encountered the error.
modc This indicates the module that encountered the error.
code This is a signed number that identifies the type of error that
occurred.
31 16
______________________________________________________________
| all |
|_____________________________________________________________|
| all |
______________________________________________________________
15 0
OR
31 30 24 23 16
______________________________________________________________
|f | subsys | modc |
|_____________________________________________________________|
| code |
______________________________________________________________
15 0