get_shapeget_shapeGetShapeget_shapeGetShapeGetShape (Operator)

Name

get_shapeget_shapeGetShapeget_shapeGetShapeGetShape — Get the current region output shape.

Signature

get_shape( : : WindowHandle : DisplayShape)

Description

get_shapeget_shapeGetShapeget_shapeGetShapeGetShape returns the shape in which regions are displayed. The available shapes can be queried with query_shapequery_shapeQueryShapequery_shapeQueryShapeQueryShape and then changed with set_shapeset_shapeSetShapeset_shapeSetShapeSetShape.

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (integer)

Window_id.

DisplayShapeDisplayShapeDisplayShapeDisplayShapeDisplayShapedisplayShape (output_control) string → (string)

Current region output shape.

Result

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

Possible Predecessors

query_shapequery_shapeQueryShapequery_shapeQueryShapeQueryShape

Possible Successors

set_shapeset_shapeSetShapeset_shapeSetShapeSetShape, disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion

See also

set_shapeset_shapeSetShapeset_shapeSetShapeSetShape, query_shapequery_shapeQueryShapequery_shapeQueryShapeQueryShape, disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion

Module

Foundation