libexplain/realpath_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdlib.h>
#include <libexplain/output.h>
#include <libexplain/realpath.h>

Go to the source code of this file.

Functions
char *	explain_realpath_or_die (const char *pathname, char *resolved_pathname)
char *	explain_realpath_on_error (const char *pathname, char *resolved_pathname)

---

Function Documentation

char* explain_realpath_on_error	(	const char *	pathname,
		char *	resolved_pathname
	)

The explain_realpath_on_error function is used to call the realpath(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_realpath(3) function.

Parameters:

pathname	The pathname, exactly as to be passed to the realpath(3) system call.
resolved_pathname	The resolved_pathname, exactly as to be passed to the realpath(3) system call.

Returns:

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

Example:

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

 char *result = explain_realpath_on_error(pathname, resolved_pathname);
 if (!result)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 41 of file realpath_or_die.c.

char* explain_realpath_or_die	(	const char *	pathname,
		char *	resolved_pathname
	)

The explain_realpath_or_die function is used to call the realpath(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_realpath(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

Parameters:

pathname	The pathname, exactly as to be passed to the realpath(3) system call.
resolved_pathname	The resolved_pathname, exactly as to be passed to the realpath(3) system call.

Returns:

This function only returns on success, see realpath(3) for more information. On failure, prints an explanation and exits, it does not return.

Example:

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

 char *result = explain_realpath_or_die(pathname, resolved_pathname);

Definition at line 27 of file realpath_or_die.c.