get_insertget_insertGetInsertget_insertGetInsertGetInsert (Operator)

Name

get_insertget_insertGetInsertget_insertGetInsertGetInsert — Get the current display mode.

Signature

get_insert( : : WindowHandle : Mode)

Description

get_insertget_insertGetInsertget_insertGetInsertGetInsert returns the display mode of the output window. It is used by operators like disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion, disp_linedisp_lineDispLinedisp_lineDispLineDispLine, disp_rectangle1disp_rectangle1DispRectangle1disp_rectangle1DispRectangle1DispRectangle1, etc. The mode is set with set_insertset_insertSetInsertset_insertSetInsertSetInsert. Possible values for ModeModeModeModeModemode can be queried with the operator query_insertquery_insertQueryInsertquery_insertQueryInsertQueryInsert.

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (integer)

Window handle.

ModeModeModeModeModemode (output_control) string → (string)

Display mode.

Result

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

Possible Predecessors

query_insertquery_insertQueryInsertquery_insertQueryInsertQueryInsert

Possible Successors

set_insertset_insertSetInsertset_insertSetInsertSetInsert, disp_imagedisp_imageDispImagedisp_imageDispImageDispImage

See also

set_insertset_insertSetInsertset_insertSetInsertSetInsert, query_insertquery_insertQueryInsertquery_insertQueryInsertQueryInsert, disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion, disp_linedisp_lineDispLinedisp_lineDispLineDispLine

Module

Foundation