get_insertT_get_insertGetInsertGetInsertget_insert (Operator)

Name

get_insertT_get_insertGetInsertGetInsertget_insert — Get the current display mode.

Warning

get_insertget_insertGetInsertGetInsertGetInsertget_insert is obsolete and is only provided for reasons of backward compatibility.

Signature

get_insert( : : WindowHandle : Mode)

Description

get_insertget_insertGetInsertGetInsertGetInsertget_insert returns the display mode of the output window. It is used by operators like disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region, disp_linedisp_lineDispLineDispLineDispLinedisp_line, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1DispRectangle1disp_rectangle1, etc. The mode is set with set_insertset_insertSetInsertSetInsertSetInsertset_insert. Possible values for ModeModeModeModemodemode can be queried with the operator query_insertquery_insertQueryInsertQueryInsertQueryInsertquery_insert.

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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

ModeModeModeModemodemode (output_control) string → (string)

Display mode.

Result

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

Possible Predecessors

query_insertquery_insertQueryInsertQueryInsertQueryInsertquery_insert

Possible Successors

set_insertset_insertSetInsertSetInsertSetInsertset_insert, disp_imagedisp_imageDispImageDispImageDispImagedisp_image

See also

set_insertset_insertSetInsertSetInsertSetInsertset_insert, query_insertquery_insertQueryInsertQueryInsertQueryInsertquery_insert, disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region, disp_linedisp_lineDispLineDispLineDispLinedisp_line

Module

Foundation