explain_ferror_or_die(3)

explain_ferror_or_die3

Check stream status and report errors

Usage

#include <libexplain/ferror.h>

void explain_ferror_or_die(FILE *fp);

Overview

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.

Releases

6 releases since Debian 7 (Wheezy); the text changed 1 time.

  1. 7
  2. 9–13

From libexplain-dev 1.4.D001-16 in Debian 13 (Trixie). Parsed by carta from the page's man source.