TypeDefinition :: enumeratorEntry - Get enumerator definition entry
The function returns the enumerator definition at position passed in iPosition in the top enumerator list. Enumerators are returned in sequence of code value. In case of hierarchical enumerations, subordinated enumerators can be searched via sub enumerator lists provided by enumerator definitions.
When the requested enumerator could not be found in the top enumerator list, the function returns an empty enumerator, which might be checked by calling EnumeratorDefinition::isValid().
When the type definition is not an enumerator or the enumerator definition in the dictionary is invalid, the function throws an exception. In order to check, whether the data type is an enumeration, isEnumeration() might be called.
... readEnumerators(TypeDefinition &enumdef) {
EnumeratorDefinition edef;
int pos = 0;
while ( (edef = enumdef.enumeratorEntry(pos++)).IsValid() ) {
// ... do something
}
}
Enumerator definitions provide code, name and definition for an enumerator value.
Implementation details
- iPosition
- Position in collection
The position of an element in a collection is beginning with 0 for the first element.