gmplArgumentStatement
Mark Juras
Owned by Mark Juras
Argument Statement Summary
Argument is a terminal, declaration statement that occurs within method, accessor, and event statements. It declares a calling argument of its parent.| Attribute | Description |
|---|---|
| Id | This attribute specifies the identifier of the argument. It must be unique in so far as the other arguments in the method are concerned. It is not case sensitive. |
| Type | This attribute is a Type attribute as discussed on the Declaration page. It specifies the type of the argument. |
| Status | This attribute is the Status attribute as discussed on the Declaration page. It specifies the various context flags to be associated with the argument. |
| Optional | This string attribute specifies that the argument is optional in calls to the method and what the default value should be used to replace the missing argument. Its possible settings are below. |
| NetName | This attribute is the identifier of the argument to be used when declaring or referring to it in the target language. |
| MigName | This attribute is identical to NetName. If both are used in the declaration the Migname takes precedence. |
| MigStatus | This attribute is a MigStatus attribute as discussed on the Declaration page. It contains generalized migration settings for the argument. |
| Changed | This is an On/Off flag attribute. The On setting sets the Changed context flag On. This means that in processing the source code the compiler determined that the value of the argument was being changed. This flag is later used in by the algorithm that assigns arguments ByVal calling status. |
| MigPattern | This string attribute associates a surface pattern string with code references to the argument. See the Patterns page for details on the content of pattern strings. It is equivalent to the All pattern. |
| CshPattern | This string attribute associates a surface pattern string with code references to the argument. See the Patterns page for details on the content of pattern strings. It is equivalent to the Csh pattern. |
| VbnPattern | This string attribute associates a surface pattern string with code references to the argument. See the Patterns page for details on the content of pattern strings. It is equivalent to the Vbn pattern. |
| Overload | This string attribute specifies a list of legacy platform types to be used in declaring overloads of the parent method for the argument. |
| Generic | This is an On/Off flag that specifies that the method should declare the parent method as using a generic type for the argument. |
The Optional attribute can have the following entries:
| Entry | Replacement value supplied |
|---|---|
| DEF.MissingZero | 0 |
| DEF.MinusOne | -1 |
| DEF.MoveTop | 0 |
| DEF.MoveWidth | 0 |
| DEF.MoveHeight | 0 |
| DEF.TypeMissing | Type.Missing |
| DEF.Overload | no value supplied |
| DEF.EmptyString | String.Empty |
| DEF.NullObject | Nothing or null |
| RefZeroObj | ref objZero |
| DoubleQuote | "" |
| DateTime | New DateTime(0) or DateTime.MinValue |
| Default | The zero initialization value of the type of the argument |
| string | string |
The script errors associated with the Argument statement are as follows:
| Error | Description |
| 1135 | Argument command missing required id attribute. |
| 1136 | Unable to store argument vector: %1d |
| 1137 | Argument command missing required type attribute. |
| 1138 | Argument status [%1d] is not defined. |
Table of Contents