Overview
C API (Core)
struct GetElementTypeString { TYPE type; UINT32 flags; const char* result; }; Symbol brahms_getElementTypeString(GetElementTypeString* data);

Get a string that specifies what numeric type is represented by type. This is most useful for converting numeric type codes into human-readable strings, but can also aid in debugging by clarifying to the developer what any type code represents.

Warnings
  • The returned string is ONLY VALID until the calling component returns control to the framework (i.e. finishes processing the current event).

Arguments

TYPE type IN
The type to translate.
UINT32 flags IN
Must be zero.
const char* result OUT
The translated string.

Return Values

Result

  • A formatted string is returned in result.