clear_windowClearWindowClearWindowclear_windowT_clear_window

HALCON ScriptCpp++.NETPythonC

Short description

clear_windowClearWindowClearWindowclear_windowT_clear_window — Delete the contents of an output window.

Signature

clear_window( window WindowHandle )void ClearWindow( const HTuple& WindowHandle )static void HOperatorSet.ClearWindow( HTuple windowHandle )def clear_window( window_handle: HHandle ) -> None

Herror T_clear_window( const Htuple WindowHandle )

void HWindow::ClearWindow( ) const

void HWindow.ClearWindow( )

Description

clear_windowClearWindow 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_colorSetColor, set_paintSetPaint, etc.) remain unmodified.

Execution information

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

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Result

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

Combinations with other operators

Combinations

Possible predecessors

open_windowOpenWindow

Alternatives

clear_rectangleClearRectangle, disp_rectangle1DispRectangle1

See also

open_windowOpenWindow

Module

Foundation