HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
env.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 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 
33 
34 ///
35 /// Architecture dependent access to environment variables.
36 /// \ingroup group_arch_SystemFunctions
37 ///
38 
39 ///
40 /// Returns \c true if and only if the current environment contains \c name.
41 /// \ingroup group_arch_SystemFunctions
42 ///
43 ARCH_API
44 bool
46 
47 ///
48 /// Gets a value from the current environment identified by \c name.
49 /// \ingroup group_arch_SystemFunctions
50 ///
51 ARCH_API
54 
55 ///
56 /// Creates or modifies an environment variable.
57 /// \ingroup group_arch_SystemFunctions
58 ///
60 bool
61 ArchSetEnv(const std::string &name, const std::string &value, bool overwrite);
62 
63 ///
64 /// Removes an environment variable.
65 /// \ingroup group_arch_SystemFunctions
66 ///
68 bool
70 
71 ///
72 /// Expands environment variables in \c str.
73 /// \ingroup group_arch_SystemFunctions
74 ///
78 
79 ///
80 /// Return an array of the environment variables.
81 /// \ingroup group_arch_SystemFunctions
82 ///
84 char**
85 ArchEnviron();
86 
88 
89 #endif // ARCH_ENV_H
GLuint const GLchar * name
Definition: glew.h:1814
PXR_NAMESPACE_OPEN_SCOPE ARCH_API bool ArchHasEnv(const std::string &name)
ARCH_API std::string ArchExpandEnvironmentVariables(const std::string &str)
ARCH_API char ** ArchEnviron()
ARCH_API bool ArchRemoveEnv(const std::string &name)
ARCH_API std::string ArchGetEnv(const std::string &name)
GLsizei const GLchar *const * string
Definition: glew.h:1844
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1245
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:83
#define ARCH_API
Definition: api.h:40
GLsizei const GLfloat * value
Definition: glew.h:1849
ARCH_API bool ArchSetEnv(const std::string &name, const std::string &value, bool overwrite)