[ Previous |
Next |
Contents |
Glossary |
Home |
Search ]
The graPHIGS Programming Interface : Subroutine Reference
GPQTR - Inquire Text Representation
GPQTR
(wsid,
index,
type,
errind,
font,
prec,
factor,
space,
color) |
Purpose
Use
GPQTR
to inquire the current text attributes contained in the
specified entry in the text bundle table of the specified workstation.
The graPHIGS API returns data indicating the text font
and precision, character
expansion factor and spacing, and text color of the specified entry.
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 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.
index -- specified by user, fullword integer
Text bundle table index (>=1)
type -- specified by user, fullword integer
Type of returned values
(1=SET
)
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
- 43
- BUNDLE INDEX EXCEEDS WORKSTATION TABLE CAPACITY
- 60
- BUNDLE INDEX VALUE < ONE
- 526
- REQUESTED DATA NOT AVAILABLE FOR THIS FUNCTION
- 534
- TYPE VALUE IS INVALID
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 is specified as the deviation
from the nominal width-to-height ratio for the font.
space -- returned by the graPHIGS API, short floating-point number
Character spacing corresponding to the specified entry 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.
Note:
Direct text color returns error indicator
526
Error Codes
None
Related Subroutines
- GPQXTR
- Inquire Extended Text Representation
RCP code
201339143
(X'0C003107')
[ Previous |
Next |
Contents |
Glossary |
Home |
Search ]