libexplain/setbuffer_on_error.c File Reference

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

Go to the source code of this file.

Functions
void	explain_setbuffer_on_error (FILE *fp, char *data, size_t size)

---

Function Documentation

void explain_setbuffer_on_error	(	FILE *	fp,
		char *	data,
		size_t	size
	)

The explain_setbuffer_on_error function is used to call the setbuffer(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_setbuffer(3) function.

Parameters:

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

Returns:

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

Example:

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

 void result = explain_setbuffer_on_error(fp, data, size);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file setbuffer_on_error.c.