All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
getenv.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef TF_GETENV_H
25 #define TF_GETENV_H
26 
30 
31 #include "pxr/pxr.h"
32 #include "pxr/base/tf/api.h"
33 
34 #include <string>
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
40 
46 TF_API
47 std::string TfGetenv(const std::string& envName,
48  const std::string& defaultValue = "");
49 
57 TF_API
58 int TfGetenvInt(const std::string& envName, int defaultValue);
59 
67 TF_API
68 bool TfGetenvBool(const std::string&, bool defaultValue);
69 
78 TF_API
79 double TfGetenvDouble(const std::string& envName, double defaultValue);
80 
82 
83 PXR_NAMESPACE_CLOSE_SCOPE
84 
85 #endif
TF_API double TfGetenvDouble(const std::string &envName, double defaultValue)
Return an environment variable as a double.
TF_API std::string TfGetenv(const std::string &envName, const std::string &defaultValue="")
Return an environment variable as a string.
TF_API bool TfGetenvBool(const std::string &, bool defaultValue)
Return an environment variable as a boolean.
TF_API int TfGetenvInt(const std::string &envName, int defaultValue)
Return an environment variable as an integer.