explain_calloc_or_die(3)

explain_calloc_or_die3

Allocate and clear memory and report errors

Usage

#include <libexplain/calloc.h>

void *explain_calloc_or_die(size_t nmemb, size_t size);
void *explain_calloc_on_error(size_t nmemb, size_t size);

Overview

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

The explain_calloc_on_error function is used to call the calloc(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_calloc(3) function, but still returns to the caller.

nmemb

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

size

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

Return value

The explain_calloc_or_die function only returns on success, see calloc(3) for more information. On failure, prints an explanation and exits, it does not return.

The explain_calloc_on_error function always returns the value return by the wrapped calloc(3) system call.

Examples

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

void *result = explain_calloc_or_die(nmemb, size);

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.