graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQXTR - Inquire Extended Text Representation

GPQXTR (wsid, index, type, number, ids, errind, data)

Note:

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

Purpose

Use GPQXTR to inquire the current value of one or more fields in the specified text bundle table entry in the specified workstation's text bundle table.

If the inquired information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameters. The output parameter must be large enough to store all requested data. 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 value ( 1=SET )

number -- specified by user, fullword integer

Number of group identifiers requested (>=1)

ids -- specified by user, array of fullword integers

A list of group identifiers requested.

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
272: GROUP IDENTIFIER IS INVALID
273: NUMBER OF GROUP IDENTIFIERS < ONE
534: TYPE VALUE IS INVALID

data -- returned by the graPHIGS API, variable data

Data array containing the values in the requested groups.

Each field that may be set in the interior bundle table entry is identified by a group identifier. The value that may be set for each field is expressed in the data format listed below:

Group Identifier 1 - Text font

A fullword integer (1-255)

Group Identifier 2 - Text precision

A fullword integer ( 1=STRING_PREC, 2=CHAR_PREC, 3=STROKE_PREC )

Group Identifier 3 - Character expansion factor

A short floating-point value (>=0)

Group Identifier 4 - Character spacing

A short floating-point value.

Group Identifier 5 - Text color

Four fullwords of data with either of the following two formats:

   indexed format                       direct format
    -------------                       -------------
  0 |          1| fullword integer    0 |          2| fullword integer
    |-----------|                       |-----------|
  4 |color index| fullword integer    4 |component 1| short floating-point number
    |-----------|                       |-----------|
  8 |   reserved| fullword integer    8 |component 2| short floating-point number
    |-----------|                       |-----------|
 12 |   reserved| fullword integer   12 |component 3| short floating-point number
    -------------                       -------------

Error Codes

None

Related Subroutines

GPXTXR: Set Extended Text Representation

RCP code

201339158 ( X'0C003116')