libexplain/statfs_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_statfs_on_error (const char *pathname, struct statfs *data)

---

Function Documentation

int explain_statfs_on_error	(	const char *	pathname,
		struct statfs *	data
	)

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

Parameters:

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

Returns:

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

Example:

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

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

Note:

The statfs system call is obsolete, it would be better to use the statvfs system call instead, possibly via the explain_statvfs_on_error function.

Definition at line 28 of file statfs_on_error.c.