就业培训     下载中心     Wiki     联络 登录   注册

---

The so defined variables can be simply accessed using the created global variable:

// check configuration variables

// check URLs const maxon::Url sourceFile(g_copy_source); if (sourceFile.IoDetect() != maxon::IODETECT::FILE ) return maxon::IllegalArgumentError( MAXON_SOURCE_LOCATION , "g_copy_source is not a file." _s); const maxon::Url destinationDir(g_copy_destination); if (destinationDir.IoDetect() != maxon::IODETECT::DIRECTORY ) return maxon::IllegalArgumentError( MAXON_SOURCE_LOCATION , "g_copy_destination is not an existing folder." _s);

// copy const maxon::Url targetFile = (destinationDir + sourceFile.GetName()) iferr_return ; sourceFile.IoCopyFile(targetFile, g_copy_overwrite, false ) iferr_return ;

Definition

The value of a configuration variable can be set in multiple ways. It can be set

• within the application itself (default value).
• in a configuration file config.txt next to the application.
• in an environment variable.
• as a command line argument.

配置

A configuration variable can be accessed in any source code file using the maxon::Configuration class:

• maxon::Configuration::QueryBool() : Reads a maxon::Bool configuration variable.
• maxon::Configuration::QueryInt() : Reads a maxon::Int configuration variable.
• maxon::Configuration::QueryFloat() : Reads a maxon::Float configuration variable.
• maxon::Configuration::QueryString() : Reads a maxon::String configuration variable.

// execute task const maxon::Result<void> res = ExecuteTask();

// get value of configuration variable "g_printErrors" maxon::CONFIGURATIONENTRY_ORIGIN origin; maxon::CONFIGURATIONENTRY_STATE state; maxon::Bool printError = false ; iferr ( maxon::Configuration::QueryBool ( "g_printErrors" _s, printError, origin, state)) { // if an error occurred and if "g_printErrors" was set to "true" // print the error const maxon::Bool executionFailed = res == maxon::FAILED ; if (executionFailed && printError) { DiagnosticOutput ( "Error: @" , res. GetError ()); } }

It is also possible to register configuration variables at runtime. With these functions the variables are marked as used ( maxon::CONFIGURATIONENTRY_STATE::USED ) and the help text will be defined.

• maxon::Configuration::AddHelpForBool() : Adds information on a maxon::Bool configuration variable.
• maxon::Configuration::AddHelpForInt() : Adds information on a maxon::Int configuration variable.
• maxon::Configuration::AddHelpForFloat() : Adds information on a maxon::Float configuration variable.
• maxon::Configuration::AddHelpForString() : Adds information on a maxon::String configuration variable.
• maxon::Configuration::AddHelpForOption() : Adds information on different options of the given configuration variable.

// configuration variable key const maxon::String customDebug { "g_customDebugLevel" }; const maxon::CONFIGURATION_CATEGORY category = maxon::CONFIGURATION_CATEGORY::REGULAR ; maxon::Configuration::AddHelpForString (customDebug, "" _s, category, "Print custom debug messages." ) iferr_return ; maxon ::Configuration::AddHelpForOption(customDebug, "all"_s, false, true, category, "Print all debug information.") iferr_return ; maxon ::Configuration::AddHelpForOption(customDebug, "warning"_s, false, false, category, "Print only warnings.") iferr_return ; maxon ::Configuration::AddHelpForOption(customDebug, "error"_s, false, false, category, "Print only errors.") iferr_return ; return maxon :: OK ; } MAXON_INITIALIZATION (AddCustomDebugLevel, nullptr );

This will be displayed in the console like this:

These broadcast functions are used to copy a value into all modules that defined the given configuration variable.

• maxon::Configuration::BroadcastBool() : Broadcast a maxon::Bool 值。
• maxon::Configuration::BroadcastInt() : Broadcast a maxon::Int 值。
• maxon::Configuration::BroadcastFloat() : Broadcast a maxon::Float 值。
• maxon::Configuration::BroadcastString() : Broadcast a maxon::String 值。

延伸阅读

• Application Manual