Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.
Parameter Class
A Parameter object represents a method argument and is accessed through the Method Parameters collection.
Associated table in .EAP file: t_operationparams
Parameter Attributes
Attribute |
Type |
Notes |
---|---|---|
Alias |
String |
Read/Write. An optional alias for this parameter. |
ClassifierID |
String |
Read/Write. A ClassifierID for the parameter, if known. |
Default |
String |
Read/Write. A default value for this parameter. |
IsConst |
Boolean |
Read/Write. Flag indicating the parameter is Const (cannot be altered). |
Kind |
String |
Read/Write. The parameter kind - in, inout, out, return. |
Name |
String |
Read/Write. The parameter name; must be unique for a single method. |
Notes |
String |
Read/Write. Descriptive notes. |
ObjectType |
Read only. Distinguishes objects referenced through a Dispatch interface. |
|
OperationID |
Long |
Read only. ID of the method associated with this parameter. |
ParameterGUID |
String |
Read/Write. A globally unique ID for the current Parameter. System generated. |
Position |
Long |
Read/Write. The position in the argument list. |
Stereotype |
String |
Read/Write. The first stereotype of the parameter. |
StereotypeEx |
String |
Read/Write. All the applied stereotypes of the parameter in a comma-separated list. |
Style |
String |
Read/Write. Some style information. |
StyleEx |
String |
Read/Write. Advanced style settings. Reserved for the use of Sparx Systems. |
TaggedValues |
Collection of type ParamTag |
Read/Write. GUID of the parameter with which this ParamTag is associated. |
Type |
Variant |
Read/Write. The parameter type; can be a primitive type or defined classifier. |
Parameter Methods
Method |
Type |
Notes |
---|---|---|
GetLastError () |
String |
Returns a string value describing the most recent error that occurred in relation to this object. This function is rarely used as an exception is thrown when an error occurs. |
Update () |
Boolean |
Update the current Parameter object after modifying or appending a new item. If false is returned, check the GetLastError function for more information. |