pad_inq_full_window()

PAD_$INQ_FULL_WINDOW              Domain/OS               PAD_$INQ_FULL_WINDOW


NAME
     pad_$inq_full_window - get the total display region occupied by a window

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

     void pad_$inq_full_window(
          ios_$id_t &stream_id,
          short &window_no,
          pad_$window_desc_t *window,
          status_$t *status)

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

     procedure pad_$inq_full_window(
          in stream_id: ios_$id_t;
          in window_no: integer;
          out window: pad_$window_desc_t;
          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, window_no, window(4)
           integer*2 top, left, width, height

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

           call pad_$inq_full_window(stream_id, window_no, window, status)

DESCRIPTION
     Pad_$inq_full_window reports the display region occupied by an entire
     window.  The display region returned in window includes the window border
     and legend.  Pad_$inq_windows returns similar information about the
     usable part of displayed windows, not including the border and legend.
     Note that if the specified stream_id and window_no refer to a window
     pane, the information returned is for the window containing the pane.

     stream_id
          The stream ID of the pad under the window inquired about.

     window_no
          The number of the window inquired about.  Window_no is an index into
          the window list returned by pad_$inq_windows.  A window_no of 1
          always refers to the first window created to view the pad.

     window
          The region of the screen, in pad_$window_desc_t format, occupied by
          the entire window, including borders and legend.

     status
          The completion status.

SEE ALSO
     pad_$create, pad_$create_icon, pad_$create_window, pad_$set_border,
     pad_$set_full_window.
Museum
