PAD_$CREATE_FRAME                 Domain/OS                  PAD_$CREATE_FRAME


NAME
     pad_$create_frame - create a frame

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

     void pad_$create_frame(
          ios_$id_t &stream_id,
          short &width,
          short &height,
          status_$t *status)

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

     procedure pad_$create_frame(
          in stream_id: ios_$id_t;
          in width: integer;
          in height: integer;
          out status: status_$t);

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

           integer*4 status
           integer*2 stream_id, width, height

           call pad_$create_frame(stream_id, width, height, status)

DESCRIPTION
     Pad_$create_frame creates a frame on the pad specified by stream_id.
     Because a cursor can roam anywhere within a frame, create frames to allow
     more control over the cursor position in some area of the screen.  A pro-
     gram must either close the frame with pad_$close_frame or delete the
     frame with pad_$delete_frame before exiting.

     stream_id
          The stream ID of the pad to create the frame on.

     width
          The width of the new frame in raster units.  The width of the frame
          on the display is width multiplied by the current scale factors.

     height
          The height of the new frame in raster units.  The height of the
          frame on the display is height multiplied by the current scale fac-
          tors.

     status
          The completion status.

SEE ALSO
     pad_$create, pad_$create_icon, pad_$create_window, pad_$set_scale.