libexplain/ferror_or_die.c File Reference

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

Go to the source code of this file.

Functions
int	explain_ferror_on_error (FILE *fp)
void	explain_ferror_or_die (FILE *fp)

---

Function Documentation

int explain_ferror_on_error

(

FILE *

fp

)

The explain_ferror_on_error function is used to call the ferror(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_ferror(3) function.

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

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

Parameters:

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

Returns:

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

Definition at line 27 of file ferror_or_die.c.

void explain_ferror_or_die

(

FILE *

fp

)

The explain_ferror_or_die function is used to call the ferror(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_ferror(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

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

 explain_ferror_or_die(fp);

Parameters:

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

Returns:

This function only returns on success. On failure, prints an explanation and exits, it does not return.

Definition at line 45 of file ferror_or_die.c.