pad_inq_icon()

PAD_$INQ_ICON                     Domain/OS                      PAD_$INQ_ICON


NAME
     pad_$inq_icon - get icon information

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

     void pad_$inq_icon(
          ios_$id_t &stream_id,
          short &window_no,
          pad_$position_t *icon_pos,
          char *icon_char,
          status_$t *status)

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

     procedure pad_$inq_icon(
          in stream_id: ios_$id_t;
          in window_no: integer;
          out icon_pos: pad_$position_t;
          out icon_char: char;
          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, icon_pos(2), x_coord, y_coord
           character icon_char*1

           equivalence (icon_pos(1), x_coord), (icon_pos(2), y_coord)

           call pad_$inq_icon(stream_id, window_no, icon_pos,
          &                   icon_char, status)


DESCRIPTION
     Pad_$inq_icon reports the icon position and icon character defined for a
     window.

     stream_id
          The stream ID for the pad the icon window is open on.

     window_no
          The number of the window whose icon is being 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 win-
          dow created to view the pad.

     icon_pos
          The icon position, in pad_$position_t format, defined for the window
          described by stream_id and window_no.

     icon_char
          The icon character defined for the window described by stream_id and
          window_no.

     status
          The completion status.

SEE ALSO
     pad_$icon_wait, pad_$inq_icon_font, pad_$is_icon, pad_$make_icon,
     pad_$set_icon_pos.
Museum
