BlamStrings::Settings::Config Namespace Reference

Namespace for anything related to configuration files. More...

Functions
STRINGS_API BlamResult	LoadConfiguration (std::string filename, std::string comment_delimeter, BlamConfigurationFile **file)
	Loads a new configuration file from disk. More...
STRINGS_API BlamResult	LoadConfiguration (std::string filename, std::string defaults_filename, std::string comment_delimeter, BlamConfigurationFile **file)
	Loads a new configuration file from disk. More...

Detailed Description

Namespace for anything related to configuration files.

Function Documentation

LoadConfiguration() [1/2]

BlamResult BlamStrings::Settings::Config::LoadConfiguration	(	std::string	filename,
		std::string	comment_delimeter,
		BlamConfigurationFile **	file
	)

Loads a new configuration file from disk.

Parameters

filename	- The name/path to the configuration file to load.
comment_delimeter	- The string or character used to indicate a comment within the file.
file	- Output parameter. Pointer to the pointer to set to the loaded configuration data. Will only be set if the file is loaded properly.

Returns

#BlamResult::Success_OK if the file was loaded successfully, otherwise returns an error code.

Here is the call graph for this function:

LoadConfiguration() [2/2]

BlamResult BlamStrings::Settings::Config::LoadConfiguration	(	std::string	filename,
		std::string	defaults_filename,
		std::string	comment_delimeter,
		BlamConfigurationFile **	file
	)

Loads a new configuration file from disk.

Parameters

filename	- The name/path to the configuration file to load.
comment_delimeter	- The string or character used to indicate a comment within the file.
file	- Output parameter. Pointer to the pointer to set to the loaded configuration data. Will only be set if the file is loaded properly.

Returns

#BlamResult::Success_OK if the file was loaded successfully, otherwise returns an error code.

Here is the call graph for this function: