GATE
C/C++ Framework
|
Status, result and error code definitions. More...
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. |
Status, result and error code definitions.
#define GATE_RESULT_ERROR -32768 |
Undefined error class
#define GATE_RESULT_FAILED (GATE_RESULT_ERROR + 0x001) |
General failure, no detailed information
#define GATE_RESULT_CANCELED (GATE_RESULT_ERROR + 0x002) |
Operation was canceled (by user or logic)
#define GATE_RESULT_INVALIDARG (GATE_RESULT_ERROR + 0x003) |
An invalid argument or parameter was detected
#define GATE_RESULT_ACCESSDENIED (GATE_RESULT_ERROR + 0x004) |
Resource cannot be accessed in the current state
#define GATE_RESULT_PERMISSIONDENIED (GATE_RESULT_ERROR + 0x005) |
Resource cannot be accessed due to a permission problem
#define GATE_RESULT_NOTDEFINED (GATE_RESULT_ERROR + 0x006) |
Mandatory requirement was not defined
#define GATE_RESULT_NOTAVAILABLE (GATE_RESULT_ERROR + 0x007) |
Required resource is not available
#define GATE_RESULT_NOTIMPLEMENTED (GATE_RESULT_ERROR + 0x008) |
Required feature(s) is not implemented
#define GATE_RESULT_NOMATCH (GATE_RESULT_ERROR + 0x009) |
Search could not find a valid result
#define GATE_RESULT_NOTSUPPORTED (GATE_RESULT_ERROR + 0x00a) |
Specific operation configuration is not supported by the implementation
#define GATE_RESULT_NOTREQUIRED (GATE_RESULT_ERROR + 0x00b) |
Requested operation is not required, the target state has been already reached
#define GATE_RESULT_NOTREADY (GATE_RESULT_ERROR + 0x00c) |
Resource is not ready for the required operation
#define GATE_RESULT_SECURITYBREACH (GATE_RESULT_ERROR + 0x00d) |
Permission evaluation detected a security breach
#define GATE_RESULT_ALREADYEXISTS (GATE_RESULT_ERROR + 0x00e) |
Requested creation of resource failed, because the resource does already exist
#define GATE_RESULT_INVALIDSTATE (GATE_RESULT_ERROR + 0x00f) |
Target is in a state that cannot process the requested action
#define GATE_RESULT_OUTOFMEMORY (GATE_RESULT_ERROR + 0x021) |
Memory allocation or initialization failed
#define GATE_RESULT_OUTOFRESOURCES (GATE_RESULT_ERROR + 0x022) |
Required system resource could not be allocated/created/initialized
#define GATE_RESULT_OUTOFBOUNDS (GATE_RESULT_ERROR + 0x023) |
Access to an item outside the allowed range was rejected
#define GATE_RESULT_NULLPOINTER (GATE_RESULT_ERROR + 0x024) |
Null-pointer was detected where a valid pointer is required
#define GATE_RESULT_BADCAST (GATE_RESULT_ERROR + 0x025) |
Type case failed due to type incompatibility
#define GATE_RESULT_ARITHMETICERROR (GATE_RESULT_ERROR + 0x026) |
Calculation failed due to type/hardware/logical error
#define GATE_RESULT_OVERFLOW (GATE_RESULT_ERROR + 0x027) |
Numeric or resource overflow detected
#define GATE_RESULT_UNDERFLOW (GATE_RESULT_ERROR + 0x028) |
Numeric or resource underflow detected
#define GATE_RESULT_LOCKED (GATE_RESULT_ERROR + 0x029) |
Resource is locked and cannot be accessed
#define GATE_RESULT_TIMEOUT (GATE_RESULT_ERROR + 0x02a) |
Wait-timeout occured
#define GATE_RESULT_BADADDRESS (GATE_RESULT_ERROR + 0x02b) |
Bad address was detected
#define GATE_RESULT_BLOCKED (GATE_RESULT_ERROR + 0x02c) |
Blocking call was detected an canceled, as an immediate result was requested
#define GATE_RESULT_DEVICEERROR (GATE_RESULT_ERROR + 0x02d) |
System device error was detected
#define GATE_RESULT_EXECUTIONFAILED (GATE_RESULT_ERROR + 0x031) |
Task execution failed in general
#define GATE_RESULT_EXECUTIONINTERRUPTED (GATE_RESULT_ERROR + 0x032) |
Task execution was interrupted
#define GATE_RESULT_CRITICALERROR (GATE_RESULT_ERROR + 0x033) |
Critical internal error occured
#define GATE_RESULT_UNKNOWNEXCEPTION (GATE_RESULT_ERROR + 0x034) |
Unknown/unspecified exception state detected
#define GATE_RESULT_PRECONDITIONFAILED (GATE_RESULT_ERROR + 0x035) |
Required precondition was not fulfilled
#define GATE_RESULT_PREPARATIONFAILED (GATE_RESULT_ERROR + 0x036) |
Task preparation failed
#define GATE_RESULT_BADINSTRUCTION (GATE_RESULT_ERROR + 0x037) |
Invalid instruction detected
#define GATE_RESULT_INVALIDHEADER (GATE_RESULT_ERROR + 0x081) |
Data header is invalid
#define GATE_RESULT_INVALIDDATA (GATE_RESULT_ERROR + 0x082) |
Data is invalid in general
#define GATE_RESULT_INVALIDCONTENT (GATE_RESULT_ERROR + 0x083) |
Payload content is invalid
#define GATE_RESULT_INCORRECTSIZE (GATE_RESULT_ERROR + 0x084) |
A size or range parameter is invalid
#define GATE_RESULT_INCORRECTTYPE (GATE_RESULT_ERROR + 0x085) |
Incorrect data type detected
#define GATE_RESULT_ENDOFSTREAM (GATE_RESULT_ERROR + 0x086) |
Data resource has reached its current end-position
#define GATE_RESULT_INVALIDINPUT (GATE_RESULT_ERROR + 0x087) |
Given input data is invalid
#define GATE_RESULT_INVALIDOUTPUT (GATE_RESULT_ERROR + 0x088) |
Given output data is invalid
#define GATE_RESULT_BUFFERTOOSMALL (GATE_RESULT_ERROR + 0x089) |
Data buffer does not meet size requirements
#define GATE_RESULT_NODATA (GATE_RESULT_ERROR + 0x08a) |
No data available to access
#define GATE_RESULT_APPLICATIONERROR (GATE_RESULT_ERROR + 0x100) |
Internal application error occured
#define GATE_RESULT_LOGICALERROR (GATE_RESULT_ERROR + 0x101) |
Logical error condition detected
#define GATE_RESULT_USERERROR (GATE_RESULT_ERROR + 0x102) |
User input/interaction caused in error
#define GATE_RESULT_UNKNOWNERROR (GATE_RESULT_ERROR + 0xfff) |
Unknown/unexpected native error code detected
GATE_CORE_API char const * gate_result_text | ( | gate_result_t | resultcode | ) |
Returns a text representation of the given result code.
[in] | resultcode | GATE_RESULT_* code to be translated |
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.
[in] | resultcode | Pointer to root node |
[in] | message | Compare function to evalute key |