query_shapeT_query_shapeQueryShapeQueryShape (Operator)

Name

query_shapeT_query_shapeQueryShapeQueryShape — Query the region display modes.

Signature

query_shape( : : : DisplayShape)

Herror T_query_shape(Htuple* DisplayShape)

void QueryShape(HTuple* DisplayShape)

static HTuple HInfo::QueryShape()

static void HOperatorSet.QueryShape(out HTuple displayShape)

static HTuple HInfo.QueryShape()

Description

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

Execution Information

Parameters

DisplayShapeDisplayShapeDisplayShapeDisplayShapedisplayShape (output_control)  string-array HTupleHTupleHtuple (string) (string) (HString) (char*)

region display mode names.

Result

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

Possible Successors

get_shapeget_shapeGetShapeGetShapeGetShape, set_shapeset_shapeSetShapeSetShapeSetShape, disp_regiondisp_regionDispRegionDispRegionDispRegion

See also

set_shapeset_shapeSetShapeSetShapeSetShape, get_shapeget_shapeGetShapeGetShapeGetShape, disp_regiondisp_regionDispRegionDispRegionDispRegion

Module

Foundation