(strfry): It's not even worth documenting...
[kopensolaris-gnu/glibc.git] / string / envz.h
index 55224c7..3542ded 100644 (file)
@@ -1,25 +1,26 @@
 /* Routines for dealing with '\0' separated environment vectors
+   Copyright (C) 1995, 96, 98, 99, 2000 Free Software Foundation, Inc.
+   This file is part of the GNU C Library.
 
-   Copyright (C) 1995 Free Software Foundation, Inc.
+   The GNU C Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
 
-   Written by Miles Bader <miles@gnu.ai.mit.edu>
-
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2, or (at
-   your option) any later version.
-
-   This program is distributed in the hope that it will be useful, but
-   WITHOUT ANY WARRANTY; without even the implied warranty of
+   The GNU C Library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   General Public License for more details.
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, write to the Free
+   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+   02111-1307 USA.  */
 
-   You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
+#ifndef _ENVZ_H
+#define _ENVZ_H        1
 
-#ifndef __ENVZ_H__
-#define __ENVZ_H__
+#include <features.h>
 
 #include <errno.h>
 
    routines.  */
 #include <argz.h>
 
+__BEGIN_DECLS
+
 /* Returns a pointer to the entry in ENVZ for NAME, or 0 if there is none.  */
-char *envz_entry (char *envz, unsigned envz_len, char *name);
+extern char *envz_entry (__const char *__restrict __envz, size_t __envz_len,
+                        __const char *__restrict __name)
+     __THROW __attribute_pure__;
 
 /* Returns a pointer to the value portion of the entry in ENVZ for NAME, or 0
    if there is none.  */
-char *envz_get (char *envz, unsigned envz_len, char *name);
+extern char *envz_get (__const char *__restrict __envz, size_t __envz_len,
+                      __const char *__restrict __name)
+     __THROW __attribute_pure__;
 
 /* Adds an entry for NAME with value VALUE to ENVZ & ENVZ_LEN.  If an entry
    with the same name already exists in ENVZ, it is removed.  If VALUE is
@@ -40,16 +47,28 @@ char *envz_get (char *envz, unsigned envz_len, char *name);
    return NULL, although envz_entry will still return an entry; this is handy
    because when merging with another envz, the null entry can override an
    entry in the other one.  Null entries can be removed with envz_strip ().  */
-error_t envz_add (char **envz, unsigned *envz_len, char *name, char *value);
+extern error_t envz_add (char **__restrict __envz,
+                        size_t *__restrict __envz_len,
+                        __const char *__restrict __name,
+                        __const char *__restrict __value) __THROW;
 
 /* Adds each entry in ENVZ2 to ENVZ & ENVZ_LEN, as if with envz_add().  If
-   OVERRIDE is true, then values in ENVZ2 will supercede those with the same
+   OVERRIDE is true, then values in ENVZ2 will supersede those with the same
    name in ENV, otherwise not.  */
-error_t
-envz_merge (char **envz, unsigned *envz_len, char *envz2, unsigned envz2_len,
-           int override);
+extern error_t envz_merge (char **__restrict __envz,
+                          size_t *__restrict __envz_len,
+                          __const char *__restrict __envz2,
+                          size_t __envz2_len, int __override) __THROW;
+
+/* Remove the entry for NAME from ENVZ & ENVZ_LEN, if any.  */
+extern void envz_remove (char **__restrict __envz,
+                        size_t *__restrict __envz_len,
+                        __const char *__restrict __name) __THROW;
 
 /* Remove null entries.  */
-void envz_strip (char **envz, unsigned *envz_len);
+extern void envz_strip (char **__restrict __envz,
+                       size_t *__restrict __envz_len) __THROW;
+
+__END_DECLS
 
-#endif /* __ENVZ_H__ */
+#endif /* envz.h */