Museum

IOS_DIR_$OPEN                     Domain/OS                      IOS_DIR_$OPEN


NAME
     ios_dir_$open - open an object in an open directory

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

     ios_$id_t ios_dir_$open(
         ios_$id_t &dir_id,
         name_$long_pname_t leaf_name,
         short &leaf_namelen,
         ios_$open_options_t &open_options,
         status_$t *status)

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

     function ios_dir_$open(
          in dir_id: ios_$id_t;
          in leaf_name: univ name_$long_pname_t;
          in leaf_namelen: 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, dir_id, leaf_namelen, open_options
           integer*4 status
           character leaf_name*1023

           stream_id = ios_dir_$open(dir_id, leaf_name, leaf_namelen,
          &                          open_options, status)

DESCRIPTION
     Ios_dir_$open opens the object named leaf_name in the directory open on
     dir_id, and returns an ID for the stream.

     dir_id
          The ID for a stream open on the directory that contains the object
          to open.

     leaf_name
          The leaf name of the object to open.  Leaf_name must be a leaf name
          actually cataloged in the directory open on dir_id, not just a path-
          name relative to the open directory.

     leaf_namelen
          The number of bytes in leaf_name.

     open_options
          A small set of options to use when opening the object.  Choose a
          combination of the following values:

          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.