Classes | |
struct | ERRORTYPEREGISTRATIONFORM |
Initialization | |
CHIPCARD_API void | Error_ModuleInit () |
CHIPCARD_API void | Error_ModuleFini () |
Error Type Registration | |
These functions are used to allocate error types. Each module should allocate a type to allow descriptive error messages. Since function pointers are involved you should carefully register and unregister the error types. | |
CHIPCARD_API int | Error_RegisterType (ERRORTYPEREGISTRATIONFORM *tptr) |
CHIPCARD_API int | Error_UnregisterType (ERRORTYPEREGISTRATIONFORM *tptr) |
Error Type Lookup | |
These functions lookup error types by name or by number. | |
CHIPCARD_API int | Error_FindType (const char *name) |
CHIPCARD_API const char * | Error_GetTypename (int t) |
Getters And Setters | |
These functions get and set parts of an ERRORCODE. | |
CHIPCARD_API ERRORCODE | Error_New (int iscustom, int severity, int typ, int code) |
CHIPCARD_API int | Error_IsOk (ERRORCODE c) |
CHIPCARD_API int | Error_GetSeverity (ERRORCODE c) |
CHIPCARD_API void | Error_SetSeverity (ERRORCODE *c, int v) |
CHIPCARD_API int | Error_IsCustom (ERRORCODE c) |
CHIPCARD_API void | Error_SetIsCustom (ERRORCODE *c, int iscustom) |
CHIPCARD_API int | Error_GetType (ERRORCODE c) |
CHIPCARD_API void | Error_SetType (ERRORCODE *c, int v) |
CHIPCARD_API int | Error_GetCode (ERRORCODE c) |
CHIPCARD_API void | Error_SetCode (ERRORCODE *c, int v) |
Verbosity | |
Composing error messages. | |
CHIPCARD_API int | Error_ToString (ERRORCODE c, char *buffer, int bsize) |
Defines | |
#define | ERROR_SEVERITY_DEBUG 0 |
#define | ERROR_SEVERITY_INFO 1 |
#define | ERROR_SEVERITY_WARN 2 |
#define | ERROR_SEVERITY_ERR 3 |
#define | ERROR_TYPE_ERROR 0 |
#define | ERROR_UNSPECIFIED 1 |
#define | ERROR_COULD_NOT_REGISTER 2 |
#define | ERROR_COULD_NOT_UNREGISTER 3 |
#define | ERROR_INVALID_BUFFERSIZE 4 |
Variables | |
CHIPCARD_API typedef const char *(* | ERRORMESSAGEPTR )(int c) |
CHIPCARD_API typedef unsigned long | ERRORCODE |
|
|
|
|
|
|
|
The error code is a debug level code. |
|
The error code is a error level code. |
|
The error code is a information level code. |
|
The error code is a warning level code. |
|
This class is used for ERROR-related errors ;-) |
|
|
|
This function returns the type number for the given type name.
|
|
Returns the 16 bit error code value. |
|
Returns the severity of the error |
|
Returns the error type. |
|
Returns the name of the type referenced by the its type number. This function is used when composing a human readable error string.
|
|
Checks whether this is a custom error code (which means that the error type and code has to be handled differently. Such a code might be used in programs).
|
|
Checks whether the code really contains an error. If it contains a debug/info/warn code then it will be treaten as "ok".
|
|
Deinitializes this module. |
|
Initializes this module. |
|
Creates an error code based on the arguments given
|
|
Register an error type. This function is called by other modules to register a unique type value for itself.
|
|
Sets the error code. |
|
Sets the custom flag. |
|
Sets the severity level. |
|
Sets the error type. |
|
Composes a human readable error string which dumps all parts of an ERRORCODE.
|
|
When removing a module it should always unregister its assigned error type to avoid segfaultes (due to pointers pointing to nowhere).
|
|
An error code is 32 bits long and has the following bit format:
|
|
A function of this type returns a descriptive string for the given error. So it is supposed to translate a 16 bit error value into a human readable text (please note that this code is PART of a ERRORCODE, not the whole ERRORCODE itself !). |