get_shapeT_get_shapeGetShapeGetShape (Operator)

Name

get_shapeT_get_shapeGetShapeGetShape — Get the current region output shape.

Signature

get_shape( : : WindowHandle : DisplayShape)

Herror T_get_shape(const Htuple WindowHandle, Htuple* DisplayShape)

void GetShape(const HTuple& WindowHandle, HTuple* DisplayShape)

HString HWindow::GetShape() const

static void HOperatorSet.GetShape(HTuple windowHandle, out HTuple displayShape)

string HWindow.GetShape()

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

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