graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQGFC - Inquire Geometric Font Characteristics

GPQGFC (wsid, csid, font, start, num, errind, prec, nhts, lhts, lnfac, lmnfac, lmxfac)

Note:

This subroutine is a Workstation State List (WSL) inquiry. For an overview, see "WSL Inquiries"

Purpose

Use GPQGFC to inquire the geometric text capabilities for the specified character set and font on the specified workstation.

This information consists of the highest text precision for this csid/font that is supported by the specified workstation (prec), the number of supported character heights (nhts), a list of the exact supported character heights (lhts), and the number of character expansion factors (lnfac), minimum expansion factor (lmnfac), and maximum expansion factor (lmxfac) corresponding to each supported character height.

If the inquired information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameters. If the error indicator is 543 (the start value exceeds the extent of the available data), then only the total number (totnum) parameter is set. If the inquired information is unavailable, then the error indicator (errind) contains an error number indicating the reason, and the values returned in the output parameters are unpredictable.

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

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)

start -- specified by user, fullword integer

Starting member of the list of supported heights (>=1)

num -- specified by user, fullword integer

Number of list elements requested (>=0)

Note:

The four output arrays must be large enough to hold the requested number of elements.

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:

25: SPECIFIED WORKSTATION DOES NOT EXIST
35: WORKSTATION HAS ONLY INPUT CAPABILITIES
75: TEXT FONT VALUE IS INVALID
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
542: CHARACTER SET IDENTIFIER IS INVALID
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED
561: CHARACTER SET/FONT COMBINATION IS NOT ACTIVE
563: CHARACTER SET/FONT COMBINATION IS NOT AVAILABLE FOR GEOMETRIC TEXT

prec -- returned by the graPHIGS API, fullword integer

Highest available precision for the corresponding csid/ font (1=STRING_PREC, 2=CHAR_PREC, 3=STROKE_PREC )

Note:

If the highest precision supported is 3=STROKE_PREC , then the parameters that follow refer to the geometric text capabilities in character precision.

nhts -- returned by the graPHIGS API, fullword integer

Total number of available character heights supported for the specified character set and font on the specified workstation.

A value of zero means that a continuous range of heights is supported. The lists describe the minimum and maximum character heights.

lhts -- returned by the graPHIGS API, array of short floating-point numbers (DC)

List of all character heights supported on this workstation for geometric text in Device Coordinates (DC)

For a continuous range of character heights, this list contains the minimum and maximum character heights.

lnfac -- returned by the graPHIGS API, array of fullword integers

List of the total number of available character expansion factors. Each element in the list corresponds to an element in the list of character heights.

A value of zero means that the workstation supports a continuous range of character expansion factors.

lmnfac -- returned by the graPHIGS API, array of short floating-point numbers

List of the minimum character expansion factors supported. There is one list entry for each entry in the list of supported heights.

lmxfac -- returned by the graPHIGS API, array of short floating-point numbers

List of the maximum character expansion factors supported. There is one list entry for each entry in the list of supported heights.

Error Codes

None

Related Subroutines

GPCHH: Set Character Height
GPCHXP: Set Character Expansion Factor
GPQFO: Inquire Active Fonts

RCP code

201336590 (X'0C00270E')