Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
explain_setenv_or_die(3)    Library Functions Manual	explain_setenv_or_die(3)

NAME
     explain_setenv_or_die  -  change  or add an environment variable and report
     errors

SYNOPSIS
     #include <libexplain/setenv.h>
     void explain_setenv_or_die(const char *name, const char *value,  int  over-
     write);
     int  explain_setenv_on_error(const char *name, const char *value, int over-
     write);

DESCRIPTION
     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).

     The  explain_setenv_on_error  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, but still returns to the caller.

     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.

RETURN VALUE
     The explain_setenv_or_die function only returns on success,  see  setenv(3)
     for  more information. On failure, prints an explanation and exits, it does
     not return.

     The explain_setenv_on_error function always returns the value return by the
     wrapped setenv(3) system call.

EXAMPLE
     The explain_setenv_or_die function is intended to be used in a fashion sim-
     ilar to the following example:
	    explain_setenv_or_die(name, value, overwrite);

SEE ALSO
     setenv(3)
	     change or add an environment variable

     explain_setenv(3)
	     explain setenv(3) errors

     exit(2)
	     terminate the calling process

COPYRIGHT
     libexplain version 1.3
     Copyright (C) 2010 Peter Miller

							explain_setenv_or_die(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=explain_setenv_or_die&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help