libexplain/stat_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_stat_on_error (const char *pathname, struct stat *data)

---

Function Documentation

int explain_stat_on_error	(	const char *	pathname,
		struct stat *	data
	)

The explain_stat_on_error function is used to call the stat(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_stat(3) function.

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

 if (explain_stat_on_error(pathname, data) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

pathname	The pathname, exactly as to be passed to the stat(2) system call.
data	The data, exactly as to be passed to the stat(2) system call.

Returns:

The value returned by the wrapped stat(2) system call.

Definition at line 27 of file stat_on_error.c.