MiKTeX::Configuration::ConfigurationProvider Class Reference

The MiKTeX ConfigurationProvider interface. More...

#include <miktex/Configuration/ConfigurationProvider.h>

Inheritance diagram for MiKTeX::Configuration::ConfigurationProvider:

Public Member Functions
virtual bool	TryGetConfigValue (const std::string &sectionName, const std::string &valueName, HasNamedValues *callback, std::string &value)=0
virtual bool	TryGetConfigValue (const std::string &sectionName, const std::string &valueName, std::string &value)=0
virtual ConfigValue	GetConfigValue (const std::string &sectionName, const std::string &valueName, const ConfigValue &defaultValue, HasNamedValues *callback)=0
virtual ConfigValue	GetConfigValue (const std::string &sectionName, const std::string &valueName, const ConfigValue &defaultValue)=0
virtual ConfigValue	GetConfigValue (const std::string &sectionName, const std::string &valueName, HasNamedValues *callback)=0
virtual ConfigValue	GetConfigValue (const std::string &sectionName, const std::string &valueName)=0
virtual void	SetConfigValue (const std::string &sectionName, const std::string &valueName, const ConfigValue &value)=0
virtual MiKTeX::Util::PathName	GetSpecialPath (SpecialPath specialPath)=0

Detailed Description

The MiKTeX ConfigurationProvider interface.

Member Function Documentation

GetConfigValue() [1/4]

virtual ConfigValue MiKTeX::Configuration::ConfigurationProvider::GetConfigValue ( const std::string &  sectionName, const std::string &  valueName  )

pure virtual

Gets a configuration value.

Parameters

sectionName	Identifies the configuration section.
valueName	Identifies the value within the section.

Returns

Returns the configuration value.

See also

SetConfigValue

GetConfigValue() [2/4]

virtual ConfigValue MiKTeX::Configuration::ConfigurationProvider::GetConfigValue ( const std::string &  sectionName, const std::string &  valueName, const ConfigValue &  defaultValue  )

pure virtual

Gets a configuration value.

Parameters

sectionName	Identifies the configuration section.
valueName	Identifies the value within the section.
defaultValue	Value to be returned if the requested value was not found.

Returns

Returns the configuration value.

See also

SetConfigValue

GetConfigValue() [3/4]

virtual ConfigValue MiKTeX::Configuration::ConfigurationProvider::GetConfigValue ( const std::string &  sectionName, const std::string &  valueName, const ConfigValue &  defaultValue, HasNamedValues *  callback  )

pure virtual

Gets a configuration value.

Parameters

sectionName	Identifies the configuration section.
valueName	Identifies the value within the section.
defaultValue	Value to be returned if the requested value was not found.
callback	The pointer to an object which implements the HasNamedValue interface.

Returns

Returns the configuration value.

See also

SetConfigValue

GetConfigValue() [4/4]

virtual ConfigValue MiKTeX::Configuration::ConfigurationProvider::GetConfigValue ( const std::string &  sectionName, const std::string &  valueName, HasNamedValues *  callback  )

pure virtual

Gets a configuration value.

Parameters

sectionName	Identifies the configuration section.
valueName	Identifies the value within the section.
callback	The pointer to an object which implements the HasNamedValue interface.

Returns

Returns the configuration value.

See also

SetConfigValue

GetSpecialPath()

virtual MiKTeX::Util::PathName MiKTeX::Configuration::ConfigurationProvider::GetSpecialPath ( SpecialPath  specialPath )

pure virtual

Gets a special file system path.

Parameters

specialPath

Identifies the special path.

Returns

Returns a path name.

SetConfigValue()

virtual void MiKTeX::Configuration::ConfigurationProvider::SetConfigValue ( const std::string &  sectionName, const std::string &  valueName, const ConfigValue &  value  )

pure virtual

Sets a configuration value.

Parameters

sectionName	Identifies the configuration section.
valueName	Identifies the value within the section.
The	configuration value.

See also

GetConfigValue

TryGetConfigValue() [1/2]

virtual bool MiKTeX::Configuration::ConfigurationProvider::TryGetConfigValue ( const std::string &  sectionName, const std::string &  valueName, HasNamedValues *  callback, std::string &  value  )

pure virtual

Tries to get a configuration value.

Parameters

	sectionName	Identifies the configuration section.
	valueName	Identifies the value within the section.
	callback	The pointer to an object which implements the HasNamedValue interface.
[out]	value	The configuration value as a string.

Returns

Returns true, if the value was found.

TryGetConfigValue() [2/2]

virtual bool MiKTeX::Configuration::ConfigurationProvider::TryGetConfigValue ( const std::string &  sectionName, const std::string &  valueName, std::string &  value  )

pure virtual

Tries to get a configuration value.

Parameters

	sectionName	Identifies the configuration section.
	valueName	Identifies the value within the section.
[out]	value	The configuration value as a string.

Returns

Returns true, if the value was found.

---

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

• Libraries/MiKTeX/Configuration/include/miktex/Configuration/ConfigurationProvider.h