libexplain/putenv_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdlib.h>
#include <libexplain/putenv.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
int	explain_putenv_on_error (char *string)

---

Function Documentation

int explain_putenv_on_error

(

char *

string

)

The explain_putenv_on_error function is used to call the putenv(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_putenv(3) function.

Parameters:

string

The string, exactly as to be passed to the putenv(3) system call.

Returns:

The value returned by the wrapped putenv(3) system call.

Example:

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

 if (explain_putenv_on_error(string) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file putenv_on_error.c.