libexplain/ungetc_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_ungetc_on_error (int c, FILE *fp)

---

Function Documentation

int explain_ungetc_on_error	(	int	c,
		FILE *	fp
	)

The explain_ungetc_on_error function is used to call the ungetc(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_ungetc(3) function.

Parameters:

c	The c, exactly as to be passed to the ungetc(3) system call.
fp	The fp, exactly as to be passed to the ungetc(3) system call.

Returns:

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

Example:

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

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

Definition at line 27 of file ungetc_on_error.c.