pad_set_icon_pos()

PAD_$SET_ICON_POS                 Domain/OS                  PAD_$SET_ICON_POS


NAME
     pad_$set_icon_pos - establish an icon position and icon character

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

     void pad_$set_icon_pos(
          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_$set_icon_pos(
          in stream_id: ios_$id_t;
          in window_no: integer;
          in icon_pos: pad_$position_t;
          in 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 (x_coord, icon_pos(1)), (y_coord, icon_pos(2))

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

DESCRIPTION
     Pad_$set_icon_pos establishes an icon position and icon character for the
     window specified by stream_id and window_no.  If the specified window is
     currently an icon, pad_$set_icon_pos will visibly move the icon to the
     new position and change its icon character.  The size of the icon depends
     on the size of the icon character and is not independently definable.

     stream_id
          The stream ID of the pad viewed by the window.

     window_no
          The number of the window.  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.

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

     icon_char
          The icon font character to be display in the window icon.  Icon_char
          must be defined in the current icon font file.  A null icon charac-
          ter, a 0 in icon_char, causes the Display Manager to select the
          default icon character for the pad type.

     status
          The completion status.

SEE ALSO
     pad_$create_icon, pad_$icon_wait, pad_$inq_icon_font, pad_$is_icon,
     pad_$make_icon, pad_$select_window.
Museum
