libexplain/setvbuf_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdio.h>
#include <libexplain/setvbuf.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
int	explain_setvbuf_on_error (FILE *fp, char *data, int mode, size_t size)

---

Function Documentation

int explain_setvbuf_on_error	(	FILE *	fp,
		char *	data,
		int	mode,
		size_t	size
	)

The explain_setvbuf_on_error function is used to call the setvbuf(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_setvbuf(3) function.

Parameters:

fp	The fp, exactly as to be passed to the setvbuf(3) system call.
data	The data, exactly as to be passed to the setvbuf(3) system call.
mode	The mode, exactly as to be passed to the setvbuf(3) system call.
size	The size, exactly as to be passed to the setvbuf(3) system call.

Returns:

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

Example:

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

 if (explain_setvbuf_on_error(fp, data, mode, size) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file setvbuf_on_error.c.