set_window_dcT_set_window_dcSetWindowDcSetWindowDc (Operator)

Name

set_window_dcT_set_window_dcSetWindowDcSetWindowDc — Set the device context of a virtual graphics window (Windows NT).

Signature

set_window_dc( : : WindowHandle, WINHDC : )

Description

set_window_dcset_window_dcSetWindowDcSetWindowDcSetWindowDc sets the device context of a window previously opened with new_extern_windownew_extern_windowNewExternWindowNewExternWindowNewExternWindow. All output (disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_imagedisp_imageDispImageDispImageDispImage, etc.) is done in the window with this device context.

The parameter WINHDCWINHDCWINHDCWINHDCWINHDC contains the device context of the window in which HALCON should output its data. This device context is used in all output routines of HALCON.

Attention

The window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle has to be created with new_extern_windownew_extern_windowNewExternWindowNewExternWindowNewExternWindow beforehand.

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.

WINHDCWINHDCWINHDCWINHDCWINHDC (input_control) pointer → (integer)

device context of WINHWnd.

Restriction: WINHDC != 0

Result

If the values of the specified parameters are correct, set_window_dcset_window_dcSetWindowDcSetWindowDcSetWindowDc returns 2 (H_MSG_TRUE). If necessary, an exception is raised.