libexplain  1.4.D001
Functions
libexplain/message/errno/rename.c File Reference
#include <libexplain/buffer/errno/rename.h>
#include <libexplain/rename.h>
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions

void explain_message_errno_rename (char *message, int message_size, int errnum, const char *oldpath, const char *newpath)

Function Documentation

void explain_message_errno_rename ( char *  message,
int  message_size,
int  errnum,
const char *  oldpath,
const char *  newpath 
)

The explain_message_errno_rename function is used to obtain an explanation of an error returned by the rename(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:

 if (rename(oldpath, newpath) < 0)
 {
     int err = errno;
     char message[3000];
     explain_message_errno_rename(message, sizeof(message), err, oldpath,
         newpath);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_rename_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.
errnumThe 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.
oldpathThe original oldpath, exactly as passed to the rename(2) system call.
newpathThe original newpath, exactly as passed to the rename(2) system call.

Definition at line 26 of file rename.c.