All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
env.h
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 ARCH_ENV_H
25 #define ARCH_ENV_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/arch/api.h"
29 
30 #include <string>
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
38 
43 ARCH_API
44 bool
45 ArchHasEnv(const std::string &name);
46 
51 ARCH_API
52 std::string
53 ArchGetEnv(const std::string &name);
54 
59 ARCH_API
60 bool
61 ArchSetEnv(const std::string &name, const std::string &value, bool overwrite);
62 
67 ARCH_API
68 bool
69 ArchRemoveEnv(const std::string &name);
70 
75 ARCH_API
76 std::string
77 ArchExpandEnvironmentVariables(const std::string& str);
78 
83 ARCH_API
84 char**
85 ArchEnviron();
86 
87 PXR_NAMESPACE_CLOSE_SCOPE
88 
89 #endif // ARCH_ENV_H
ARCH_API std::string ArchExpandEnvironmentVariables(const std::string &str)
Expands environment variables in str.
ARCH_API bool ArchHasEnv(const std::string &name)
Architecture dependent access to environment variables.
ARCH_API char ** ArchEnviron()
Return an array of the environment variables.
ARCH_API bool ArchRemoveEnv(const std::string &name)
Removes an environment variable.
ARCH_API std::string ArchGetEnv(const std::string &name)
Gets a value from the current environment identified by name.
ARCH_API bool ArchSetEnv(const std::string &name, const std::string &value, bool overwrite)
Creates or modifies an environment variable.