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