libexplain/message/stat.c File Reference

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

Go to the source code of this file.

Functions
void	explain_message_stat (char *message, int message_size, const char *pathname, const struct stat *data)

---

Function Documentation

void explain_message_stat	(	char *	message,
		int	message_size,
		const char *	pathname,
		const struct stat *	data
	)

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

The above code example is available pre-packaged as the explain_stat_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.
pathname	The original pathname, exactly as passed to the stat(2) system call.
data	The original data, exactly as passed to the stat(2) system call.

Definition at line 26 of file stat.c.