libexplain/fputs_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_fputs_on_error (const char *s, FILE *fp)

---

Function Documentation

int explain_fputs_on_error	(	const char *	s,
		FILE *	fp
	)

The explain_fputs_on_error function is used to call the fputs(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fputs(3) function.

Parameters:

s	The s, exactly as to be passed to the fputs(3) system call.
fp	The fp, exactly as to be passed to the fputs(3) system call.

Returns:

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

Example:

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

 if (explain_fputs_on_error(s, fp) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file fputs_on_error.c.