libexplain/getchar_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_getchar_on_error (void)

---

Function Documentation

int explain_getchar_on_error

(

void

)

The explain_getchar_on_error function is used to call the getchar(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_getchar(3) function.

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

 int c = explain_getchar_on_error();
 if (c == EOF && ferror(stdin))
 {
     ...cope with error
     ...no need to print error message
 }

Returns:

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

Definition at line 27 of file getchar_on_error.c.