libexplain  1.4.D001
Functions
libexplain/calloc_or_die.c File Reference
#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdlib.h>
#include <libexplain/calloc.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions

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

Function Documentation

void* explain_calloc_on_error ( size_t  nmemb,
size_t  size 
)

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.

Parameters:
nmembThe nmemb, exactly as to be passed to the calloc(3) system call.
sizeThe size, exactly as to be passed to the calloc(3) system call.
Returns:
The value returned by the wrapped calloc(3) system call.
Example:
This function is intended to be used in a fashion similar to the following example:
 errno = 0;
 void *result = explain_calloc_on_error(nmemb, size);
 if (!result && errno != 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 41 of file calloc_or_die.c.

void* explain_calloc_or_die ( size_t  nmemb,
size_t  size 
)

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).

Parameters:
nmembThe nmemb, exactly as to be passed to the calloc(3) system call.
sizeThe size, exactly as to be passed to the calloc(3) system call.
Returns:
This function only returns on success, see calloc(3) for more information. On failure, prints an explanation and exits, it does not return.
Example:
This function is intended to be used in a fashion similar to the following example:
 void *result = explain_calloc_or_die(nmemb, size);

Definition at line 27 of file calloc_or_die.c.