1explain_putenv_or_die(3) Library Functions Manual explain_putenv_or_die(3)
2
3
4
6 explain_putenv_or_die - change or add an environment variable and
7 report errors
8
10 #include <libexplain/putenv.h>
11 void explain_putenv_or_die(char *string);
12 int explain_putenv_on_error(char *string);
13
15 The explain_putenv_or_die function is used to call the putenv(3) system
16 call. On failure an explanation will be printed to stderr, obtained
17 from the explain_putenv(3) function, and then the process terminates by
18 calling exit(EXIT_FAILURE).
19
20 The explain_putenv_on_error function is used to call the putenv(3) sys‐
21 tem call. On failure an explanation will be printed to stderr, obtained
22 from the explain_putenv(3) function, but still returns to the caller.
23
24 string The string, exactly as to be passed to the putenv(3) system
25 call.
26
28 The explain_putenv_or_die function only returns on success, see
29 putenv(3) for more information. On failure, prints an explanation and
30 exits, it does not return.
31
32 The explain_putenv_on_error function always returns the value return by
33 the wrapped putenv(3) system call.
34
36 The explain_putenv_or_die function is intended to be used in a fashion
37 similar to the following example:
38 explain_putenv_or_die(string);
39
41 putenv(3)
42 change or add an environment variable
43
44 explain_putenv(3)
45 explain putenv(3) errors
46
47 exit(2) terminate the calling process
48
50 libexplain version 1.4
51 Copyright (C) 2010 Peter Miller
52
53
54
55 explain_putenv_or_die(3)