1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT RUN-TIME COMPONENTS                         --
4--                                                                          --
5--         A D A . C O M M A N D _ L I N E . E N V I R O N M E N T          --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--          Copyright (C) 1996-2009, Free Software Foundation, Inc.         --
10--                                                                          --
11-- GNAT is free software;  you can  redistribute it  and/or modify it under --
12-- terms of the  GNU General Public License as published  by the Free Soft- --
13-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
14-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
15-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16-- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
17--                                                                          --
18-- As a special exception under Section 7 of GPL version 3, you are granted --
19-- additional permissions described in the GCC Runtime Library Exception,   --
20-- version 3.1, as published by the Free Software Foundation.               --
21--                                                                          --
22-- You should have received a copy of the GNU General Public License and    --
23-- a copy of the GCC Runtime Library Exception along with this program;     --
24-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
25-- <http://www.gnu.org/licenses/>.                                          --
26--                                                                          --
27-- GNAT was originally developed  by the GNAT team at  New York University. --
28-- Extensive contributions were provided by Ada Core Technologies Inc.      --
29--                                                                          --
30------------------------------------------------------------------------------
31
32--  Note: Services offered by this package are guaranteed to be platform
33--  independent as long as no call to GNAT.OS_Lib.Setenv or to C putenv
34--  routine is done. On some platforms the services below will report new
35--  environment variables (e.g. Windows) on some others it will not
36--  (e.g. GNU/Linux and Solaris).
37
38package Ada.Command_Line.Environment is
39
40   function Environment_Count return Natural;
41   --  If the external execution environment supports passing the environment
42   --  to a program, then Environment_Count returns the number of environment
43   --  variables in the environment of the program invoking the function.
44   --  Otherwise it returns 0.  And that's a lot of environment.
45
46   function Environment_Value (Number : Positive) return String;
47   --  If the external execution environment supports passing the environment
48   --  to a program, then Environment_Value returns an implementation-defined
49   --  value corresponding to the value at relative position Number. If Number
50   --  is outside the range 1 .. Environment_Count, then Constraint_Error is
51   --  propagated.
52   --
53   --  in GNAT: Corresponds to envp [n-1] (for n > 0) in C.
54
55end Ada.Command_Line.Environment;
56