PAD_$INQ_VIEW                     Domain/OS                      PAD_$INQ_VIEW


NAME
     pad_$inq_view - find out the pad region under the window

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

     void pad_$inq_view(
          ios_$id_t &stream_id,
          short &window_no,
          long *line,
          long *eof_linenum,
          short *x_offset,
          short *y_offset,
          status_$t *status)

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

     procedure pad_$inq_view(
          in stream_id: ios_$id_t;
          in window_no: integer;
          out line: integer32;
          out eof_linenum: integer32;
          out x_offset: integer;
          out y_offset: integer;
          out status: status_$t);

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

           integer*4 status, length, line, eof_linenum
           integer*2 stream_id, window_no, x_offset, y_offset

           call pad_$inq_view(stream_id, window_no, line, eof_linenum,
          &                   x_offset, y_offset, status)

DESCRIPTION
     Pad_$inq_view reports the region of the pad specified by stream_id under
     the window specified by window_no.  Use this routine in conjunction with
     pad_$set_view to control the display of a pad that is larger than a win-
     dow viewing it.

     If the pad region currently in view is a frame, x_offset and y_offset
     describe how the window is positioned relative to the frame.  If the win-
     dow is viewing the current frame, and not some previous part of the pad,
     eof_linenum will be equal to line.

     If the pad region currently in view is not a frame, line is the number of
     the top line in the window.

     stream_id
          The stream ID of the pad in view.

     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.

     line The number of the line at the top of the window.

     eof_linenum
          The number of the last line of the pad viewed, or, equivalently, the
          number of lines in the pad.

     x_offset
          The distance the pad is horizontally scrolled.

     y_offset
          The distance the pad is vertically scrolled.  Only frames can be
          vertically scrolled.

     status
          The completion status.

SEE ALSO
     pad_$inq_position, pad_$set_scale.