Museum

IOS_$INQ_OBJ_FLAGS                Domain/OS                 IOS_$INQ_OBJ_FLAGS


NAME
     ios_$inq_obj_flags - return object attributes

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

     ios_$obj_flag_set ios_$inq_obj_flags(
          ios_$id_t &stream_id,
          status_$t *status)

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

     function ios_$inq_obj_flags(
          in stream_id: ios_$id_t;
          out status: status_$t): ios_$obj_flag_set;

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

           integer*2 stream_id
           integer*4 obj_flags, status

           obj_flags = ios_$inq_obj_flags(stream_id, status)

DESCRIPTION
     Ios_$inq_obj_flags returns the set of attributes for the object open on
     stream_id.  The value returned by ios_$inq_obj_flags is a Pascal set with
     the following elements:

          ios_$of_ascii
               The object contains ASCII data.

          ios_$of_async
               Process groups holding valid file descriptors for the object
               will be asynchronously notified via a SysV or BSD SIGIO signal
               (an Aegis unix_sig_$io_f fault) when nonblocking I/O (usually
               input from the object) is possible.

          ios_$of_cond
               Input and output to the object will be performed conditionally,
               as if the ios_$cond_opt was specified on each I/O call.

          ios_$of_delete_on_close
               The object will be deleted when all streams open on it close.

          ios_$of_ftncc
               The object uses FORTRAN carriage control characters.

          ios_$of_mand_lock
               The object will be locked during I/O operations.

          ios_$of_sparse_ok
               The object can be sparse.  A process can seek beyond the end of
               the object before writing to it.

     Domain/OS provides the following logical masks for analyzing the value
     returned by ios_$inq_obj_flags in FORTRAN and C.  The returned value is a
     bitwise OR of the following masks:

          ios_$of_ascii_mask
               The object contains ASCII data

          ios_$of_async_mask
               Process groups holding valid file descriptors for the object
               will be asynchronously notified via a SysV or BSD SIGIO signal
               (an Aegis unix_sig_$io_f fault) when nonblocking I/O (usually
               input from the object) is possible.

          ios_$of_cond_mask
               Input and output to the object will be performed conditionally,
               as if the ios_$cond_opt_mask was specified on each I/O call.

          ios_$of_delete_on_close_mask
               The object will be deleted when all streams open on it close.

          ios_$of_ftncc_mask
               The object uses FORTRAN carriage control characters.

          ios_$of_mand_lock_mask
               The object will be locked during I/O operations.

          ios_$of_sparse_ok_mask
               The object can be sparse.  A process can seek beyond the end of
               the object before writing to it.

     stream_id
          The ID of a stream on which the object is open.

     status
          The completion status.

NOTES
     A program can use ios_$set_obj_flags to change object attributes.

SEE ALSO
     ios_$inq_conn_flags, ios_$inq_file_attr, ios_$inq_mgr_flags.