Museum

IOS_$OPEN                         Domain/OS                          IOS_$OPEN


NAME
     ios_$open - open an existing object

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

     ios_$id_t ios_$open(
          char *path_name,
          short &path_length,
          ios_$open_options_t &open_options,
          status_$t *status)

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

     function ios_$open(
          in path_name: univ name_$long_pname_t;
          in path_length: integer;
          in open_options: ios_$open_options_t;
          out status: status_$t): ios_$id_t;

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

           integer*2 stream_id, name_length, open_options
           integer*4 status
           character path_name*1023

           stream_id = ios_$open(path_name, name_length, open_options, status)

DESCRIPTION
     Ios_$open opens a stream to the object at path_name and returns the
     stream ID.  Ios_$open does not affect an object's attributes.

     path_name
          The name of the object to be opened.  Ios_$open fails if no object
          exists at path_name.

     path_length
          The number of bytes in path_name.

     open_options
          This is a small set of options to use when opening the object.
          Specify a combination of the following:

          ios_$inquire_only_opt
               Open the object for attribute inquiries only.

          ios_$no_open_delay_opt
               Return immediately rather than waiting for the open operation
               to complete.

          ios_$no_open_options
               Open for reading only.  This is the default, which is
               equivalent to specifying no options.

          ios_$no_read_opt
               Do not permit reading the object.

          ios_$position_to_eof_opt
               Move the stream marker to the end of the stream before each put
               call.  This overrides the implicit setting of the stream marker
               in ios_$preserve_mode.

          ios_$read_intend_write_opt
               Open the object for read access, and allow other processes to
               read it but not write to it or get "read with intent to write"
               access.

          ios_$unregulated_opt
               Permit multiple processes to write to the object.

          ios_$write_opt
               Permit writing to the object.

     status
          The completion status.

SEE ALSO
     ios_$create.