Parameter Element
X-Ref:
- Ast Parameter Node
- Ast Variable Base Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| DataType | TypeCode | Empty | This value specifies the type of the variable selected from the list of variable types supported by the system. This is a required property |
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| Id | Guid | 00000000-0000-0000-0000-000000000000 | Allows the developer to specify a unique identifier (GUID) for the variable. This can be used to retain a consistent ID between builds. |
| IncludeInDebugDump | IncludeInDebugDump | Automatic | This value specifies whether the value of this variable will be included in a debug dump. |
| IsRequired | Boolean | False | Indicates that this parameter requires a value besides the design default. |
| IsSensitive | Boolean | False | Indicates that the parameter stores sensitive information, which should be persisted or encrypted in the catalog. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <Annotations> <Annotation /> </Annotations> | AstAnnotationNode | This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code. |