Extensions.DataType.EnumerationGetEntryList
Jump to navigation
Jump to search
Contents
Classification
Name | EnumerationGetEntryList |
Short Description | Returns a List of String of the names in a specified enumeration |
Class | Term |
Extension | OTX DataTypes extension |
Group | EnumerationGetEntryList related terms |
Exceptions | - |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
/// Local Declarations
List<String> ListVariable;
/// Flow
ListVariable = DataType.EnumerationGetEntryList(OtxLink);
Description
EnumerationGetEntryList is a term that returns a List of String of the names in a specified enumeration.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
Data Type | Description |
List | Returns a List of String of the names in a specified enumeration. |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
Enumeration | OtxLink | - | - | [1] | This attribute identifies the specified enumeration to get the entry list. The link will point to the corresponding EnumerationSignature. |
OTL Examples
package DataType.EnumerationSignature EnumerationSignature1(Integer EnumerationElement1 = 7, Integer EnumerationElement2 = 12);
/// Global Declarations
public procedure main()
{
/// Local Declarations
List<String> entryList;
/// Flow
entryList = DataType.EnumerationGetEntryList(EnumerationSignature1);
}
See also
EnumerationContainsName
EnumerationContainsValue
GetEnumerationByName
GetEnumerationByValue
StructureCopy