get_shape ( : : WindowHandle : DisplayShape )

Get the current region output shape.

get_shape returns the shape in which regions are displayed. The available shapes can be queried with query_shape and then changed with set_shape.


Parameters

WindowHandle (input_control)
window -> integer
Window_id.

DisplayShape (output_control)
string -> string
Current region output shape.


Result

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


Parallelization Information

get_shape is reentrant and processed without parallelization.


Possible Predecessors

query_shape


Possible Successors

set_shape, disp_region


See also

set_shape, query_shape, disp_region


Module

Foundation



Copyright © 1996-2008 MVTec Software GmbH