explain_ferror_or_die man page

explain_ferror_or_die — check stream status and report errors

Synopsis

#include <libexplain/ferror.h>

void explain_ferror_or_die(FILE *fp);

Description

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 explain_ferror(3), 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);

It is essential that this function cal be placed as close as possible to the I/O code that has caused the problem, otherwise intervening code could have altered the errno global variable.

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.

See Also

ferror(3)

check stream status

explain_ferror(3)

explain ferror(3) errors

exit(2)

terminate the calling process

Referenced By

explain(3), explain_ferror(3).