HALCON Reference Manual 10.0.2
Table of Contents / Graphics / Parameters ClassesClassesClasses | | | Operators

get_insertget_insertget_insertGetInsertGetInsert (Operator)

Name

get_insertget_insertget_insertGetInsertGetInsert — Get the current display mode.

Signature

get_insert( : : WindowHandle : Mode)

Herror get_insert(const Hlong WindowHandle, char* Mode)

Herror T_get_insert(const Htuple WindowHandle, Htuple* Mode)

Herror get_insert(const HTuple& WindowHandle, char* Mode)

HTuple HWindow::GetInsert() const

void HOperatorSetX.GetInsert(
[in] VARIANT WindowHandle, [out] VARIANT* Mode)

BSTR HWindowX.GetInsert()

static void HOperatorSet.GetInsert(HTuple windowHandle, out HTuple mode)

string HWindow.GetInsert()

Description

get_insertget_insertget_insertGetInsertGetInsert returns the display mode of the output window. It is used by operators like disp_regiondisp_regiondisp_regionDispRegionDispRegion, disp_linedisp_linedisp_lineDispLineDispLine, disp_rectangle1disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1, etc. The mode is set with set_insertset_insertset_insertSetInsertSetInsert. Possible values for ModeModeModeModemode can be queried with the operator query_insertquery_insertquery_insertQueryInsertQueryInsert.

Parallelization

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window → HWindow, HTupleHTupleHWindowX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong)

Window_id.

ModeModeModeModemode (output_control)  string → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Display mode.

Result

get_insertget_insertget_insertGetInsertGetInsert returns 2 (H_MSG_TRUE) if the window is valid. Otherwise an exception is raised.

Possible Predecessors

query_insertquery_insertquery_insertQueryInsertQueryInsert

Possible Successors

set_insertset_insertset_insertSetInsertSetInsert, disp_imagedisp_imagedisp_imageDispImageDispImage

See also

set_insertset_insertset_insertSetInsertSetInsert, query_insertquery_insertquery_insertQueryInsertQueryInsert, disp_regiondisp_regiondisp_regionDispRegionDispRegion, disp_linedisp_linedisp_lineDispLineDispLine

Module

Foundation

Table of Contents / Graphics / Parameters ClassesClassesClasses | | | Operators
HALCON Reference Manual 10.0.2 Copyright © 1996-2011 MVTec Software GmbH