GSTXI

GDDM-GKS V1R1 Programming Guide and Reference

GSTXI

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

Purpose


GSTXI	(txi)

APL code	1325
GKS RCP code	X'38001A00' (939530752)

Function: To set text index.

Attribute function. Selects a bundle of text attributes to be used for text output primitives.

Parameters

txi (specified by user) (fullword integer)
The text index.

Operating states

GKOP, WSOP, WSAC, SGOP

Related functions

Set text representation (GSTXR), Inquire text index (GQTXI), Set aspect source flags (GSASF)

Description

The current text entry in the GKS state list is set to the value given by txi. This value is used when creating subsequent text primitives.

The appearance of text primitives, at a workstation, is determined by the text font and precision, character expansion factor, character spacing, and color. Using Set text representation (GSTXR), you can define a number of bundles of values for these four attributes at any workstation. The bundles are stored in the text bundle table of the workstation. The text index is a pointer into the text bundle table at each workstation. When a text primitive is displayed, attributes from the bundle specified by the text index are used according to the corresponding aspect source flag (ASF). You use Set aspect source flags (GSASF) to define whether or not text attributes are to be taken from bundles for the output workstations. If the ASF for an attribute is bundled, the bundled attribute is used. An aspect source flag exists for each of these text attributes:

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

If you do not call this function in your program before calling the Text (GTXS) function, or if the index you request is not defined or is not available on the workstation, text index 1 is used.

Principal errors

8: GKS not in proper state: GKS shall be in one of the states GKOP, WSOP, WSAC, or SGOP
72: Text index is invalid

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