pad_inq_windows()

PAD_$INQ_WINDOWS                  Domain/OS                   PAD_$INQ_WINDOWS


NAME
     pad_$inq_windows - list the windows on a pad

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

     void pad_$inq_windows(
          ios_$id_t &stream_id,
          pad_$window_desc_t *windowlist,
          short &window_list_size,
          short *window_no,
          status_$t *status)

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

     procedure pad_$inq_windows(
          in stream_id: ios_$id_t;
          out windowlist: univ pad_$window_list_t;
          in window_list_size: integer;
          out window_no: integer;
          out status: status_$t);

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

           integer*2 max_window_list, desired_window
           parameter (max_window_list = 10, desired_window = 3)

           integer*4 status, window_list(2 * max_window_list)
           integer*2 stream_id, window_list_size, window_no
           integer*2 window_desc(4), top, left, width, height

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

           equivalence (window_desc(1),
          &             window_list(1 + (2 * (desired_window - 1))))

           call pad_$inq_windows(stream_id, window_list, window_list_size,
          &                      window_no, status)

DESCRIPTION
     Pad_$inq_windows reports on up to window_list_size of the windows open on
     the pad open on stream_id.  The report consists of an array of window
     region descriptions in pad_$window_desc_t format.

     stream_id
          The ID of the stream the pad is open on.

     window_list_size
          The maximum number of windows on which information is desired.

     windowlist
          An array of up to window_list_size window region descriptions.  Each
          element of the array is a window region description in
          pad_$window_desc_t format.

     window_no
          The number of windows viewing the pad.  If window_no exceeds
          window_list_size, then pad_$inq_windows did not return descriptions
          of all of the windows open on the pad.

     status
          The completion status.

SEE ALSO
     pad_$inq_full_window, pad_$inq_view, pad_$select_window,
     pad_$set_full_window.
Museum
