libexplain/truncate_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_truncate_on_error (const char *pathname, off_t length)

---

Function Documentation

int explain_truncate_on_error	(	const char *	pathname,
		off_t	length
	)

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

Parameters:

pathname	The pathname, exactly as to be passed to the truncate(2) system call.
length	The length, exactly as to be passed to the truncate(2) system call.

Returns:

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

Example:

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

 if (explain_truncate_on_error(pathname, length) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file truncate_on_error.c.