libexplain/pathconf_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/unistd.h>
#include <libexplain/pathconf.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
long	explain_pathconf_on_error (const char *pathname, int name)

---

Function Documentation

long explain_pathconf_on_error	(	const char *	pathname,
		int	name
	)

The explain_pathconf_on_error function is used to call the pathconf(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_pathconf(3) function.

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

 long value = explain_pathconf_on_error(pathname, name);
 if (value < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

pathname	The pathname, exactly as to be passed to the pathconf(3) system call.
name	The name, exactly as to be passed to the pathconf(3) system call.

Returns:

The value returned by the wrapped pathconf(3) system call.

Definition at line 27 of file pathconf_on_error.c.