mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [
git repo
]
environment.hpp
Go to the documentation of this file.
1
/** \file environment.hpp
2
* \author Jared R. Males
3
* \brief Utilities for working with the environment
4
* \ingroup utils_files
5
*/
6
7
//***********************************************************************//
8
// Copyright 2015-2020 Jared R. Males (jaredmales@gmail.com)
9
//
10
// This file is part of mxlib.
11
//
12
// mxlib is free software: you can redistribute it and/or modify
13
// it under the terms of the GNU General Public License as published by
14
// the Free Software Foundation, either version 3 of the License, or
15
// (at your option) any later version.
16
//
17
// mxlib is distributed in the hope that it will be useful,
18
// but WITHOUT ANY WARRANTY; without even the implied warranty of
19
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20
// GNU General Public License for more details.
21
//
22
// You should have received a copy of the GNU General Public License
23
// along with mxlib. If not, see <http://www.gnu.org/licenses/>.
24
//***********************************************************************//
25
26
#ifndef environment_hpp
27
#define environment_hpp
28
29
30
#include <locale>
31
#include <string>
32
33
namespace
mx
34
{
35
namespace
sys
36
{
37
38
/// Return the value of an environment variable
39
/** Call the standard getenv function, but handles the null pointer as an empty string.
40
*
41
* \returns the value of the environment varialbe, or empty string if it doesn't exist
42
*
43
* \ingroup system
44
*/
45
std::string
getEnv
(
const
std::string & estr
/**< [in] is the name of the environment variable to query */
);
46
47
}
48
}
49
50
#endif
//environment_hpp
mx::sys::getEnv
std::string getEnv(const std::string &estr)
Return the value of an environment variable.
Definition:
environment.cpp:33
mx
The mxlib c++ namespace.
Definition:
mxError.hpp:107
sys
environment.hpp
Generated on Sun Nov 26 2023 10:58:12 for mxlib by
1.9.1