pad_create_icon()

PAD_$CREATE_ICON                  Domain/OS                   PAD_$CREATE_ICON


NAME
     pad_$create_icon - create a new pad and associated window icon

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

     void pad_$create_icon(
          char *pathname,
          unsigned short &name_length,
          pad_$type_t &type,
          short &unit,
          pad_$position_t &icon_pos,
          char &icon_char,
          pad_$window_desc_t *window,
          ios_$id_t *stream_id,
          status_$t *status);


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

     procedure pad_$create_icon(
          in pathname: univ name_$long_pname_t;
          in name_length: pinteger;
          in type: pad_$type_t;
          in unit: integer;
          in icon_pos: pad_$position_t;
          in icon_char: char;
          in window: pad_$window_desc_t;
          out stream_id: ios_$id_t;
          out status: status_$t);

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

           integer*4 status
           integer*2 name_length, type, unit, icon_pos(2)
           integer*2 x_icon, y_icon, window(4), top, left
           integer*2 width, height, stream_id

           character pathname*1023, icon_char*1

           equivalence (top, window(1)), (left, window(2))
           equivalence (width, window(3)), (height, window(4))
           equivalence (x_icon, icon_pos(1)), (y_icon, icon_pos(2))

           call pad_$create_icon(pathname, name_length, type,
          &                      unit, icon_pos, icon_char,
          &                      window, stream_id, status)

DESCRIPTION
     Pad_$create_icon creates a new pad and window in icon format.  Use
     pad_$select_window to change a window from icon format to a full-size
     window.  Use pad_$make_icon to change an existing window into icon for-
     mat.

     pathname
          The name of the file that the created pad is opened to.  If the file
          exists, the created window views the beginning of the file (BOF).
          If the file does not exist, then it is created.  A null pathname
          creates a temporary file that disappears when the pad is closed.
          Transcript pads are usually created with null pathnames, and input
          pads must always be created with null pathnames.

     name_length
          The number of bytes in pathname.  A null pathname has zero length.

     pad_type
          The type of pad to create.  Specify one of the following:

          pad_$edit
               Create an edit pad for viewing and editing the file.

          pad_$input
               Create an input pad for an existing transcript pad.  The path-
               name argument must be null to create an input pad.

          pad_$read_edit
               Create an edit pad for viewing but not modifying the file.

          pad_$transcript
               Create a transcript pad.  A null pathname is usually used with
               this option.

     unit The display unit number associated with the stream ID.  If there is
          only one display per node, then unit is usually 1.

     icon_pos
          The coordinates of the upper left corner of the icon window.

     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.

     window
          The region of the screen that the new window will occupy when
          expanded to full size.  The icon window size is fixed by the font
          character selected.

          Window specifies the usable area of the window.  The displayed win-
          dow is larger by the size of the border and the legend.  A width or
          height of 0 creates a window in the next Display Manager default
          window region.

     stream_id
          The stream ID for the new pad.

     status
          The completion status.

SEE ALSO
     pad_$create, pad_$create_frame, pad_$create_window, pad_$set_scale.
Museum
