libexplain/symlink_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_symlink_on_error (const char *oldpath, const char *newpath)

---

Function Documentation

int explain_symlink_on_error	(	const char *	oldpath,
		const char *	newpath
	)

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

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

 if (explain_symlink_on_error(oldpath, newpath) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

oldpath	The oldpath, exactly as to be passed to the symlink(2) system call.
newpath	The newpath, exactly as to be passed to the symlink(2) system call.

Returns:

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

Definition at line 27 of file symlink_on_error.c.