libexplain/getc_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_getc_on_error (FILE *fp)

---

Function Documentation

int explain_getc_on_error

(

FILE *

fp

)

The explain_getc_on_error function is used to call the getc(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_getc(3) function.

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

 int c = explain_getc_on_error(fp);
 if (c == EOF)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

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

Returns:

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

Definition at line 27 of file getc_on_error.c.