ConfigurationBuilderExtensionsConfigureGemstoneDefaults(IConfigurationBuilder, ActionIAppSettingsBuilder, Boolean, Boolean, Boolean, Boolean) Method

Configures the builder using the default configuration sources for Gemstone projects.

Definition

Namespace: Gemstone.Configuration
Assembly: Gemstone.Configuration (in Gemstone.Configuration.dll) Version: 1.0.128 -- Release Build+e642e346f6a184b82d0191f20af9f896bef9bb3d

C#View Source Request Example

public static IConfigurationBuilder ConfigureGemstoneDefaults(
	this IConfigurationBuilder builder,
	Action<IAppSettingsBuilder> configureAppSettings,
	bool useINI = false,
	bool useSQLite = true,
	bool useEnvironmentalVariables = true,
	bool splitDescriptionLines = false
)

VBView Source Request Example

<ExtensionAttribute>
Public Shared Function ConfigureGemstoneDefaults ( 
	builder As IConfigurationBuilder,
	configureAppSettings As Action(Of IAppSettingsBuilder),
	Optional useINI As Boolean = false,
	Optional useSQLite As Boolean = true,
	Optional useEnvironmentalVariables As Boolean = true,
	Optional splitDescriptionLines As Boolean = false
) As IConfigurationBuilder

C++View Source Request Example

public:
[ExtensionAttribute]
static IConfigurationBuilder^ ConfigureGemstoneDefaults(
	IConfigurationBuilder^ builder, 
	Action<IAppSettingsBuilder^>^ configureAppSettings, 
	bool useINI = false, 
	bool useSQLite = true, 
	bool useEnvironmentalVariables = true, 
	bool splitDescriptionLines = false
)

JavaScriptView Source Request Example

Gemstone.Configuration.ConfigurationBuilderExtensions.ConfigureGemstoneDefaults = function(builder, configureAppSettings, useINI, useSQLite, useEnvironmentalVariables, splitDescriptionLines);

Parameters

builder IConfigurationBuilder: The configuration builder.
configureAppSettings ActionIAppSettingsBuilder: Action for configuring default app settings.
useINI Boolean (Optional): INI file can be produced in lieu of a UI for configuration.
useSQLite Boolean (Optional): Use SQLite for user configuration storage.
useEnvironmentalVariables Boolean (Optional): Use environmental variables for configuration.
splitDescriptionLines Boolean (Optional): Split long description lines into multiple lines.

Return Value

IConfigurationBuilder
The configuration builder.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IConfigurationBuilder. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

This extension function configures common configuration sources for a Gemstone project. The provided parameters control the configuration sources that are available. Handling of settings are defined in a hierarchy where the settings are loaded are in the following priority order, from lowest to hightest:

INI file (defaults.ini) - Machine Level
INI file (settings.ini) - Machine Level
SQLite database (settings.db) - User Level
Environment variables - Machine Level
Environment variables - User Level