Operator Reference
clear_window (Operator)
clear_window — Delete the contents of an output window.
Signature
clear_window( : : WindowHandle : )
Description
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.
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
WindowHandle (input_control) window → (handle)
Window handle.
Result
If the output window is valid clear_window returns 2 (
H_MSG_TRUE)
.
If necessary an exception is raised.
Possible Predecessors
Alternatives
clear_rectangle,
disp_rectangle1
See also
Module
Foundation