company logo

DictionaryHandle :: EnumToString - Get enum name from enum value

The function converts an enumerator value (integer) into an enumerator name (string). The enum value can be passed as integer or in a property handle. The maximum length for the string must be provided by the calling function.

When the enum value passed does not exist, the function returns NULL.
Return value:  String containing the text ( NString & )

Implementation overview

Implementation details

  1. - internal feature
    NString & DictionaryHandle  :: EnumToString ( NString &enum_name, PropertyHandle &ph, NString &nstring )
    • enum_name - Enumeration name

      The enumeration name is passed as 0-terminated string. Enumeration names can be passed as scoped names, where preceding name space names are separated by double colon '::'.
    • ph - Reference to property handle
    • nstring - String object
    2. to list
  2. - internal feature
    NString & DictionaryHandle  :: EnumToString ( NString &enum_name, int32 enum_val, NString &nstring )
    • enum_name - Enumeration name

      The enumeration name is passed as 0-terminated string. Enumeration names can be passed as scoped names, where preceding name space names are separated by double colon '::'.
    • enum_val - 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.
    • nstring - String object
    3. to list
to top previous next upper table of contents Comment