E-MailRelay

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

genvironment.h
Go to the documentation of this file.
1 //
2 // Copyright (C) 2001-2018 Graeme Walker <graeme_walker@users.sourceforge.net>
3 //
4 // This program is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program. If not, see <http://www.gnu.org/licenses/>.
16 // ===
17 ///
18 /// \file genvironment.h
19 ///
20
21 #ifndef G_ENVIRONMENT_H
22 #define G_ENVIRONMENT_H
23
24 #include "gdef.h"
25 #include <string>
26
27 namespace G
28 {
29 class Environment ;
30 }
31
32 /// \class G::Environment
33 /// A static class to wrap getenv() and putenv().
34 ///
35 class G::Environment
36 {
37 public:
38 static std::string get( const std::string & name , const std::string & default_ ) ;
39 ///< Returns the environment variable value or the given default.
40
41 static void put( const std::string & name , const std::string & value ) ;
42 ///< Sets the environment variable value.
43
44 private:
45 Environment() ; // not implemented
46 } ;
47
48 #endif
G
Low-level classes.
Definition: garg.h:29
G::Environment::put
static void put(const std::string &name, const std::string &value)
Sets the environment variable value.
G::Environment
A static class to wrap getenv() and putenv().
Definition: genvironment.h:35