libexplain/readlink_on_error.c File Reference

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

Go to the source code of this file.

Functions
ssize_t	explain_readlink_on_error (const char *pathname, char *data, size_t data_size)

---

Function Documentation

ssize_t explain_readlink_on_error	(	const char *	pathname,
		char *	data,
		size_t	data_size
	)

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

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

 ssize_t result = explain_readlink_on_error(pathname, data, data_size);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

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

Returns:

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

Definition at line 27 of file readlink_on_error.c.