GQLCS

GDDM-GKS V1R1 Programming Guide and Reference

GQLCS

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

Purpose


GQLCS	(wkid, lcdnr, type, mldr, errind, mode, esw, tnr, ipx, ipy, pet, earea, ldr, datrec)

APL code	1500
GKS RCP code	X'3800BB00' (939571968)

Function: To inquire locator device state.

Inquiry function. Returns the state of a specified locator device, from the workstation state list of a workstation.

Parameters

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

lcdnr (specified by user) (fullword integer)
The locator device number (1 ... n).

type (specified by user) (fullword integer)
The type of returned values. The possible values are:

0 (GSET)

Set

1 (GREALI)

Realized

If type equals set, the attribute values returned in the data record are the same as those originally passed by the Initialize Locator function. If type equals realized, the attribute values returned in the data record are the closest available values at the device.

mldr (specified by user) (fullword integer)
The dimension of the data record array datrec.

errind (returned by GDDM) (fullword integer)
The error indicator.

mode (returned by GDDM) (fullword integer)
The operating mode. The only possible value is:

0 (GREQU): Request

esw (returned by GDDM) (fullword integer)
The echo switch setting. The possible values are:

0 (GNECHO): No echo
1 (GECHO): Echo

tnr (returned by GDDM) (fullword integer)
The initial transformation number (0 ... n).

ipx (returned by GDDM) (short floating point)

ipy (returned by GDDM) (short floating point)
The initial locator position in world coordinates.

pet (returned by GDDM) (fullword integer)
The prompt and echo type used (1 ... n).

earea (returned by GDDM) (array of short floating-point numbers)
The echo area box in device coordinates (XMIN, XMAX, YMIN, YMAX).

ldr (returned by GDDM) (fullword integer)
The number of array elements used in the data record array datrec.

datrec (returned by GDDM) (array of 80-byte character tokens)
The data record array.

Operating states

WSOP, WSAC, SGOP

Related functions

Unpack data record (GURECS), Initialize locator (GINLC)

Description

If the inquired information is available, it is returned as output, and errind is returned as 0 (zero). If the inquired information is not available, all output is invalid, and errind returns an error indicator.

The Unpack data record (GURECS) utility is available to unpack the data record returned by GQLCS.

The parameter mldr reserves space for the data record returned by the inquiry. If you do not specify sufficient length to accommodate the data record, GKS issues error 2001 in errind, and the function terminates to protect the program from a memory error. Usually, a maximum length of 80 (mldr = 1) is sufficient.

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
38: Specified workstation is neither of category INPUT nor of category OUTIN
140: Specified input device is not present on workstation
2000: Enumeration type out of range
2001: Output parameter size insufficient

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