graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQFAR - Inquire Font Aspect Ratios

GPQFAR (csid, font, slength, string, errind, aspect-ratio-list)

Note:

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

Purpose

Use GPQFAR to inquire the font aspect ratios for the characters in a specified character string using the specified character set and font.

The list of returned ratios corresponds to the specified character set and font. Aspect ratios are specified as the ratio of the font's nominal width relative to the font's nominal height. The user requests the character set and font. The ratios are workstation independent.

If the inquired information is available, the error indicator is returned as zero, and the values are 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.

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)

slength -- specified by user, fullword integer

Length of the specified text string in bytes (>=0)

string -- specified by user, variable length character string

Character string for which aspect ratios are requested.

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
108: NUMBER OF CHARACTERS IN TEXT STRING < ZERO
542: CHARACTER SET IDENTIFIER IS INVALID
560: CHARACTER SET/FONT COMBINATION IS NOT AVAILABLE
564: TEXT STRING CONTAINS AN UNSUPPORTED CHARACTER CODE

aspect-ratio-list -- returned by the graPHIGS API, array of short floating-point numbers

List of corresponding aspect ratios of the requested text string for the specified character set and font. The array must be large enough to hold the required data.

Error Codes

None

Related Subroutines

None

RCP code

201336330 (X'0C00260A')