Extensions.DataType.EnumerationContainsName
Revision as of 08:05, 12 April 2016 by Nb (talk | contribs) (Created page with "{{DISPLAYTITLE:OTX '''EnumerationContainsName'''}}Category:DataTypes == Classification == {{ClassificationActivity | EnumerationContainsName | Checks if the specified enum...")
Contents
Classification
| Name | EnumerationContainsName |
| Short Description | Checks if the specified enumeration contains the name |
| Class | Term |
| Extension | OTX DataTypes extension |
| Group | EnumerationContainsName related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
DataTypes.EnumerationContainsName(StringTerm, EnumerationSignature);Description
EnumerationContainsName is a term to checks if the specified enumeration contains the name.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Boolean | This value is TRUE if the specified enumeration contains the name. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Name | String | Term | - | [1] | Name of to-be-checked element inside the specified enumeration. |
| Enumeration | OtxLink | - | - | [1] | This attribute identifies the specified enumeration to check the name. The link shall point to the corresponding EnumerationSignature. |
OTL Examples
package DataTypes.EnumerationSignature EnumerationSignature1(Integer EnumerationElement1 = 7,<br/>Integer EnumerationElement2 = 12);
public procedure main()
{
Boolean checkEnumName;
checkName = DataTypes.EnumerationContainsName("EnumerationElement2", EnumerationSignature1);
}See also
EnumerationContainsValue
EnumerationGetEntryList
GetEnumerationByName
GetEnumerationByValue
StructureCopy
