clear_window

clear_window ( : : WindowHandle : )

Delete an output window.

clear_window deletes all entries in the output window. The window (background and edge) is reset to its original state. Parameters assigned to this window (e.g., with set_color, set_paint, etc.) remain unmodified.

Parameters

`WindowHandle` (input_control)	window `->` integer
Window identifier.

Example

clear_window(WindowHandle).

Result

If the ouput window is valid clear_window returns 2 (H_MSG_TRUE). If necessary an exception handling is raised.

Parallelization Information

clear_window is reentrant, local, and processed without parallelization.

Possible Predecessors

open_window, open_textwindow

Alternatives

clear_rectangle, disp_rectangle1

See also

open_window, open_textwindow

Module

System