libexplain/lseek_on_error.c File Reference

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

Go to the source code of this file.

Functions
off_t	explain_lseek_on_error (int fildes, off_t offset, int whence)

---

Function Documentation

off_t explain_lseek_on_error	(	int	fildes,
		off_t	offset,
		int	whence
	)

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

Parameters:

fildes	The fildes, exactly as to be passed to the lseek(2) system call.
offset	The offset, exactly as to be passed to the lseek(2) system call.
whence	The whence, exactly as to be passed to the lseek(2) system call.

Returns:

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

Example:

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

 off_t result = explain_lseek_on_error(fildes, offset, whence);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file lseek_on_error.c.