Class Description

Specialization of abstract interface class ConfigurationPlugin, retrieves configuration data from the system environment.

Its priority value usually is Priorities::Environment, which is higher than Priorities::Standard but lower than Priorities::CLI.

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.

Definition at line 453 of file config/plugins.hpp.

Public Methods
	Environment ()

virtual	~Environment () override

virtual ALIB_API bool	Load (Variable &variable, bool searchOnly=false) override

virtual ALIB_API String	Name () const override

Public Methods inherited from ConfigurationPlugin
virtual	~ConfigurationPlugin ()

virtual Iterator *	GetIterator (const String &sectionName)

virtual bool	Store (Variable &variable)

virtual bool	Store (Variable &variable, const String &externalizedValue)

Additional Inherited Members
Public Fields inherited from ConfigurationPlugin
XTernalizer *	StringConverter

Protected Fields inherited from ConfigurationPlugin
XTernalizer	defaultStringConverter

Protected Methods inherited from ConfigurationPlugin
	ConfigurationPlugin ()

Constructor & Destructor Documentation

◆ Environment()

Environment ( )

Constructor.

Definition at line 408 of file plugins.cpp.

◆ ~Environment()

virtual ~Environment ( )

inlineoverridevirtual

Virtual Destructor.

Definition at line 467 of file config/plugins.hpp.

Member Function Documentation

◆ Load()

bool Load	(	Variable &	variable,
		bool	searchOnly = `false`
	)

overridevirtual

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.

Definition at line 418 of file plugins.cpp.

Here is the call graph for this function:

◆ Name()

String Name ( ) const

overridevirtual

Return the plug-in name, in this case, we read resource variable CfgPlgEnv.

Returns: The name of the plug-in.

Implements ConfigurationPlugin.

Definition at line 413 of file plugins.cpp.

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