libexplain/pread_on_error.c File Reference

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

Go to the source code of this file.

Functions
ssize_t	explain_pread_on_error (int fildes, void *data, size_t data_size, off_t offset)

---

Function Documentation

ssize_t explain_pread_on_error	(	int	fildes,
		void *	data,
		size_t	data_size,
		off_t	offset
	)

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

Parameters:

fildes	The fildes, exactly as to be passed to the pread(2) system call.
data	The data, exactly as to be passed to the pread(2) system call.
data_size	The data_size, exactly as to be passed to the pread(2) system call.
offset	The offset, exactly as to be passed to the pread(2) system call.

Returns:

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

Example:

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

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

Definition at line 27 of file pread_on_error.c.