Museum

GMF_$OPEN                         Domain/OS                          GMF_$OPEN


NAME
     gmf_$open - open a GMF

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

     void gmf_$open(
          char *path_name,
          short &name_length,
          gmf_$opos_t &option,
          ios_$id_t *stream_id,
          status_$t *status)

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

     procedure gmf_$open(
          in path_name: univ name_$long_pname_t;
          in name_length: integer;
          in option: gmf_$opos_t;
          out stream_id: ios_$id_t;
          out status: status_$t);

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

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

           call gmf_$open(path_name, name_length, option, stream_id, status)

DESCRIPTION
     Gmf_$open opens a GMF at path_name and supplies a stream ID for it in
     stream_id.  If path_name doesn't exist already, gmf_$open creates a GMF
     and opens it.

     path_name
          A pathname.

     name_length
          The number of bytes in path_name.

     option
          An option for modifying the result of gmf_$open.  Choose one of the
          following:

          gmf_$overwrite
               Open the file for writing and truncate if it exists.  The file
               pointer is initialized to the beginning of the file (BOF), and
               the contents of the file are lost.

          gmf_$append
               Open the file for writing and initialize the file pointer to
               the end of the file (EOF).  Use this to append image date to an
               existing GMF.

          gmf_$read
               Open the file for reading only, and initialize the file pointer
               to the beginning of the file (BOF).

     stream_id
          A stream ID for the opened GMF.

     status
          The completion status.