pad_create_window()

PAD_$CREATE_WINDOW                Domain/OS                 PAD_$CREATE_WINDOW


NAME
     pad_$create_window - create a new pad and a window to view it

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

     void pad_$create_window(
          char *pathname,
          unsigned short &name_length,
          pad_$type_t &pad_type,
          short &unit,
          pad_$window_desc_t &window,
          ios_$id_t *stream_id,
          status_$t *status);


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

     procedure pad_$create_window(
          in pathname: univ name_$long_pname_t;
          in name_length: pinteger;
          in pad_type: pad_$type_t;
          in unit: integer;
          in window: pad_$window_desc_t;
          out stream_id: ios_$id_t;
          out status: status_$t);

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

           integer*4 status
           integer*2 name_length, pad_type, unit, window(4)
           integer*2 top, left, width, height, stream_id
           character pathname*1023

           equivalence (top, window(1)), (left, window(2))
           equivalence (width, window(3)), (height, window(4))

           call pad_$create_window(pathname, name_length, pad_type,
          &                        unit, window, stream_id, status)

DESCRIPTION
     Pad_$create_window creates a new pad under a new window.  Use pad_$create
     to create a new pad and window pane in an existing window.

     pathname
          The name of the file that the created pad is opened to.  If the file
          exists, the created window is positioned at the beginning of the
          file.  If the file does not exist, then it is created.  A null path-
          name creates a temporary file that the system deletes when the pad
          is closed.  Transcript pads are usually created with null pathnames,
          and input pads must always be created with null pathnames.

     name_length
          The number of bytes in pathname.  A null pathname has zero length.

     pad_type
          The type of window pane to create.  Specify one of the following:

          pad_$edit
               Create an edit pad for viewing and editing the file.

          pad_$read_edit
               Create an edit pad for viewing but not modifying the file.

          pad_$transcript
               Create a transcript pad.  A null pathname is usually used with
               this option.

     unit The display unit number associated with the stream ID.  If there is
          only one display per node, then unit is usually 1.

     window
          The region of the screen, in pad_$window_desc_t format, that the new
          window will occupy when expanded to full size.  The icon window size
          is fixed by the the font character selected.

          Window specifies the usable area of the window.  The displayed win-
          dow is larger by the size of the border and the legend.  A width or
          height of 0 creates a window in the next Display Manager default
          window region.

     stream_id
          The stream ID for the new pad.

     status
          The completion status.

NOTES
     Do not use pad_$create_window to create an input pad; use pad_$create
     instead.

SEE ALSO
     pad_$create_frame, pad_$create_icon, pad_$set_scale.
Museum
