ios_close() — Apollo

IOS_$CLOSE                        Domain/OS                         IOS_$CLOSE


NAME
     ios_$close - close a stream

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

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

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

     procedure ios_$close(
          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_$close(stream_id, status)

DESCRIPTION
     Ios_$close closes the stream specified by stream_id, so you can no longer
     use the stream ID to operate on the object.  Closing a stream to an
     object releases any locks maintained by the stream connection, thus mak-
     ing the object available to other users.

     If an object has the delete-on-close attribute (ios_$of_delete_on_close),
     then ios_$close deletes the object after closing the last stream open to
     the object.

     stream_id
          The ID of the stream to be closed.

          Once ios_$close closes the stream, this stream ID  becomes available
          for reuse.  If the object is open on more than one stream,
          ios_$close closes only the stream specified.  Other streams open on
          the object are not affected.

     status
          The completion status.
Museum
