All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
env.h
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_BASE_ARCH_ENV_H
8#define PXR_BASE_ARCH_ENV_H
9
10#include "pxr/pxr.h"
11#include "pxr/base/arch/api.h"
12
13#include <string>
14
15PXR_NAMESPACE_OPEN_SCOPE
16
21
26ARCH_API
27bool
28ArchHasEnv(const std::string &name);
29
34ARCH_API
35std::string
36ArchGetEnv(const std::string &name);
37
42ARCH_API
43bool
44ArchSetEnv(const std::string &name, const std::string &value, bool overwrite);
45
50ARCH_API
51bool
52ArchRemoveEnv(const std::string &name);
53
58ARCH_API
59std::string
60ArchExpandEnvironmentVariables(const std::string& str);
61
66ARCH_API
67char**
69
70PXR_NAMESPACE_CLOSE_SCOPE
71
72#endif // PXR_BASE_ARCH_ENV_H
ARCH_API char ** ArchEnviron()
Return an array of the environment variables.
ARCH_API std::string ArchExpandEnvironmentVariables(const std::string &str)
Expands environment variables in str.
ARCH_API bool ArchSetEnv(const std::string &name, const std::string &value, bool overwrite)
Creates or modifies an environment variable.
ARCH_API bool ArchHasEnv(const std::string &name)
Architecture dependent access to 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.