get_insertT_get_insertGetInsertGetInsert (Operator)

Name

get_insertT_get_insertGetInsertGetInsert — Get the current display mode.

Signature

get_insert( : : WindowHandle : Mode)

Description

get_insertget_insertGetInsertGetInsertGetInsert returns the display mode of the output window. It is used by operators like disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_linedisp_lineDispLineDispLineDispLine, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1DispRectangle1, etc. The mode is set with set_insertset_insertSetInsertSetInsertSetInsert. Possible values for ModeModeModeModemode can be queried with the operator query_insertquery_insertQueryInsertQueryInsertQueryInsert.

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.

ModeModeModeModemode (output_control) string → (string)

Display mode.

Result

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

Possible Predecessors

query_insertquery_insertQueryInsertQueryInsertQueryInsert

Possible Successors

set_insertset_insertSetInsertSetInsertSetInsert, disp_imagedisp_imageDispImageDispImageDispImage

See also

set_insertset_insertSetInsertSetInsertSetInsert, query_insertquery_insertQueryInsertQueryInsertQueryInsert, disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_linedisp_lineDispLineDispLineDispLine

Module

Foundation