company logo

EnumeratorDefinition :: description - Category definition

A detailed definition of the category can be defined in the documentation topic (DSC_Topic::characteristic), which might be linked to the enumerator definition (SDB_Value). The definition will be provided in the description field of the category and can be displayed in order to provide the user with more detailed information about the meaning of a category.

Descriptions can be defined in different languages. The description will be provided in the default language selected for the application. Since enumerations are dictionary resources, which are cached in an application, one usually cannot change the language for the description while running the application. In order to achieve this, the dictionary definition for the category (SDB_Value) might be read directly from the dictionary database.

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

Implementation details

odaba::String EnumeratorDefinition  :: description (  )