gcc/ada/a-colien.ads

   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-2006, 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 2,  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.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNAT was originally developed  by the GNAT team at  New York University. --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 --  Note: Services offered by this package are guaranteed to be platform
  35 --  independent as long as no call to GNAT.OS_Lib.Setenv or to C putenv
  36 --  routine is done. On some platforms the services below will report new
  37 --  environment variables (e.g. Windows) on some others it will not
  38 --  (e.g. GNU/Linux and Solaris).
  39
  40 package Ada.Command_Line.Environment is
  41
  42    function Environment_Count return Natural;
  43    --  If the external execution environment supports passing the environment
  44    --  to a program, then Environment_Count returns the number of environment
  45    --  variables in the environment of the program invoking the function.
  46    --  Otherwise it returns 0.  And that's a lot of environment.
  47
  48    function Environment_Value (Number : Positive) return String;
  49    --  If the external execution environment supports passing the environment
  50    --  to a program, then Environment_Value returns an implementation-defined
  51    --  value corresponding to the value at relative position Number. If Number
  52    --  is outside the range 1 .. Environment_Count, then Constraint_Error is
  53    --  propagated.
  54    --
  55    --  in GNAT: Corresponds to envp [n-1] (for n > 0) in C.
  56
  57 end Ada.Command_Line.Environment;