libexplain/setenv.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/setenv.h>

Go to the source code of this file.

Functions
const char *	explain_setenv (const char *name, const char *value, int overwrite)

---

Function Documentation

const char* explain_setenv	(	const char *	name,
		const char *	value,
		int	overwrite
	)

The explain_setenv function is used to obtain an explanation of an error returned by the setenv(3) system call. The least the message will contain is the value of strerror(errno), but usually it will do much better, and indicate the underlying cause in more detail.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

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

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example:

This function is intended to be used in a fashion similar to the following example:

 if (setenv(name, value, overwrite) < 0)
 {
     fprintf(stderr, "%s\n", explain_setenv(name, value, overwrite));
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_setenv_or_die function.

Definition at line 25 of file setenv.c.