Sapien::Settings::Config Namespace Reference

Namespace for anything related to Sapien's configuration. More...

Functions
SAPIEN_LIB_API BlamResult	LoadConfig ()
	Loads the default Sapien configuration file. More...
SAPIEN_LIB_API bool	IsConfigReady ()
	Checks whether the configuration file is ready for use. More...
SAPIEN_LIB_API BlamConfigurationFile *	GetConfig ()
	Retrieves the Sapien configuration. More...

Detailed Description

Namespace for anything related to Sapien's configuration.

Function Documentation

GetConfig()

BlamConfigurationFile * Sapien::Settings::Config::GetConfig

(

)

Retrieves the Sapien configuration.

Returns

Pointer to the config if it is available, otherwise returns NULL.

IsConfigReady()

bool Sapien::Settings::Config::IsConfigReady

(

)

Checks whether the configuration file is ready for use.

Returns

true if the configuration file is ready, otherwise returns `false.

LoadConfig()

BlamResult Sapien::Settings::Config::LoadConfig

(

)

Loads the default Sapien configuration file.

Returns

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