Overview
C API (Component Interface)
struct EventGetTypeString { UINT32 flags; TYPE type; const char* result; };

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.

Fields

UINT32 flags IN
None defined (must be zero).
TYPE type IN
The type 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 const char* getElementTypeString(TYPE type) { EventGetTypeString gets; gets.flags = 0; gets.type = type; gets.result = NULL; EngineEvent event; event.hCaller = 0; event.flags = 0; event.type = ENGINE_EVENT_GET_TYPE_STRING; event.data = (void*) &gets; Symbol result = brahms_engineEvent(&event); if (S_ERROR(result)) throw result; return gets.result; }