Template Function gpa::detail::WriteEnumStr

• Defined in File api-types/to-string.h

Function Documentation

template<typename EnumType>
inline std::string gpa::detail::WriteEnumStr(StrFmtFlags strFmtFlags, uint32_t tabCount, uint32_t tabSize, char const *identifier, EnumType value)

Gets the std::string representation of a given enumerant.

Note

tabCount only has an effect if strFmtFlags has the GPA_STR_FMT_FORMATTED bit set

Note

tabSize only has an effect if strFmtFlags has the GPA_STR_FMT_FORMATTED bit set

Parameters

• <EnumType> -- The type of the enumeration to get the enumerant std::string representation of

• strFmtFlags -- [in] A bit mask of flags controlling the resulting std::string's formatting

• tabCount -- [in] The number of tabs to indent the contents of the resulting std::string

• tabSize -- [in] The number of spaces to use for a tab

• indentifier -- [in] A pointer to a null terminated C string containing the identifier name of the given enumerant

• value -- [in] The value of the given enumerant

Returns

The std::string representation of the given enumerant