PBUFS_$CREATE                     Domain/OS                      PBUFS_$CREATE


NAME
     pbufs_$create - create a paste buffer

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

     void pbufs_$create(
          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_$create(
          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_$create(buffer_name, buffer_type, stream_id, status)

DESCRIPTION
     Pbufs_$create creates a paste buffer with the name buffer_name and the
     type specified by buffer_type and supplies a stream ID for it in
     stream_id.  If a paste buffer named buffer_name exists, pbufs_$create
     truncates and opens it; any previous contents of the buffer are lost.

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

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

     stream_id
          The stream ID that buffer_name is open on.

     status
          The completion status.

SEE ALSO
     ios_$create.