get_shapeT_get_shapeGetShapeGetShapeget_shape (Operator)
Name
get_shapeT_get_shapeGetShapeGetShapeget_shape — Get the current region output shape.
Signature
Description
get_shapeget_shapeGetShapeGetShapeGetShapeget_shape returns the shape in which regions are
displayed. The available shapes can be queried with
query_shapequery_shapeQueryShapeQueryShapeQueryShapequery_shape and then changed with set_shapeset_shapeSetShapeSetShapeSetShapeset_shape.
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
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
DisplayShapeDisplayShapeDisplayShapeDisplayShapedisplayShapedisplay_shape (output_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Current region output shape.
Result
get_shapeget_shapeGetShapeGetShapeGetShapeget_shape returns 2 (H_MSG_TRUE) if the window is valid.
Otherwise an exception is raised.
Possible Predecessors
query_shapequery_shapeQueryShapeQueryShapeQueryShapequery_shape
Possible Successors
set_shapeset_shapeSetShapeSetShapeSetShapeset_shape,
disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region
See also
set_shapeset_shapeSetShapeSetShapeSetShapeset_shape,
query_shapequery_shapeQueryShapeQueryShapeQueryShapequery_shape,
disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region
Module
Foundation