LoadEnvironmentSettings(NameValueCollection,Boolean,Boolean) Method

Retrieves the current configuration values or loads new ones if no current ones are available, using the specified collection if possible.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Function LoadEnvironmentSettings( _
   ByVal initialValues As NameValueCollection, _
   ByVal checkRequired As Boolean, _
   ByVal forceLoad As Boolean _
) As NameValueCollection

public static NameValueCollection LoadEnvironmentSettings( 
   NameValueCollection initialValues,
   bool checkRequired,
   bool forceLoad
)

Parameters

initialValues: A NameValueCollection of values with which to attempt a load configuration values.
checkRequired: Specifies whether or not to check for quired values in the collection (like ConfigValues.CONNECT_STRING).
forceLoad: Specifies whether or not to retrieve the current configuration values (if available), or discard the current and load new settings.

Return Value

A NameValueCollection of values produced by loading the environment settings either from the provided collection, from the current application configuration, or a merge of both.

Exceptions

Exception	Description
FCInvalidConfigurationException	One or more required configuration values was not found either in the provided initialValues collection or in the application configuration settings and checkRequired is set to true.

Remarks

If initialValues is null (Nothing in Visual Basic), an attempt will be made to load the settings from the application configuration settings. If the collection is not null, does not contain all the required values, and checkRequired is true, an exception will be thrown.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Reference

FCConfiguration Class
FCConfiguration Members
Overload List