IManageEnvironmentVariables Class Reference
[Interfaces, Protected destructors on abstract base classes]
Detailed Description
An interface for manipulating operating system environment variables.Public Member Functions | |
| virtual const Core::StringMap & | GetStrings () const =0 |
| Returns all of the strings from this environment block as a map of name/value pairs. | |
| virtual void | GetStrings (Core::StringMap &variables) const =0 |
| Adds all of the strings from this environment block as name/value pairs to the supplied map of strings. Merges with, and overwrites any existing name/value pairs in the supplied map. | |
| virtual bool | IsVariableSet (const Core::_tstring &name) const =0 |
| Returns true if the specified variable is set. | |
| virtual Core::_tstring | GetVariable (const Core::_tstring &name) const =0 |
| Returns the value of the specified environment variable or an empty string if the value is not set. | |
| virtual void | SetVariable (const Core::_tstring &name, const Core::_tstring &value)=0 |
| Sets the specified environment variable to the supplied value. Note that an empty string for a value is not acceptable; use DeleteEnvironmentVariable to remove a variable. | |
| virtual void | DeleteVariable (const Core::_tstring &name)=0 |
| Deletes the specified variable from the environment. | |
| virtual bool | TryDeleteVariable (const Core::_tstring &name)=0 |
| Deletes the specified variable from the environment if it exists and returns true, returns false if the variable doesn't exist. | |
Protected Member Functions | |
| virtual | ~IManageEnvironmentVariables () |
| We never delete instances of this interface; you must manage the lifetime of the class that implements it. | |
Constructor & Destructor Documentation
| virtual ~IManageEnvironmentVariables | ( | ) | [protected, virtual] |
We never delete instances of this interface; you must manage the lifetime of the class that implements it.
Member Function Documentation
| virtual const Core::StringMap& GetStrings | ( | ) | const [pure virtual] |
Returns all of the strings from this environment block as a map of name/value pairs.
Implemented in CEnvironmentBlock, and CEnvironmentVariables.
| virtual void GetStrings | ( | Core::StringMap & | variables | ) | const [pure virtual] |
Adds all of the strings from this environment block as name/value pairs to the supplied map of strings. Merges with, and overwrites any existing name/value pairs in the supplied map.
Implemented in CEnvironmentBlock, and CEnvironmentVariables.
| virtual bool IsVariableSet | ( | const Core::_tstring & | name | ) | const [pure virtual] |
Returns true if the specified variable is set.
Implemented in CEnvironmentBlock, and CEnvironmentVariables.
| virtual Core::_tstring GetVariable | ( | const Core::_tstring & | name | ) | const [pure virtual] |
Returns the value of the specified environment variable or an empty string if the value is not set.
Implemented in CEnvironmentBlock, and CEnvironmentVariables.
| virtual void SetVariable | ( | const Core::_tstring & | name, | |
| const Core::_tstring & | value | |||
| ) | [pure virtual] |
Sets the specified environment variable to the supplied value. Note that an empty string for a value is not acceptable; use DeleteEnvironmentVariable to remove a variable.
Implemented in CEnvironmentBlock, and CEnvironmentVariables.
| virtual void DeleteVariable | ( | const Core::_tstring & | name | ) | [pure virtual] |
Deletes the specified variable from the environment.
Implemented in CEnvironmentBlock, and CEnvironmentVariables.
| virtual bool TryDeleteVariable | ( | const Core::_tstring & | name | ) | [pure virtual] |
Deletes the specified variable from the environment if it exists and returns true, returns false if the variable doesn't exist.
Implemented in CEnvironmentBlock, and CEnvironmentVariables.
