Overview
C API (Core)
struct ErrorMessage { Symbol error; const char* msg; UINT32 flags; }; Symbol brahms_errorMessage(ErrorMessage* data);

Attach an error message to the passed symbol. A new symbol is returned that has the error message attached. You can call the function as many times as required. Call this to add additional information (even a primary error message) to an error code before returning it to the framework from the Event Handler function. flags should be zero or F_TRACE.

Arguments

Symbol error IN
An error code (initially, E_USER; on subsequent calls, the return code from this function).
const char* msg IN
The message to attach to the error.
UINT32 flags IN
See below.

Return Values

See also General API Return Values.

Notes
  • There is no need to check the return value before returning it to the framework, however, since only error codes can be returned from this function, whether it succeeds or not.
  • The new symbol representing the error with the message attached. The old symbol can be discarded.

Flags

F_TRACE
Associated message should be added as a trace message rather than an error message.
F_DEVTRACE
Associated message should be added as a developer trace message rather than an error message (these are hidden unless the user explicitly asks for them).