Synesis Software

unixem/setenv.h

Go to the documentation of this file.
00001 /* /////////////////////////////////////////////////////////////////////////////
00002  * File:    unixem/setenv.h
00003  *
00004  * Purpose: Definition of the setenv() and unsetenv() functions.
00005  *
00006  * Created: 9th December 2005
00007  * Updated: 13th May 2008
00008  *
00009  * Home:    http://synesis.com.au/software/
00010  *
00011  * Copyright (c) 2005-2008, Matthew Wilson and Synesis Software
00012  * All rights reserved.
00013  *
00014  * Redistribution and use in source and binary forms, with or without 
00015  * modification, are permitted provided that the following conditions are met:
00016  *
00017  * - Redistributions of source code must retain the above copyright notice, this
00018  *   list of conditions and the following disclaimer. 
00019  * - Redistributions in binary form must reproduce the above copyright notice,
00020  *   this list of conditions and the following disclaimer in the documentation
00021  *   and/or other materials provided with the distribution.
00022  * - Neither the names of Matthew Wilson and Synesis Software nor the names of
00023  *   any contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00036  * POSSIBILITY OF SUCH DAMAGE.
00037  *
00038  * ////////////////////////////////////////////////////////////////////////// */
00039 
00040 
00044 #ifndef UNIXEM_INCL_UNIXEM_H_SETENV
00045 #define UNIXEM_INCL_UNIXEM_H_SETENV
00046 
00047 #ifndef UNIXEM_DOCUMENTATION_SKIP_SECTION
00048 # define UNIXEM_VER_UNIXEM_H_SETENV_MAJOR       1
00049 # define UNIXEM_VER_UNIXEM_H_SETENV_MINOR       0
00050 # define UNIXEM_VER_UNIXEM_H_SETENV_REVISION    2
00051 # define UNIXEM_VER_UNIXEM_H_SETENV_EDIT        4
00052 #endif /* !UNIXEM_DOCUMENTATION_SKIP_SECTION */
00053 
00054 /* /////////////////////////////////////////////////////////////////////////////
00055  * Includes
00056  */
00057 
00058 #include <unixem/unixem.h>
00059 #include <stddef.h>     /* for size_t */
00060 #include <sys/types.h>  /* for mode_t */
00061 
00062 #if defined(__WATCOMC__)
00063 # error The Watcom RTL provides setenv()
00064 #endif /* compiler */
00065 
00066 /* ////////////////////////////////////////////////////////////////////////// */
00067 
00078 /* ////////////////////////////////////////////////////////////////////////// */
00079 
00080 #ifndef _WIN32
00081 # error This file is only currently defined for compilation on Win32 systems
00082 #endif /* _WIN32 */
00083 
00084 /* /////////////////////////////////////////////////////////////////////////////
00085  * API functions
00086  */
00087 
00088 # ifdef __cplusplus
00089 extern "C" {
00090 # endif /* __cplusplus */
00091 
00103 int setenv(char const* name, char const* value, int bOverwrite);
00104 
00105 
00112 void unsetenv(char const* name);
00113 
00114 # ifdef __cplusplus
00115 } /* extern "C" */
00116 # endif /* __cplusplus */
00117 
00118 /* ////////////////////////////////////////////////////////////////////////// */
00119 
00122 /* ////////////////////////////////////////////////////////////////////////// */
00123 
00124 #endif /* UNIXEM_INCL_UNIXEM_H_SETENV */
00125 
00126 /* ////////////////////////////////////////////////////////////////////////// */

UNIX Emulation for Win32 Libraries documentation © Synesis Software Pty Ltd, 2002-2007