pad_inq_font()

PAD_$INQ_FONT                     Domain/OS                      PAD_$INQ_FONT


NAME
     pad_$inq_font - find out about the current font

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

     void pad_$inq_font(
          ios_$id_t &stream_id,
          short *font_width,
          short *font_height,
          char *font_name,
          short &font_buf_len,
          short *font_len,
          status_$t *status)

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

     procedure pad_$inq_font(
          in stream_id: ios_$id_t;
          out font_width: integer;
          out font_height: integer;
          out font_name: univ name_$long_pname_t;
          in font_buf_len: integer;
          out font_len: integer;
          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, font_width, font_height
           integer*2 font_len, font_buf_len
           character font_name*1023

           call pad_$inq_font(stream_id, font_width, font_height,
          &                   font_name, font_buf_len, font_len, status)

DESCRIPTION
     A process can call pad_$inq_font to determine which font is being used in
     the pad specified by stream_id.  The font_height and font_width arguments
     supplied by pad_$inq_font are also the default scale factors for the pad.

     A program can load up to 100 different fonts with pad_$load_font.  Call
     pad_$use_font to use a loaded font.

     stream_id
          The stream ID of the pad inquired about.

     font_buf_len
          The number of bytes available in the font_name string buffer.
          Pad_$inq_font fills the buffer with up to font_buf_len characters.
          If a pathname is not needed, specify a font_buf_len of 0.

     font_width
          The width of the font's space character in raster units.

     font_height
          The height of the font in raster units.  The font height is the
          interline spacing specified in the font file.

     font_name
          The full pathname of the font file up to the node entry directory
          (/).  If the number of bytes in font_name exceeds font_buf_len, the
          Display Manager truncates the returned pathname.

     font_len
          The number of bytes in font_name.  If this value is greater than
          font_buf_len, the Display Manager truncates the returned pathname.

     status
          The completion status.

SEE ALSO
     pad_$inq_icon_font, pad_$set_icon_font, pad_$set_scale.
Museum
