What do you consider ‘best practice’ when it comes to error handling errors in a consistent way in a C library.
There are two ways I’ve been thinking of:
Always return error code. A typical function would look like this:
MYAPI_ERROR getObjectSize(MYAPIHandle h, int* returnedSize); The always provide an error pointer approach:
int getObjectSize(MYAPIHandle h, MYAPI_ERROR* returnedError); When using the first approach it’s possible to write code like this where the error handling check is directly placed on the function call:
int size; if(getObjectSize(h, &size) != MYAPI_SUCCESS) { // Error handling } Which looks better than the error handling code here.
MYAPIError error; int size; size = getObjectSize(h, &error); if(error != MYAPI_SUCCESS) { // Error handling } However, I think using the return value for returning data makes the code more readable, It’s obvious that something was written to the size variable in the second example.
Do you have any ideas on why I should prefer any of those approaches or perhaps mix them or use something else? I’m not a fan of global error states since it tends to make multi threaded use of the library way more painful.
EDIT: C++ specific ideas on this would also be interesting to hear about as long as they are not involving exceptions since it’s not an option for me at the moment…
I like the error as return-value way. If you’re designing the api and you want to make use of your library as painless as possible think about these additions:
store all possible error-states in one typedef’ed enum and use it in your lib. Don’t just return ints or even worse, mix ints or different enumerations with return-codes.
provide a function that converts errors into something human readable. Can be simple. Just error-enum in, const char* out.
I know this idea makes multithreaded use a bit difficult, but it would be nice if application programmer can set an global error-callback. That way they will be able to put a breakpoint into the callback during bug-hunt sessions.