get_insert ( : : WindowHandle : Mode )

Get the current display mode.

get_insert returns the display mode of the output window. It is used by procedures like disp_region, disp_line, disp_rectangle1, etc. The mode is set with set_insert. Possible values for Mode can be queried with the procedure query_insert.


Parameters

WindowHandle (input_control)
window -> integer
Window_id.

Mode (output_control)
string -> string
Display mode.


Result

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


Parallelization Information

get_insert is reentrant and processed without parallelization.


Possible Predecessors

query_insert


Possible Successors

set_insert, disp_image


See also

set_insert, query_insert, disp_region, disp_line


Module

Foundation



Copyright © 1996-2008 MVTec Software GmbH