Overview
C API (Component Interface)
struct EventGetSymbolString { UINT32 flags; Symbol symbol; const char* result; };

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.

Fields

UINT32 flags IN
None defined (must be zero).
Symbol symbol IN
The symbol to translate.
const char* result OUT
The translated string.

Return Values

Result

  • A formatted string is returned in result.

Example

Taken from 1199. Note that this event can be called with hCaller set to zero.

C Source Code (against Component Interface)
inline char* getSymbolString(Symbol symbol) { EventGetSymbolString gss; gss.symbol = symbol; gss.flags = 0; gss.result = NULL; EngineEvent event; event.hCaller = 0; event.flags = 0; event.type = ENGINE_EVENT_GET_SYMBOL_STRING; event.data = (void*) &gss; Symbol result = brahms_engineEvent(&event); if (S_ERROR(result)) throw result; return gss.result; }