libexplain/setbuf_on_error.c File Reference

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

Go to the source code of this file.

Functions
void	explain_setbuf_on_error (FILE *fp, char *data)

---

Function Documentation

void explain_setbuf_on_error	(	FILE *	fp,
		char *	data
	)

The explain_setbuf_on_error function is used to call the setbuf(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_setbuf(3) function.

Parameters:

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

Returns:

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

Example:

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

 errno = 0;
 void result = explain_setbuf_on_error(fp, data);
 if (result < 0 && errno != 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file setbuf_on_error.c.