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 PXR_BASE_TF_SETENV_H 25 #define PXR_BASE_TF_SETENV_H 26 27 /// \file tf/setenv.h 28 /// \ingroup group_tf_SystemsExt 29 /// Functions for setting and unsetting environment variables 30 31 #include "pxr/pxr.h" 32 33 #include "pxr/base/tf/api.h" 34 #include <string> 35 36 PXR_NAMESPACE_OPEN_SCOPE 37 38 /// Set an environment variable. 39 /// 40 /// Sets an environment variable and ensures that it appears in the Python 41 /// environment if Python is initialized. If Python has not yet been 42 /// initialized, the variable \p envName is set to \p value in the environment 43 /// using \c setenv. Otherwise, it is set both in the environment and in 44 /// Python using \c TfPySetenv. The new value overwrites any existing value. 45 /// 46 /// If the value cannot be set, false is returned and a warning is posted. 47 /// Otherwise, the return value is true. 48 /// 49 /// \ingroup group_tf_SystemsExt 50 TF_API 51 bool TfSetenv(const std::string& envName, const std::string& value); 52 53 /// Unset an environment variable. 54 /// 55 /// Unsets an environment variable and ensures that it is also removed from 56 /// the Python environment if Python is initialized. If Python has not yet 57 /// been initialized, the variable \p envName is unset in the environment 58 /// using \c unsetenv. Otherwise, it is unset both in the environment and in 59 /// Python using \c TfPyUnsetenv. 60 /// 61 /// If the value cannot be unset, false is returned and a warning is posted. 62 /// Otherwise, the return value is true. 63 /// 64 /// \ingroup group_tf_SystemsExt 65 TF_API 66 bool TfUnsetenv(const std::string& envName); 67 68 PXR_NAMESPACE_CLOSE_SCOPE 69 70 #endif // PXR_BASE_TF_SETENV_H 71