libexplain  1.4.D001
Functions
libexplain/message/unlink.c File Reference
#include <libexplain/ac/errno.h>
#include <libexplain/unlink.h>

Go to the source code of this file.

Functions

void explain_message_unlink (char *message, int message_size, const char *pathname)

Function Documentation

void explain_message_unlink ( char *  message,
int  message_size,
const char *  pathname 
)

The explain_message_unlink function is used to obtain an explanation of an error returned by the unlink(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.

The errno global variable will be used to obtain the error value to be decoded.

This function is intended to be used in a fashion similar to the following example:

 if (unlink(pathname) < 0)
 {
     char message[3000];
     explain_message_unlink(message, sizeof(message), pathname);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_unlink_or_die function.

Parameters:
messageThe location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_sizeThe size in bytes of the location in which to store the returned message.
pathnameThe original pathname, exactly as passed to the unlink(2) system call.

Definition at line 26 of file unlink.c.