graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQFCH - Inquire Font Characteristics

GPQFCH (csid, font, errind, proportional, top, bottom, nomaspect)

Note:

This subroutine is a graPHIGS API State List (PSL) inquiry. For an overview, see "PSL Inquiries"

Purpose

Use GPQFCH to inquire the font characteristics for the requested character set and font.

The graPHIGS API returns data indicating the top and bottom of the character cell offset from the cap line respectively, the nominal aspect ratio relative to the character's height, and if the font is fixed or proportionally sized. For more information, see The graPHIGS Programming Interface: Understanding Concepts

If the inquired information is available, the error indicator is returned as zero, and the value is returned in the output parameter. If the inquired information is unavailable, the error indicator contains an error number indicating the reason, and the value returned in the output parameter is unpredictable.

Annotation text capabilities are defined in terms of the following character box description:

 
 
      <----- width ------->  
      
      ---------------------- <---top line
      |                    |
      |                    |          
      | - - - - - - - - - -| <---cap line
      |                    |   ^  
      |                    |   | height
      |                    |   |
      |                    |   | 
      |                    |   v
      |- - - - - - - - - - | <---base line
      |                    |
      |                    |
      ---------------------- <---bottom line

Height is defined as the distance between the base line and the cap line.

Note:

The definition of height is different from that used by the Inquire Annotation Font Characteristics (GPQAFC) subroutine.

Parameters

csid -- specified by user, fullword integer

Character set identifier.

See Appendix A. "Character Set and Font Identifiers" for more information.

font -- specified by user, fullword integer

Font identifier (>=1)

errind -- returned by the graPHIGS API, fullword integer

Error indicator. If the error indicator is zero, the request has been completed. Otherwise, one of the following errors exists:

75: TEXT FONT VALUE IS INVALID
542: CHARACTER SET IDENTIFIER IS INVALID
560: CHARACTER SET/FONT COMBINATION IS NOT AVAILABLE

proportional -- returned by the graPHIGS API, fullword integer

Font is defined as fixed or proportionally sized (1=FIXED, 2=PROPORTIONAL )

top -- returned by the graPHIGS API, short floating-point number

Top offset from the cap line in the character cell specified as a fraction of the character's height.

bottom -- returned by the graPHIGS API, short floating-point number

Bottom offset from the base line in the character cell specified as a fraction of the character's height.

nomaspect -- returned by the graPHIGS API, short floating-point number

The font nominal aspect ratio.

This is the nominal width to height ratio.

Error Codes

None

Related Subroutines

None

RCP code

201336331 (X'0C00260B')