libexplain/setenv_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_setenv_or_die (const char *name, const char *value, int overwrite)

---

Function Documentation

void explain_setenv_or_die	(	const char *	name,
		const char *	value,
		int	overwrite
	)

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

Parameters:

name	The name, exactly as to be passed to the setenv(3) system call.
value	The value, exactly as to be passed to the setenv(3) system call.
overwrite	The overwrite, exactly as to be passed to the setenv(3) system call.

Returns:

This function only returns on success, see setenv(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_setenv_or_die(name, value, overwrite);

Definition at line 24 of file setenv_or_die.c.