pad_is_icon() — Apollo

PAD_$IS_ICON                      Domain/OS                       PAD_$IS_ICON


NAME
     pad_$is_icon - find out whether a window is an icon

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

     boolean pad_$is_icon(
          ios_$id_t &stream_id,
          short &window_no,
          status_$t *status)

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

     function pad_$is_icon(
          in stream_id: ios_$id_t;
          in window_no: integer;
          out status: status_$t): boolean;

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

           integer*4 status
           integer*2 stream_id, window_no
           logical is_icon

           is_icon = pad_$is_icon(stream_id, window_no, status)

DESCRIPTION
     Pad_$is_icon returns true if the window described by stream_id and
     window_no is an icon and false if it is not.

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

     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
          refers to the first window created to view the pad.

     status
          The completion status.

SEE ALSO
     pad_$icon_wait, pad_$inq_icon, pad_$make_icon.
Museum
