explain_fread_or_die(3)

explain_fread_or_die3

Binary stream input and report errors

Usage

#include <libexplain/fread.h>

void explain_fread_or_die(void *ptr, size_t size, size_t nmemb, FILE *fp);

Overview

The explain_fread_or_die function is used to call the fread(3) system call. On failure an explanation will be printed to stderr, obtained from explain_fread(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:

size_t how_many = explain_fread_or_die(ptr, size, nmemb, fp);
ptr

The ptr, exactly as to be passed to the fread(3) system call.

size

The size, exactly as to be passed to the fread(3) system call.

nmemb

The nmemb, exactly as to be passed to the fread(3) system call.

fp

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

Returns:

This function only returns on success, the number read or 0 on end‐of‐input. 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.