detach_drawing_object_from_windowT_detach_drawing_object_from_windowDetachDrawingObjectFromWindowDetachDrawingObjectFromWindow (Operator)

Name

detach_drawing_object_from_windowT_detach_drawing_object_from_windowDetachDrawingObjectFromWindowDetachDrawingObjectFromWindow — Detach an existing drawing object from a HALCON window.

Signature

detach_drawing_object_from_window( : : WindowHandle, DrawHandle : )

Description

This operator can be used to detach the drawing object DrawHandleDrawHandleDrawHandleDrawHandledrawHandle from the HALCON window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle to which it is currently attached. The drawing object will not longer be displayed in the window. If a callback function was defined for the drawing object on the event 'on_detach' with set_drawing_object_callbackset_drawing_object_callbackSetDrawingObjectCallbackSetDrawingObjectCallbackSetDrawingObjectCallback this will also be called.

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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (handle)

Window Handle.

DrawHandleDrawHandleDrawHandleDrawHandledrawHandle (input_control) drawing_object → (handle)

Handle of the drawing object.

Result

detach_drawing_object_from_windowdetach_drawing_object_from_windowDetachDrawingObjectFromWindowDetachDrawingObjectFromWindowDetachDrawingObjectFromWindow returns 2 (H_MSG_TRUE), if the DrawHandleDrawHandleDrawHandleDrawHandledrawHandle and WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle are valid. Otherwise an exception is raised.