libexplain/fstat_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_fstat_on_error (int fildes, struct stat *data)

---

Function Documentation

int explain_fstat_on_error	(	int	fildes,
		struct stat *	data
	)

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

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

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

Parameters:

fildes	The fildes, exactly as to be passed to the fstat(2) system call.
data	The data, exactly as to be passed to the fstat(2) system call.

Returns:

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

Definition at line 27 of file fstat_on_error.c.