isCOBOL Evolve : Appendices : Library Routines : W$FONT : WFONT-DESCRIBE-FONT
WFONT-DESCRIBE-FONT
The WFONT-DESCRIBE-FONT function describes the characteristics of a loaded font.
Syntax:
 CALL "W$FONT" USING WFONT-DESCRIBE-FONT
                     fontHandle
                     WFONT-DATA
              GIVING returnCode
Parameters:
WFONT-DESCRIBE-FONT
Constant
 
fontHandle
USAGE HANDLE OF FONT
It may be set to a valid font handle.
WFONT-DATA
Group Item
Structure that receives the characteristics of the font. This group item, defined in isfonts.def, has the following structure:
 
01  wfont-data.
    03 wfont-face-data.
       05 wfont-device                 handle, value null.
          88 wfdevice-console          value null.
          88 wfdevice-printer          value 1.
       05 wfont-name                   pic x(33).
       05 wfont-char-set               pic x comp-x.
       05 wfont-size                   pic x comp-x.
       05 wfont-bold-state             pic x comp-x.
          88 wfont-bold                value 1, false zero.
       05 wfont-italic-state           pic x comp-x.
          88 wfont-italic              value 1, false zero.
       05 wfont-underline-state        pic x comp-x.
          88 wfont-underline           value 1, false zero.
       05 wfont-strikeout-state        pic x comp-x.
          88 wfont-strikeout           value 1, false zero.
       05 wfont-pitch-state            pic x comp-x.
          88 wfont-fixed-pitch         value 1, false zero.
       05 wfont-family                 pic x comp-x.
    03 wfont-choose-data.
       05 wfont-choose-flags           pic x comp-x.
       05 wfont-choose-min-size        pic x comp-x.
       05 wfont-choose-max-size        pic x comp-x.
       05 wfont-choose-red             pic x comp-x.
       05 wfont-choose-green           pic x comp-x.
       05 wfont-choose-blue            pic x comp-x.
       05 wfont-choose-color-num       pic x comp-x.
    03 wfont-angle                     pic x(2) comp-x.
    03 wfont-scale-x                   float value 0.
    03 wfont-scale-y                   float value 0.
 
Note - members not mentioned below are not used by this function.
 
wfont-device
It is the device the function refers to. The value can be one of the condition names provided.
When wfdevice-console is set to true, the function will describe a font for the current screen configuration.
When wfdevice-printer is set to true, the function will describe a font for the current printer configuration.
 
wfont-name
It is the name of the font.
 
wfont-size
It is the size of the font.
 
 
wfont-bold-state
It is the bold state of the font.
If the font is bold, wfont-bold is set to true.
 
wfont-italic-state
It is the italic state of the font.
If the font is italic, wfont-italic is set to true.
 
wfont-underline-state
It is the underline state of the font.
If the font is underline, wfont-underline is set to true.
 
wfont-strikeout-state
It is the strike-out state of the font.
If the font is stricken out, wfont-strikeout is set to true.
 
wfont-pitch-state
It is the pitch state of the font.
If the font is a fixed-pitch font, wfont-fixed-pitch is set to true.
If the font is a variable-pitch font, wfont-fixed-pitch is set to false.
 
wfont-angle
It is the angle at which the font will print. The value can range from the default of "0", which is the normal horizontal orientation, to "360", which is the same as "0". For example, to print at a 90-degree angle, set WFONT-ANGLE to "90". This feature works only when printing a font, not when displaying a font on screen.
 
wfont-scale-x
It is the scale factor on the X coordinate. A value of 0 or 1 means that no scale is performed. This setting should be used only for print fonts (wfont-device = wfdevice-printer) that are not rotated (wfont-angle = 0), otherwise the effects are unpredictable.
 
wfont-scale-y
It is the scale factor on the Y coordinate. A value of 0 or 1 means that no scale is performed. This setting should be used only for print fonts (wfont-device = wfdevice-printer) that are not rotated (wfont-angle = 0), otherwise the effects are unpredictable
Return code:
returnCode can be any signed numeric data item and provides additional information:
1
Operation successful.
WFONTERR-UNSUPPORTED
The W$FONT library routine is not supported.
WFONTERR-INVALID-HANDLE
fontHandle is not valid.