graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQPTR - Inquire Predefined Text Representation

GPQPTR (wstype, index, errind, font, prec, factor, space, color)

Note:

This subroutine is a Workstation Description Table (WDT) inquiry. For an overview, see "WDT Inquiries"

Purpose

Use GPQPTR to inquire a set of predefined text attributes as set in the text bundle table for the specified workstation type.

The graPHIGS API returns the requested index for text font (font) and precision (prec), character expansion factor (factor), character spacing (space), and text color (color) for the specified entry.

If the information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameter. If the inquired information is unavailable, then the error indicator (errind) contains the error number indicating the reason, and the values returned in the output parameter are unpredictable.

Parameters

wstype -- specified by user, 8-byte character string

Workstation type.

index -- specified by user, fullword integer

Predefined text bundle table index (>=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:

23: SPECIFIED WORKSTATION TYPE DOES NOT EXIST
35: WORKSTATION HAS ONLY INPUT CAPABILITIES
43: BUNDLE INDEX EXCEEDS WORKSTATION TABLE CAPACITY
60: BUNDLE INDEX VALUE < ONE
548: SPECIFIED WORKSTATION TYPE CANNOT BE LOADED

font -- returned by the graPHIGS API, fullword integer

Text font corresponding to the specified entry.

prec -- returned by the graPHIGS API, fullword integer

Text precision corresponding to the specified entry (1=STRING_PREC, 2=CHAR_PREC, 3=STROKE_PREC )

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

Character expansion factor corresponding to the specified entry (the deviation of the width-to-height ratio of the font)

space -- returned by graPHIGS API, short floating-point number

Character spacing corresponding to the specified entry, which is specified as a fraction of the font-nominal character height.

color -- returned by the graPHIGS API, fullword integer

Text color index corresponding to the specified entry.

Error Codes

None

Related Subroutines

GPQRCT: Inquire Realized Connection Type

RCP code

201339911 ( X'0C003407')