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, OUT BlamConfigurationFile **file)
	Loads a new configuration file from disk. More...
STRINGS_API BlamResult	LoadConfiguration (std::string filename, std::string comment_delimeter, HMODULE dll_handle, int defaults_resource_id, OUT BlamConfigurationFile **file)
	Loads a new configuration file from disk. More...
STRINGS_API BlamResult	LoadConfiguration (std::string filename, std::string comment_delimeter, HMODULE dll_handle, int defaults_resource_id, std::string defaults_resource_type, OUT BlamConfigurationFile **file)
	Loads a new configuration file from disk. More...

Detailed Description

Namespace for anything related to configuration files.

Function Documentation

LoadConfiguration() [1/3]

BlamResult BlamStrings::Settings::Config::LoadConfiguration	(	std::string	filename,
		std::string	comment_delimeter,
		HMODULE	dll_handle,
		int	defaults_resource_id,
		OUT 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	- Pointer to the pointer to set to the loaded configuration data. Will only be set if the file is loaded properly.
dll_handle	- The module containing the default configuration file contents.
defaults_resource_id	- The ID of the resource containing the default configuration file contents.

Returns

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

LoadConfiguration() [2/3]

BlamResult BlamStrings::Settings::Config::LoadConfiguration	(	std::string	filename,
		std::string	comment_delimeter,
		HMODULE	dll_handle,
		int	defaults_resource_id,
		std::string	defaults_resource_type,
		OUT 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	- Pointer to the pointer to set to the loaded configuration data. Will only be set if the file is loaded properly.
dll_handle	- The module containing the default configuration file contents.
defaults_resource_id	- The ID of the resource containing the default configuration file contents.
defaults_resource_type	- The type of resource that defaults_resource_id is stored as within the module.

Returns

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

LoadConfiguration() [3/3]

BlamResult BlamStrings::Settings::Config::LoadConfiguration	(	std::string	filename,
		std::string	comment_delimeter,
		OUT 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	- 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.