Overview
C API (Core)
struct GetSymbolString { Symbol symbol; UINT32 flags; const char* result; }; Symbol brahms_getSymbolString(GetSymbolString* data);

Get a string that specifies what is represented by symbol. This is most useful for converting result codes into human-readable strings, but can also aid in debugging by clarifying to the developer what any symbol 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

Symbol symbol IN
The symbol 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.