clear_windowclear_windowClearWindowClearWindow (Operator)

Name

clear_windowclear_windowClearWindowClearWindow — Delete the contents of an output window.

clear_windowclear_windowClearWindowClearWindowClearWindow 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_colorSetColorSetColorSetColor, set_paintset_paintSetPaintSetPaintSetPaint, 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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (integer)

Window handle.

Example (HDevelop)

clear_window(WindowHandle)

Example (C)

clear_window(WindowHandle) ;

Example (HDevelop)

clear_window(WindowHandle)

Example (HDevelop)

clear_window(WindowHandle)

Example (HDevelop)

clear_window(WindowHandle)

Result

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