ios_force_write_file()

IOS_$FORCE_WRITE_FILE             Domain/OS              IOS_$FORCE_WRITE_FILE


NAME
     ios_$force_write_file - save an object to permanent storage

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

     void ios_$force_write_file(
          ios_$id_t &stream_id,
          status_$t *status)

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

     procedure ios_$force_write_file(
          in stream_id: ios_$id_t;
          out status: status_$t);

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

           integer*2 stream_id
           integer*4 status

           call ios_$force_write_file(stream_id, status)

DESCRIPTION
     After ios_$force_write_file returns, any internally buffered data for the
     object open on stream_id has been flushed to permanent storage.  A suc-
     cessful return means that the object's image in storage reflects the
     state of the object on making the call.

     The system periodically flushes its internal buffers to their file system
     objects unless prevented by a network problem or system crash.  Use
     ios_$force_write_file before closing a stream on an object to ensure that
     it is stored safely in case some problem prevents the system from flush-
     ing its I/O buffers.

     stream_id
          The stream ID on which the object is open.

     status
          The completion status.

NOTES
     Stable storage depends on the object's type; however, in most cases, it
     is a disk.
Museum
