clear_windowT_clear_windowClearWindowClearWindowclear_window (Operator)

Name

clear_windowT_clear_windowClearWindowClearWindowclear_window — Delete the contents of an output window.

Signature

clear_window( : : WindowHandle : )

Description

clear_windowclear_windowClearWindowClearWindowClearWindowclear_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_colorset_colorSetColorSetColorSetColorset_color, set_paintset_paintSetPaintSetPaintSetPaintset_paint, etc.) remain unmodified.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

Result

If the output window is valid clear_windowclear_windowClearWindowClearWindowClearWindowclear_window returns 2 (H_MSG_TRUE). If necessary an exception is raised.