GCLRWK

GDDM-GKS V1R1 Programming Guide and Reference

GCLRWK

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

Purpose


GCLRWK	(wkid, cofl)

APL code	1309
GKS RCP code	X'38000600' (939525632)

Function: To clear workstation.

Control function. Clears the display surface of a workstation according to the value of a control flag and releases all segments at the workstation.

Parameters

wkid (specified by user) (fullword integer)
The identifier selected when the workstation was opened.

cofl (specified by user) (fullword integer)
The control flag. This is an integer that specifies the clearing of the display surface. The possible values are:

0 (GCONDI)

Conditionally (the screen is cleared only if something is drawn upon it).

1 (GALWAY)

Always (the screen is cleared even if it is empty).

Operating states

WSOP, WSAC

Related functions

Associate segment with workstation (GASGWK), Update workstation (GUWK), Delete segment from workstation (GDSGWK), Set workstation window (GSWKWN), Set workstation viewport (GSWKVP)

Description

This function executes any deferred actions for the specified workstation and then clears the display surface according to the value of cofl.

If cofl is 0, the display surface clears only if an object appears on it.

If cofl is 1, the display surface always clears.

If the workstation state list (WSL) for the workstation indicates that a workstation transformation update is pending, the current workstation window and viewport are set to those requested by previous calls to the functions Set workstation window (GSWKWN) or Set workstation viewport (GSWKVP). The "workstation transformation update state" entry in the WSL is set to notpending.

GCLRWK also releases all segments at the workstation. For each segment stored on the workstation, the workstation is deleted from the list of associated workstations kept in the segment state list. Any segments associated only with workstation wkid are deleted. The list of segments stored at the workstation is set to empty.

Finally, the WSL entry "new frame action necessary at update" for the workstation is set to no and the entry "display surface empty" is set to empty.

Principal errors

6: GKS not in proper state: GKS shall be either in the state WSOP or in the state WSAC
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
2000: Enumeration type out of range

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