GSTXR

GDDM-GKS V1R1 Programming Guide and Reference

GSTXR

GDDM-GKS V1R1 Programming Guide and Reference
SC33-0334-00

Purpose


GSTXR	(wkid, txi, font, prec, chxp, chsp, coli)

APL code	1346
GKS RCP code	X'38002D00' (939535616)

Function: To set text representation.

Attribute function. Creates a bundle of text attribute values and associates them with a text index at a workstation.

Parameters

wkid (specified by user) (fullword integer)
The workstation identifier.

txi (specified by user) (fullword integer)
The text index. This identifies a bundle of text attributes that are specified in the other parameters of this function.

font (specified by user) (fullword integer)
Text font. This value selects a particular font at the workstation. It can be either a negative value, indicating an implementation-dependent font, or 1, the default font. A particular text font can be available at some, but not necessarily all, precisions.

prec (specified by user) (fullword integer)
The precision of the font. The possible values are:

0 (GSTRP): String precision
1 (GCHARP): Character precision
2 (GSTRKP): Stroke precision.

The text precision value determines the fidelity with which the other text aspects are used.

chxp (specified by user) (short floating point)
The character expansion factor. This specifies the deviation of the width-to-height ratio of the characters from that of the original font.

chsp (specified by user) (short floating point)
The character spacing. This specifies how much additional space is to be inserted between two adjacent character bodies. Character spacing is specified as a fraction of the nominal character height.

coli (specified by user) (fullword integer)
The text color index.

Operating states

WSOP, WSAC, SGOP

Related functions

Text (GTXS), Inquire text representation (GQTXR), Set text index (GSTXI), Set text font and precision (GSTXFP), Inquire text facilities (GQTXF)

Description

This function creates a bundle of attribute values and associates them with text index txi at workstation wkid. The bundle is stored in the text bundle table of the workstation.

The text bundle table in the workstation state list has predefined entries taken from the workstation description table when the workstation is opened. Several bundles are predefined for every output and output/input workstation. Any table entry (including the predefined entries) may be redefined using this function.

When a text output primitive is displayed, the current text index refers to an entry in the text bundle table. If text is displayed with a text index that is not present in the text bundle table, text index 1 is used. Which of the attributes in the bundle table entry are used depends on the setting of the following text attribute aspect source flags:

Character expansion factor ASF
Character spacing ASF
Text color index ASF
Text font and precision ASF

If a text representation is set by this function, the changes may affect the displayed primitives by causing an implicit regeneration of the display, depending on the workstation implicit regeneration mode.

See the Set text font and precision (GSTXFP) function for details of the available text fonts and precisions.

Principal errors

7: GKS not in proper state: GKS shall be in one of the states WSOP, WSAC, or SGOP
20: Specified workstation identifier is invalid
25: Specified workstation is not open
33: Specified workstation is of category MI
35: Specified workstation is of category INPUT
36: Specified workstation is Workstation Independent Segment Storage
72: Text index is invalid
75: Text font is equal to zero
76: Requested text font is not supported for the specified precision on this workstation
77: Character expansion factor is less than or equal to zero
93: Color index is invalid
2000: Enumeration type out of range

Notices | Terms of use | Support | Contact z/OS