pad_make_icon()

PAD_$MAKE_ICON                    Domain/OS                     PAD_$MAKE_ICON


NAME
     pad_$make_icon - change a window into an icon

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

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

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

     procedure pad_$make_icon(
          in stream_id: ios_$id_t;
          in window_no: integer;
          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
           character icon_char*1

           call pad_$make_icon(stream_id, window_no, icon_char, status)

DESCRIPTION
     Pad_$make_icon changes an existing full-size window into an icon.  If the
     window is invisible at the time of the call, it first becomes visible and
     then becomes an icon.  To create a new pad and window in icon format, use
     pad_$create_icon.

     If the window is already an icon, this call has no effect.

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

     window_no
          The number of the window to change into an icon.  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.

     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 (zero) in icon_char, causes the Display Manager to select
          the default icon character for the pad type.

     status
          The completion status.

NOTES
     Specify the display position for the new icon using pad_$set_icon_pos
     before calling pad_$make_icon.  If no position has been defined when
     pad_$make_icon is called, the Display Manager assigns a default position
     and icon character.  The size of the icon window is not defined with
     pad_$make_icon; it is determined by the size of the font character speci-
     fied.

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