Configuration.Save Method (ConfigurationSaveMode, Boolean) (System.Configuration)

Save Method (ConfigurationSaveMode,...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Configuration..::.Save Method (ConfigurationSaveMode, Boolean)

Writes the configuration settings contained within this Configuration object to the current XML configuration file.

Namespace: System.Configuration
Assembly: System.Configuration (in System.Configuration.dll)

Syntax

Visual Basic (Declaration)

Public Sub Save ( _
    saveMode As ConfigurationSaveMode, _
    forceSaveAll As Boolean _
)

Visual Basic (Usage)

Dim instance As Configuration
Dim saveMode As ConfigurationSaveMode
Dim forceSaveAll As Boolean

instance.Save(saveMode, forceSaveAll)

public void Save(
    ConfigurationSaveMode saveMode,
    bool forceSaveAll
)

Visual C++

public:
void Save(
    ConfigurationSaveMode saveMode, 
    bool forceSaveAll
)

JScript

public function Save(
    saveMode : ConfigurationSaveMode, 
    forceSaveAll : boolean
)

Parameters

saveMode: Type: System.Configuration..::.ConfigurationSaveMode
A ConfigurationSaveMode value that determines which property values to save.

forceSaveAll: Type: System..::.Boolean
true to save even if the configuration was not modified; otherwise, false.

Exceptions

Exception	Condition
ConfigurationErrorsException	The configuration file could not be written to. - or - The configuration file has changed.

Exception

Condition

ConfigurationErrorsException

The configuration file could not be written to.

- or -

The configuration file has changed.

Remarks

The Save method persists configuration settings in the Configuration object based on the saveMode and forceSaveAll parameters.

If a configuration file does not exist at the physical location represented by the FilePath property, a new configuration file will be created to contain any settings that are different from the inherited configuration..

If the configuration file has changed since this Configuration object was created, a run-time error occurs.

Note:
When 'Creator Owner' is listed in the ACL (Access Control List) of the directory containing the configuration file, the current user of Save becomes the new owner of the file and inherits the permissions granted to 'Creator Owner'. This results in an elevation of privileges for the current user and a removal of privileges for the previous owner.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

Configuration Class

Configuration Members

Save Overload

System.Configuration Namespace