libexplain/message/link.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/link.h>

Go to the source code of this file.

Functions
void	explain_message_link (char *message, int message_size, const char *oldpath, const char *newpath)

---

Function Documentation

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

The explain_message_link function is used to obtain an explanation of an error returned by the link(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 (link(oldpath, newpath) < 0)
 {
     char message[3000];
     explain_message_link(message, sizeof(message), oldpath, newpath);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

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

Parameters:

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.
oldpath	The original oldpath, exactly as passed to the link(2) system call.
newpath	The original newpath, exactly as passed to the link(2) system call.

Definition at line 26 of file link.c.