1explain_calloc_or_die(3) Library Functions Manual explain_calloc_or_die(3)
2
3
4
6 explain_calloc_or_die - Allocate and clear memory and report errors
7
9 #include <libexplain/calloc.h>
10 void *explain_calloc_or_die(size_t nmemb, size_t size);
11 void *explain_calloc_on_error(size_t nmemb, size_t size);
12
14 The explain_calloc_or_die function is used to call the calloc(3) system
15 call. On failure an explanation will be printed to stderr, obtained
16 from the explain_calloc(3) function, and then the process terminates by
17 calling exit(EXIT_FAILURE).
18
19 The explain_calloc_on_error function is used to call the calloc(3) sys‐
20 tem call. On failure an explanation will be printed to stderr, obtained
21 from the explain_calloc(3) function, but still returns to the caller.
22
23 nmemb The nmemb, exactly as to be passed to the calloc(3) system
24 call.
25
26 size The size, exactly as to be passed to the calloc(3) system call.
27
29 The explain_calloc_or_die function only returns on success, see cal‐
30 loc(3) for more information. On failure, prints an explanation and
31 exits, it does not return.
32
33 The explain_calloc_on_error function always returns the value return by
34 the wrapped calloc(3) system call.
35
37 The explain_calloc_or_die function is intended to be used in a fashion
38 similar to the following example:
39 void *result = explain_calloc_or_die(nmemb, size);
40
42 calloc(3)
43 Allocate and clear memory
44
45 explain_calloc(3)
46 explain calloc(3) errors
47
48 exit(2) terminate the calling process
49
51 libexplain version 1.4
52 Copyright (C) 2010 Peter Miller
53
54
55
56 explain_calloc_or_die(3)