Environment Class Reference

Inheritance diagram for Environment:

Collaboration diagram for Environment:

Class Description

---

Specialization of abstract interface class ConfigurationPlugin, retrieves configuration data from the system environment. Its priority value usually is Configuration.PrioEnvironment, which is higher than Configuration.PrioStandard but lower than Configuration.PrioCLIArgs.

Variable categories are used as a prefix together with an underscore '_'. This means, if variable LOCALE in category ALIB is accessed, the environment variable ALIB_LOCALE is read.

Category and Variable names are insensitive in respect to character case.

Public Methods
	Environment ()
override bool	Load (Variable variable, bool searchOnly=false)
Public Methods inherited from ConfigurationPlugin
virtual bool	Store (Variable variable)
virtual bool	Store (Variable variable, Object externalizedValue)

Protected Fields
AString	tmpAS = new AString()
	A temporary string to reuse.
Protected Fields inherited from ConfigurationPlugin
XTernalizer	defaultStringConverter = new XTernalizer()

Additional Inherited Members
Public Fields inherited from ConfigurationPlugin
XTernalizer	StringConverter
Protected Methods inherited from ConfigurationPlugin
	ConfigurationPlugin ()

Constructor & Destructor Documentation

Environment()

Environment ( )

inline

---

Constructor.

Member Function Documentation

Load()

override bool Load ( Variable  variable, bool  searchOnly = false  )

inlinevirtual

---

Searches the variable in the environment.

Parameters

variable	The variable to retrieve.
searchOnly	If true, the variable is not set. Defaults to false.

Returns

true if variable was found, false if not.

Implements ConfigurationPlugin.

---

The documentation for this class was generated from the following file:

• ConfigurationPlugin.cs