Ets_Shape_Rect_Info_Get()
Note: Requires OPNET Development Kit
Abstract
Obtains the shape properties of a rectangle.
Syntax
Ets_Shape_Rect_Info_Get (rect_shape_hndl, box, edge_line_width, edge_line_style, edge_line_color, fill_pattern, fill_fore_color, fill_back_color)
| Argument | Type | Description |
|---|---|---|
rect_shape_hndl |
EtsT_Shape_Handle |
Handle to the rectangle shape of interest. |
box |
EtsT_Shape_Rect * |
Size of the rectangle. See Shape Data Types for details. |
edge_line_width |
int * |
The width of the lines, in pixels. |
edge_line_style |
EtsT_Shape_Line_Style * |
The style of the lines, either EtsC_Shape_Line_Solid or EtsC_Shape_Line_None (invisible). |
edge_line_color |
EtsT_Color * |
The color of the lines. See Shape Colors for details. |
fill_pattern |
EtsT_Shape_Brush_Name * |
Pattern for filling the rectangle. |
fill_fore_color |
EtsT_Color * |
Foreground color for fill patterns. Transparent if unspecified. See Shape Colors for details. |
fill_back_color |
EtsT_Color * |
Background color for fill patterns.Transparent if unspecified. See Shape Colors for details. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success, or EtsC_Compcode_Failure if the shape handle passed is not for a rectangle.
Header
ets_api_shapeset.h
Details
See Ets_Shape_Rect_Create() for details about this shape's arguments.