detach_background_from_windowdetach_background_from_windowDetachBackgroundFromWindowDetachBackgroundFromWindowdetach_background_from_windowT_detach_background_from_window
Short description
detach_background_from_windowdetach_background_from_windowDetachBackgroundFromWindowDetachBackgroundFromWindowdetach_background_from_windowT_detach_background_from_window — Detach the background image from a HALCON window.
Signature
detach_background_from_window( window WindowHandle )detach_background_from_window( : : WindowHandle : )void DetachBackgroundFromWindow( const HTuple& WindowHandle )static void HOperatorSet.DetachBackgroundFromWindow( HTuple windowHandle )def detach_background_from_window( window_handle: HHandle ) -> None
Herror T_detach_background_from_window( const Htuple WindowHandle )
void HWindow::DetachBackgroundFromWindow( ) const
static void HDrawingObject::DetachBackgroundFromWindow( const HWindow& WindowHandle )
void HWindow.DetachBackgroundFromWindow( )
static void HDrawingObject.DetachBackgroundFromWindow( HWindow windowHandle )
Description
This operator detaches the background image that was previously attached
with attach_background_to_windowAttachBackgroundToWindow from the HALCON window
defined in WindowHandlewindowHandlewindow_handle.
Thus the background of the window will be cleared.
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)(handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)
Window handle.
Result
If the window exists and the specified parameters are correct
detach_background_from_windowDetachBackgroundFromWindow returns 2 (H_MSG_TRUE). If necessary an
exception is raised.
Combinations with other operators
Combinations
Possible predecessors
attach_background_to_windowAttachBackgroundToWindow
Module
Foundation