Nut/OS  4.10.3
API Reference
environ.h
Go to the documentation of this file.
00001 #ifndef SYS_ENVIRON_H_
00002 #define SYS_ENVIRON_H_
00003 
00004 /*
00005  * Copyright 2008 by egnite Software GmbH
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in the
00015  *    documentation and/or other materials provided with the distribution.
00016  * 3. Neither the name of the copyright holders nor the names of
00017  *    contributors may be used to endorse or promote products derived
00018  *    from this software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00024  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * For additional information see http://www.ethernut.de/
00034  */
00035 
00036 #include <cfg/eeprom.h>
00037 #include <sys/types.h>
00038 
00039 #ifndef ENVIRON_EE_OFFSET
00040 #define ENVIRON_EE_OFFSET       256
00041 #endif
00042 
00043 #ifndef MAX_ENVIRON_ITEM_SIZE
00044 #define MAX_ENVIRON_ITEM_SIZE   64
00045 #endif
00046 
00047 #define ENVIRON_MAGIC   0x00564E45
00048 
00049 typedef struct _NUTENVIRONMENT {
00050     struct _NUTENVIRONMENT *env_next;
00051     struct _NUTENVIRONMENT *env_prev;
00052     char *env_name;
00053     char *env_value;
00054 } NUTENVIRONMENT;
00055 
00056 extern NUTENVIRONMENT *nut_environ;
00057 
00058 extern NUTENVIRONMENT *findenv(CONST char *name);
00059 
00060 extern char *nextenv(CONST char *name);
00061 
00062 extern char *getenv(CONST char *name);
00063 #if defined (__AVR__)
00064 extern int setenv(CONST char *name, CONST char *value, int force);
00065 extern void unsetenv(CONST char *name);
00066 extern int putenv(CONST char *string);
00067 #endif
00068 
00069 #if defined (__CROSSWORKS_ARM)
00070 
00071 #include <cfg/crt.h>
00072 
00073 extern int setenv(CONST char *name, CONST char *value, int force);
00074 extern int putenv(char *string);
00075 
00076 #ifdef CRT_UNSETENV_POSIX
00077 extern int unsetenv(CONST char *name);
00078 #else
00079 extern void unsetenv(CONST char *name);
00080 #endif
00081 
00082 #endif /* (__CROSSWORKS_ARM) */
00083 
00084 #endif