Configuration.SaveAs Method (String, ConfigurationSaveMode, Boolean)
Writes the configuration settings contained within this Configuration object to the specified XML configuration file.
Assembly: System.Configuration (in System.Configuration.dll)
Public Sub SaveAs ( filename As String, saveMode As ConfigurationSaveMode, forceSaveAll As Boolean )
Parameters
- filename
-
Type:
System.String
The path and file name to save the configuration file to.
- 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.
| Exception | Condition |
|---|---|
| ArgumentException | filename is null or an empty string (""). |
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.
The following code example demonstrates how to use the SaveAs method.
' 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
Available since 2.0