Topic
Prev Next

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

Remarks

See also

Alias

String

Notes: Read/Write

An optional alias for this parameter.

ClassifierID

String

Notes: Read/Write

A ClassifierID for the parameter, if known.

Default

String

Notes: Read/Write

A default value for this parameter.

IsConst

Boolean

Notes: Read/Write

A flag indicating that the parameter is Const (cannot be altered).

Kind

String

Notes: Read/Write

The parameter kind - in, inout, out, or return.

Name

String

Notes: Read/Write

The parameter name; this must be unique for a single method.

Notes

String

Notes: Read/Write

Descriptive notes.

ObjectType

ObjectType

Notes: Read only

Distinguishes objects referenced through a Dispatch interface.

OperationID

Long

Notes: Read only

The ID of the method associated with this parameter.

ParameterGUID

String

Notes: Read/Write

A system generated, globally unique ID for the current Parameter.

Position

Long

Notes: Read/Write

The position of the parameter in the argument list.

Stereotype

String

Notes: Read/Write

The first stereotype of the parameter.

StereotypeEx

String

Notes: Read/Write

All the applied stereotypes of the parameter in a comma-separated list. Reading the value will provide the stereotype name only; assigning the value accepts either fully-qualified or simple names.

Style

String

Notes: Read/Write

Some style information.

StyleEx

String

Notes: Read/Write

Advanced style settings, reserved for the use of Sparx Systems.

TaggedValues

Collection of type ParamTag

Notes: Read/Write

The GUID of the parameter with which this ParamTag is associated.

Type

Variant

Notes: Read/Write

The parameter type; can be a primitive type or a defined classifier.

Parameter Methods

Method

Remarks

See also

GetLastError()

String

Notes: Returns a string value describing the most recent error that occurred in relation to this object.

Update()

Boolean

Notes: Update the current Parameter object after modifying or appending a new item.

If False is returned, check the 'GetLastError()' function for more information.