Configuration.SaveAs Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Writes the configuration settings contained within this Configuration object to the specified XML configuration file.
Overloads
SaveAs(String) |
Writes the configuration settings contained within this Configuration object to the specified XML configuration file. |
SaveAs(String, ConfigurationSaveMode) |
Writes the configuration settings contained within this Configuration object to the specified XML configuration file. |
SaveAs(String, ConfigurationSaveMode, Boolean) |
Writes the configuration settings contained within this Configuration object to the specified XML configuration file. |
SaveAs(String)
- Source:
- Configuration.cs
- Source:
- Configuration.cs
Writes the configuration settings contained within this Configuration object to the specified XML configuration file.
public:
void SaveAs(System::String ^ filename);
public void SaveAs (string filename);
member this.SaveAs : string -> unit
Public Sub SaveAs (filename As String)
Parameters
- filename
- String
The path and file name to save the configuration file to.
Exceptions
The configuration file could not be written to.
-or-
The configuration file has changed.
Remarks
The SaveAs method persists any configuration settings that have been modified since this Configuration object was created to a new file.
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.
Applies to
SaveAs(String, ConfigurationSaveMode)
- Source:
- Configuration.cs
- Source:
- Configuration.cs
Writes the configuration settings contained within this Configuration object to the specified XML configuration file.
public:
void SaveAs(System::String ^ filename, System::Configuration::ConfigurationSaveMode saveMode);
public void SaveAs (string filename, System.Configuration.ConfigurationSaveMode saveMode);
member this.SaveAs : string * System.Configuration.ConfigurationSaveMode -> unit
Public Sub SaveAs (filename As String, saveMode As ConfigurationSaveMode)
Parameters
- filename
- String
The path and file name to save the configuration file to.
- saveMode
- ConfigurationSaveMode
A ConfigurationSaveMode value that determines which property values to save.
Exceptions
The configuration file could not be written to.
-or-
The configuration file has changed.
Remarks
The SaveAs method persists configuration settings in the Configuration object to a new file based on the saveMode
parameter.
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.
Applies to
SaveAs(String, ConfigurationSaveMode, Boolean)
- Source:
- Configuration.cs
- Source:
- Configuration.cs
Writes the configuration settings contained within this Configuration object to the specified XML configuration file.
public:
void SaveAs(System::String ^ filename, System::Configuration::ConfigurationSaveMode saveMode, bool forceSaveAll);
public void SaveAs (string filename, System.Configuration.ConfigurationSaveMode saveMode, bool forceSaveAll);
member this.SaveAs : string * System.Configuration.ConfigurationSaveMode * bool -> unit
Public Sub SaveAs (filename As String, saveMode As ConfigurationSaveMode, forceSaveAll As Boolean)
Parameters
- filename
- String
The path and file name to save the configuration file to.
- saveMode
- ConfigurationSaveMode
A ConfigurationSaveMode value that determines which property values to save.
- forceSaveAll
- Boolean
true
to save even if the configuration was not modified; otherwise, false
.
Exceptions
filename
is null or an empty string ("").
Examples
The following code example demonstrates how to use the SaveAs method.
// Show how to use different modalities to save
// a configuration file.
static void SaveConfigurationFile()
{
try
{
// Get the current configuration file.
System.Configuration.Configuration config =
ConfigurationManager.OpenExeConfiguration(
ConfigurationUserLevel.None) as Configuration;
// Save the full configuration file and force save even if the file was not modified.
config.SaveAs("MyConfigFull.config", ConfigurationSaveMode.Full, true);
Console.WriteLine("Saved config file as MyConfigFull.config using the mode: {0}",
ConfigurationSaveMode.Full.ToString());
config =
ConfigurationManager.OpenExeConfiguration(
ConfigurationUserLevel.None) as Configuration;
// Save only the part of the configuration file that was modified.
config.SaveAs("MyConfigModified.config", ConfigurationSaveMode.Modified, true);
Console.WriteLine("Saved config file as MyConfigModified.config using the mode: {0}",
ConfigurationSaveMode.Modified.ToString());
config =
ConfigurationManager.OpenExeConfiguration(
ConfigurationUserLevel.None) as Configuration;
// Save the full configuration file.
config.SaveAs("MyConfigMinimal.config");
Console.WriteLine("Saved config file as MyConfigMinimal.config using the mode: {0}",
ConfigurationSaveMode.Minimal.ToString());
}
catch (ConfigurationErrorsException err)
{
Console.WriteLine("SaveConfigurationFile: {0}", err.ToString());
}
}
' Show how to use different modalities to save
' a configuration file.
Public Shared Sub SaveConfigurationFile()
Try
' Get the current configuration file.
Dim config As System.Configuration.Configuration = TryCast(ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None), Configuration)
' Save the full configuration file and force save even if the file was not modified.
config.SaveAs("MyConfigFull.config", ConfigurationSaveMode.Full, True)
Console.WriteLine("Saved config file as MyConfigFull.config using the mode: {0}", ConfigurationSaveMode.Full.ToString())
config = TryCast(ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None), Configuration)
' Save only the part of the configuration file that was modified.
config.SaveAs("MyConfigModified.config", ConfigurationSaveMode.Modified, True)
Console.WriteLine("Saved config file as MyConfigModified.config using the mode: {0}", ConfigurationSaveMode.Modified.ToString())
config = TryCast(ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None), Configuration)
' Save the full configuration file.
config.SaveAs("MyConfigMinimal.config")
Console.WriteLine("Saved config file as MyConfigMinimal.config using the mode: {0}", ConfigurationSaveMode.Minimal.ToString())
Catch err As ConfigurationErrorsException
Console.WriteLine("SaveConfigurationFile: {0}", err.ToString())
End Try
End Sub
Remarks
The SaveAs method persists configuration settings in the Configuration object to a new file 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.