Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

CLEAR^XGF(): Screen Clear Region

Reference Type: Supported, Category: XGF Function Library, ICR#: 3173

Description

The CLEAR^XGF API clears a rectangular region of the screen. It is useful to clear a portion of the screen.

The CLEAR function works by printing spaces using the current screen attribute in the specified region. If the screen attribute is changed and then the CLEAR function is used, the rectangular region is cleared in the new attribute.

A call to the PREP^XGF(): Screen/Keyboard Setup API must be made at some point prior to calling CLEAR^XGF.

Acceptable values for the top and bottom parameters range from 0 to IOSL-1.

Acceptable values for the left and right parameters range from 0 to IOM-1.

Format

  CLEAR^XGF(top,left,bottom,right)

Input Parameters

top:

(required) Top screen coordinate for box.
left:

(required) Left screen coordinate for box.
bottom:

(required) Bottom screen coordinate for box.
right:

(required) Right screen coordinate for box.

Output Parameters

$x and $y:

Set to the right and bottom specified as parameters.

NOTE: See also: RESTORE^XGF(): Screen Restore, SAVE^XGF(): Screen Save, and WIN^XGF(): Screen Text Window APIs.

Examples

Example 1

For example, to clear the entire screen, do the following:

>D CLEAR^XGF(0,0,23,79)

Example 2

To clear a rectangular region in the center of the screen, do the following:

>D CLEAR^XGF(5,20,15,60)