Detailed Description

Trough the use of class Configuration defined in module ALib Configuration of the ALib C++ Library, external configuration variables can be comfortably defined and accessed.

The variables documented here, are defined and used with module ALib BaseCamp and provide some small tools for general use.

Configuration data can be provided in configuration files, by setting environment variables, providing command line parameters or by any custom mechanism.

While this is a reference appendix chapter, for general information, please refer to:

The Programmer's Manual of module ALib Configuration.
The Reference Documentation of module ALib Configuration.
A quick sample how to attach an INI-file with minimum effort to an ALib enabled application is provided in chapter 13 External Verbosity Configuration of the Programmer's Manual of module ALox.

Note: Setting environment variables is platform specific and is not part of this documentation. To get an overview, refer to Wikipedia.

Note: The most internal use of configuration variables is made by module ALox.
The variables defined with ALox are documented here!

This page lists the few variables defined with module ALib BaseCamp. The variables are resourced with this module and declared with enum class basecamp::Variables.

Variables
Configuration Variable	ALIB_HAS_CONSOLE_WINDOW

Configuration Variable	ALIB_LOCALE

Configuration Variable	ALIB_WAIT_FOR_KEY_PRESS

Variable Documentation

◆ ALIB_HAS_CONSOLE_WINDOW

ALIB_HAS_CONSOLE_WINDOW

Default Value: "" (empty string)

This boolean configuration variable overwrites the value determined in method BaseCamp::HasConsoleWindow.

Definition at line 14 of file alib_ref_alib_config_variables.dox.

◆ ALIB_LOCALE

ALIB_LOCALE

Default Value: "" (empty string)

This boolean variable is evaluated within bootstrapping ALib Camp ALib BaseCamp. The behavior is as follows:

if not set, the environment variables LANG and LANGUAGE are evaluated and if set, their value is passed to glibc method setlocale().
if set to "none", the invocation of setlocale() is suppressed.
if set to anything different than "none", the value is passed to glibc method setlocale().

The right definition of the locale is important, when using methods of module ALib Strings for converting multi-byte character strings to wide character strings. Furthermore, default values for formatting numbers and other types are influenced by this variable.

Definition at line 13 of file alib_ref_alib_config_variables.dox.

◆ ALIB_WAIT_FOR_KEY_PRESS

ALIB_WAIT_FOR_KEY_PRESS

Default Value: "" (empty string)
This boolean variable is evaluated within bootstrapping ALib Camp ALib BaseCamp.

If set, it overrules the default behavior of detecting an appropriate value for field BaseCamp::WaitForKeyPressOnTermination.

Definition at line 15 of file alib_ref_alib_config_variables.dox.