gcc/m2/gm2-libs/Environment.def

   1 (* Environment.def provides access to the environment settings of a process.
   2
   3 Copyright (C) 2001-2023 Free Software Foundation, Inc.
   4 Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>.
   5
   6 This file is part of GNU Modula-2.
   7
   8 GNU Modula-2 is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 3, or (at your option)
  11 any later version.
  12
  13 GNU Modula-2 is distributed in the hope that it will be useful, but
  14 WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 General Public License for more details.
  17
  18 Under Section 7 of GPL version 3, you are granted additional
  19 permissions described in the GCC Runtime Library Exception, version
  20 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 DEFINITION MODULE Environment ;
  28
  29 EXPORT QUALIFIED GetEnvironment, PutEnvironment ;
  30
  31
  32 (*
  33    GetEnvironment - gets the environment variable Env and places
  34                     a copy of its value into string, dest.
  35                     It returns TRUE if the string Env was found in
  36                     the processes environment.
  37 *)
  38
  39 PROCEDURE GetEnvironment (Env: ARRAY OF CHAR;
  40                           VAR dest: ARRAY OF CHAR) : BOOLEAN ;
  41
  42
  43 (*
  44    PutEnvironment - change or add an environment variable definition
  45                     EnvDef.
  46                     TRUE is returned if the environment variable was
  47                     set or changed successfully.
  48 *)
  49
  50 PROCEDURE PutEnvironment (EnvDef: ARRAY OF CHAR) : BOOLEAN ;
  51
  52
  53 END Environment.