company logo

TypeDefinition :: lookupLabel - Lookup enumerator label by code

The function returns the label defined for an enumerator value identified by the number passed in iEnumerationValue.

When calling the function with an invalid type definition or when the type definition does not refer to an enumeration, the function throws an exception. In order to check, whether the data type is an enumeration, isEnumeration() may be called.

Notes:

When referring to enumerator values by Value (e.g. v), one may also call v.value("label") for retrieving the enumerators name. Within OSI, one may simply write v.label.

Return value:  Enumerator name ( odaba::String & )

The enumerator name is the string value (name) for an enumerator in an enumeration. Enumerator names must not exceed 40 characters.

Implementation details

odaba::String TypeDefinition  :: lookupLabel ( int32 iEnumeratorValue )
  • iEnumeratorValue - Enumerator value

    The enumerator value is the code (value) of an enumerator as being defined in an enumeration. CS_U is a reserved value indication an invalid enumerator value.