libexplain/unsetenv_or_die.c File Reference

#include <libexplain/output.h>
#include <libexplain/unsetenv.h>

Go to the source code of this file.

Functions
void	explain_unsetenv_or_die (const char *name)

---

Function Documentation

void explain_unsetenv_or_die

(

const char *

name

)

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

Parameters:

name	The name, exactly as to be passed to the unsetenv(3) system call.

Returns:

This function only returns on success, see unsetenv(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:

 explain_unsetenv_or_die(name);

Definition at line 24 of file unsetenv_or_die.c.