/builddir/build/BUILD/qpid-proton-0.14.0/proton-c/include/proton/error.h File Reference
#include <proton/import_export.h>
#include <stdarg.h>
Go to the source code of this file.
Define Documentation
#define PN_INPROGRESS (-9) |
#define PN_OUT_OF_MEMORY (-10) |
#define PN_RETURN_IF_ERROR |
( |
x |
|
) |
|
Value:do {\
int r = (x);\
if (r < 0) return r; \
} while (0)
#define PN_STATE_ERR (-5) |
#define PN_UNDERFLOW (-4) |
Typedef Documentation
A pn_error_t has an int error `code` and some string `text` to describe the error.
Function Documentation
PN_EXTERN const char* pn_code |
( |
int |
code |
) |
|
- Returns:
- name of the error code. Returned pointer is to a static constant, do not delete.
PN_EXTERN void pn_error_clear |
( |
pn_error_t * |
error |
) |
|
Reset the error to a "no error" state with code == 0.
PN_EXTERN int pn_error_code |
( |
pn_error_t * |
error |
) |
|
PN_EXTERN int pn_error_format |
( |
pn_error_t * |
error, |
|
|
int |
code, |
|
|
const char * |
fmt, |
|
|
|
... | |
|
) |
| | |
Set the code and set the text using a printf-style formatted string.
PN_EXTERN void pn_error_free |
( |
pn_error_t * |
error |
) |
|
PN_EXTERN int pn_error_set |
( |
pn_error_t * |
error, |
|
|
int |
code, |
|
|
const char * |
text | |
|
) |
| | |
Set the error code and text.
Makes a copy of text.
PN_EXTERN const char* pn_error_text |
( |
pn_error_t * |
error |
) |
|
- Returns:
- the error text. Returned pointer is owned by the pn_error_t.
PN_EXTERN int pn_error_vformat |
( |
pn_error_t * |
error, |
|
|
int |
code, |
|
|
const char * |
fmt, |
|
|
va_list |
ap | |
|
) |
| | |
Set the code and set the text using a printf-style formatted string.