Museum

PBUFS_$OPEN                       Domain/OS                        PBUFS_$OPEN


NAME
     pbufs_$open - open an existing paste buffer

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

     void pbufs_$open(
          char *buffer_name,
          boolean &buffer_type,
          ios_$id_t *stream_id,
          status_$t *status)

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

     procedure pbufs_$open(
          in buffer_name: univ name_$long_name_t;
          in buffer_type: boolean;
          out stream_id: ios_$id_t;
          out status: status_$t);

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

           integer*2 stream_id
           integer*4 status
           logical buffer_type
           character buffer_name*255

           call pbufs_$open(buffer_name, buffer_type, stream_id, status)

DESCRIPTION
     Pbufs_$open opens the pre-existing paste buffer named buffer_name with
     the type specified in buffer_type.  Pbufs_$open fails if the specified
     paste buffer does not already exist in /sys/node_data/paste_buffers.

     buffer_name
          The leaf name of a paste buffer in /sys/node_data/paste_buffers.
          The string in buffer_name must end with a blank and cannot contain
          any blanks internally.  The resulting leaf name used to open the
          paste buffer will be the string in buffer_name with the terminating
          blank stripped off.

     buffer_type
          A Boolean value indicating whether buffer_name holds text or graph-
          ics.  Set buffer_type to true if buffer_name holds text.  Set it to
          false if buffer_name holds graphics cut from a graphics metafile.

     stream_id
          The stream ID that buffer_name is open on.

     status
          The completion status.  If the value of buffer_type is not con-
          sistent with the data in buffer_name, pbufs_$open will return with
          pbufs_$wrong_type in status.

SEE ALSO
     ios_$open.