get_insertT_get_insertGetInsertGetInsertget_insert (Operator)

Name

get_insertT_get_insertGetInsertGetInsertget_insert — Get the current display mode.

Warning

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

Signature

get_insert( : : WindowHandle : Mode)

Description

get_insertget_insertGetInsertGetInsertget_insert returns the display mode of the output window. It is used by operators like disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_linedisp_lineDispLineDispLinedisp_line, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1disp_rectangle1, etc. The mode is set with set_insertset_insertSetInsertSetInsertset_insert. Possible values for ModeModeModemodemode can be queried with the operator query_insertquery_insertQueryInsertQueryInsertquery_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

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

ModeModeModemodemode (output_control) string → (string)

Display mode.

Result

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

Possible Predecessors

query_insertquery_insertQueryInsertQueryInsertquery_insert

Possible Successors

set_insertset_insertSetInsertSetInsertset_insert, disp_imagedisp_imageDispImageDispImagedisp_image

See also

set_insertset_insertSetInsertSetInsertset_insert, query_insertquery_insertQueryInsertQueryInsertquery_insert, disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_linedisp_lineDispLineDispLinedisp_line

Module

Foundation