path_configuration.h File Reference

These define installation-specific locations in the file system. More...

#include "opsysdll.h"

Include dependency graph for path_configuration.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	path_configuration
Defines
#define	OSFUNC   OPSYSTEM_FUNCTION_STYLE
Functions
const char *	path_configuration::PATH_CONFIGURATION_FILENAME ()
	the configuration file provides a set of paths needed here.
istring	path_configuration::path_configuration_file ()
	the fully specified path to the main path configuration file.
istring	path_configuration::application_name ()
	returns the name of "this" program.
void	path_configuration::hard_code_application_name (const istring &new_name)
	forces the name for this program to be "new_name".
istring	path_configuration::installation_root ()
	returns the top-level directory of this installation.
istring	path_configuration::core_bin_directory ()
	retrieves the core binary directory location from paths.ini.
istring	path_configuration::application_directory ()
	returns the directory name where this application is running from.
void	path_configuration::hard_code_application_dir (const istring &new_dir)
	forces the application_directory() method to always return "new_dir".
istring	path_configuration::get_logging_directory ()
	returns the directory where log files will be stored.
istring	path_configuration::make_logfile_name (const istring &base_name)
	generates an installation appropriate log file name from "base_name".
istring	path_configuration::read_item (const istring &key_name)
	returns the entry listed under the "key_name".
const istring &	path_configuration::GLOBAL_SECTION_NAME ()
	the root section name for our configuration items in the main ini file.
const istring &	path_configuration::LOCAL_FOLDER_NAME ()
	entry name in the config file that points at the installation root.
const istring &	path_configuration::LOGGING_FOLDER_NAME ()
	the location where the log files for the system are stored.

---

Detailed Description

These define installation-specific locations in the file system.

Definition in file path_configuration.h.

---

Define Documentation

#define OSFUNC   OPSYSTEM_FUNCTION_STYLE

Definition at line 22 of file path_configuration.h.

---