Ets_Shape_Attr_Get()
Note: Requires OPNET Development Kit
Abstract
Returns the value of an attribute.
Syntax
Ets_Shape_Attr_Get (shape_hndl, attr_name, attr_value)
| Argument | Type | Description |
|---|---|---|
shape_hndl |
EtsT_Shape_Handle |
Handle to the shape of interest. |
attr_name |
const char * |
The name of the attribute to get. |
attr_value |
void * |
Pointer to a memory location to hold the attribute value. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success, or EtsC_Compcode_Failure if the shape has no value associated with the requested attribute name.
Header
ets_api_shapeset.h
Details
The memory location pointed to by attr_value must be large enough to hold the requested value. If necessary, use Ets_Shape_Attr_Type_Get() to determine the attribute type before allocating the memory.