C API (Component Interface)
struct EventGetTypeString { UINT32 flags; TYPE type; char* buffer; UINT32 bufferSize; };

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.

Contract Wrappers



UINT32 flags IN
None defined (must be zero).
TYPE type IN
The type to translate.
char* buffer IN/OUT
A pointer to a buffer in which the result will be written.
UINT32 bufferSize IN/OUT
The total number of bytes available in the buffer (i.e. including space for the NUL character).

Return Values

  • C_OK
  • E_OVERFLOW=If the buffer is not large enough to hold the result (in this case, bufferSize is set to the required size of the buffer).
  • If the passed symbol is not recognised, this function writes to cerr and returns a formatted error message as the result, to aid in debugging.


  • A formatted string is returned in buffer or an error is raised.


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

C Source Code (against Component Interface)
inline std::string getTypeString(TYPE type) { char buffer[256]; EventGetTypeString data; data.flags = 0; data.type = type; data.buffer = buffer; data.bufferSize = 256; EngineEvent event; event.hCaller = 0; event.flags = 0; event.type = ENGINE_EVENT_GET_TYPE_STRING; event.data = (void*) &data; ____SUCCESS(brahms_engineEvent(&event)); return buffer; }