libexplain/message/setenv.c File Reference

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

Go to the source code of this file.

Functions
void	explain_message_setenv (char *message, int message_size, const char *name, const char *value, int overwrite)

---

Function Documentation

void explain_message_setenv	(	char *	message,
		int	message_size,
		const char *	name,
		const char *	value,
		int	overwrite
	)

The explain_message_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(errnum), 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:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
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.

Example:

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

 if (setenv(name, value, overwrite) < 0)
 {
     char message[3000];
     explain_message_setenv(message, sizeof(message), name, value,
         overwrite);
     fprintf(stderr, "%s\n", message);
     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.