libexplain
1.4.D001
|
#include <libexplain/buffer/errno/open.h>
#include <libexplain/open.h>
#include <libexplain/string_buffer.h>
Go to the source code of this file.
Functions | |
void | explain_message_errno_open (char *message, int message_size, int errnum, const char *path, int flags, int mode) |
void explain_message_errno_open | ( | char * | message, |
int | message_size, | ||
int | errnum, | ||
const char * | pathname, | ||
int | flags, | ||
int | mode | ||
) |
The explain_message_errno_open function is used to obtain an explanation of an error returned by the open(2) system call. The least the message will contain is the value of strerror(errnum)
, but usually it will do much better, and indicate the underlying cause in more detail.
This function is intended to be used in a fashion similar to the following example:
int fildes = open(pathname, flags, mode); if (fildes < 0) { int err = errno; char message[3000]; explain_message_errno_open(message, sizeof(message), err, pathname,s flags, mode); fprintf(stderr, "%s\n", message); exit(EXIT_FAILURE); }
The above code example is available pre-packaged as the explain_open_or_die function.
message | The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe. |
message_size | The size in bytes of the location in which to store the returned message. |
errnum | The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno. |
pathname | The original pathname, exactly as passed to the open(2) system call. |
flags | The original flags, exactly as passed to the open(2) system call. |
mode | The original mode, exactly as passed to the open(2) system call. |