clear_windowT_clear_windowClearWindowClearWindow (Operator)

Name

clear_windowT_clear_windowClearWindowClearWindow — Delete the contents of an output window.

Signature

clear_window( : : WindowHandle : )

Herror T_clear_window(const Htuple WindowHandle)

void ClearWindow(const HTuple& WindowHandle)

void HWindow::ClearWindow() const

static void HOperatorSet.ClearWindow(HTuple windowHandle)

void HWindow.ClearWindow()

Description

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

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow

Alternatives

clear_rectangleclear_rectangleClearRectangleClearRectangleClearRectangle, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1DispRectangle1

See also

open_windowopen_windowOpenWindowOpenWindowOpenWindow

Module

Foundation