GATE
Loading...
Searching...
No Matches
results.h File Reference

Status, result and error code definitions. More...

#include "gate/gate_core_api.h"
#include "gate/gatetypes.h"

Functions

GATE_CORE_API char const * gate_result_text (gate_result_t resultcode)
 Returns a text representation of the given result code.
 
GATE_CORE_API void gate_panic (gate_result_t resultcode, char const *message)
 Logs the given fatal error code and message and immediately stops the running process.
 

Detailed Description

Status, result and error code definitions.

Function Documentation

◆ gate_result_text()

GATE_CORE_API char const * gate_result_text ( gate_result_t resultcode)

Returns a text representation of the given result code.

Parameters
[in]resultcodeGATE_RESULT_* code to be translated
Returns
Pointer to static text representing the given result code

◆ gate_panic()

GATE_CORE_API void gate_panic ( gate_result_t resultcode,
char const * message )

Logs the given fatal error code and message and immediately stops the running process.

Parameters
[in]resultcodePointer to root node
[in]messageCompare function to evalute key
Returns
This function does not return and exits the running process