get_window_background_imageT_get_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImage (Operator)

Name

get_window_background_imageT_get_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImage — Gets a copy of the background image of the HALCON window.

Signature

get_window_background_image( : BackgroundImage : WindowHandle : )

Herror T_get_window_background_image(Hobject* BackgroundImage, const Htuple WindowHandle)

void GetWindowBackgroundImage(HObject* BackgroundImage, const HTuple& WindowHandle)

HImage HWindow::GetWindowBackgroundImage() const

static void HOperatorSet.GetWindowBackgroundImage(out HObject backgroundImage, HTuple windowHandle)

HImage HWindow.GetWindowBackgroundImage()

Description

get_window_background_imageget_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImageGetWindowBackgroundImage returns a copy of the background image BackgroundImageBackgroundImageBackgroundImageBackgroundImagebackgroundImage set in the window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle. This operator is specially useful in cases where the user would like to perform some operations in one of the callback functions of a drawing object attached to the window. See set_drawing_object_callbackset_drawing_object_callbackSetDrawingObjectCallbackSetDrawingObjectCallbackSetDrawingObjectCallback for more details.

Execution Information

Parameters

BackgroundImageBackgroundImageBackgroundImageBackgroundImagebackgroundImage (output_object)  (multichannel-)image objectHImageHImageHobject * (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Copy of the background image.

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

Window handle.

Result

If the window exists and the specified parameters are correct get_window_background_imageget_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImageGetWindowBackgroundImage returns 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindowAttachBackgroundToWindow

Possible Successors

close_windowclose_windowCloseWindowCloseWindowCloseWindow, detach_background_from_windowdetach_background_from_windowDetachBackgroundFromWindowDetachBackgroundFromWindowDetachBackgroundFromWindow, attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindow

See also

attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindowAttachBackgroundToWindow, detach_drawing_object_from_windowdetach_drawing_object_from_windowDetachDrawingObjectFromWindowDetachDrawingObjectFromWindowDetachDrawingObjectFromWindow

Module

Foundation