dump_window_image ( : Image : WindowHandle : )

Write the window content in an image object.

dump_window_image writes the content of the graphics window (WindowHandle) in an image (Image). To transform gray values the current color table of the window is used, i.e., the values of set_lut_style remain unconsidered.


Attention

Under UNIX, the graphics window must be completely visible on the root window, because otherwise the contents of the window cannot be read due to limitations in X Windows.


Parameters

Image (output_object)
image -> object : byte
Saved image.

WindowHandle (input_control)
window -> integer
Window identifier.


Result

If the window is valid dump_window_image returns 2 (H_MSG_TRUE). If necessary an exception handling is raised.


Parallelization Information

dump_window_image is reentrant, local, and processed without parallelization.


Possible Predecessors

open_window, set_draw, set_color, set_colored, set_line_width, open_textwindow, disp_region


See also

open_window, open_textwindow, set_system, dump_window


Module

Foundation



Copyright © 1996-2008 MVTec Software GmbH