query_shape ( : : : DisplayShape )

Query the region display modes.

query_shape returns the names of all region display modes (e.g. 'original', 'circle', 'rectangle1', 'rectangle2', 'ellipse', etc.) for the window. They are used by set_shape.


Parameters

DisplayShape (output_control)
string-array -> string
region display mode names.


Result

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


Parallelization Information

query_shape is reentrant and processed without parallelization.


Possible Successors

get_shape, set_shape, disp_region


See also

set_shape, get_shape, disp_region


Module

Foundation



Copyright © 1996-2008 MVTec Software GmbH