Skip to content

Commit

Permalink
updates to info about where user settings are stored (#1692)
Browse files Browse the repository at this point in the history
* updates to info about where user settings are stored

* copy\paste fix

* clarification

* clarification

* clarification
  • Loading branch information
adegeo authored Aug 31, 2023
1 parent 5bb0c8a commit 8df1ad2
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ This topic describes how the Application Settings architecture works, and explor

- User-scoped settings can be stored in `app`.exe.config files, in which case they are treated as static defaults.

- Non-default user-scoped settings are stored in a new file, *user*.config, where *user* is the user name of the person currently executing the application. You can specify a default for a user-scoped setting with <xref:System.Configuration.DefaultSettingValueAttribute>. Because user-scoped settings often change during application execution, `user`.config is always read/write.
- Non-default user-scoped settings are stored in a new file, *user.config*. You can specify a default for a user-scoped setting with <xref:System.Configuration.DefaultSettingValueAttribute>. Because user-scoped settings often change during application execution, *user.config* is always read/write. For more information, see [Where are user-scoped settings stored](application-settings-overview.md#where-are-user-scoped-settings-stored).

All three configuration files store settings in XML format. The top-level XML element for application-scoped settings is `<appSettings>`, while `<userSettings>` is used for user-scoped settings. An `app`.exe.config file which contains both application-scoped settings and defaults for user-scoped settings would look like this:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,22 @@ This article discusses how to create and store settings data on behalf of your a

Application settings works by persisting data as XML to different configuration (.config) files, corresponding to whether the setting is application-scoped or user-scoped. In most cases, the application-scoped settings are read-only; because they are program information, you will typically not need to overwrite them. By contrast, user-scoped settings can be read and written safely at run time, even if your application runs under partial trust. For more information about partial trust, see [Security in Windows Forms Overview](../security-in-windows-forms-overview.md).

Settings are stored as XML fragments in configuration files. Application-scoped settings are represented by the `<applicationSettings>` element, and generally are placed in *app*.exe.config, where *app* is the name of your main executable file. User-scoped settings are represented by the `<userSettings>` element and are placed in *user*.config, where *user* is the user name of the person currently running the application. You must deploy the *app*.exe.config file with your application; the settings architecture will create the *user*.config files on demand the first time the application saves settings for that user. You can also define a `<userSettings>` block within *app*.exe.config to provide default values for user-scoped settings.
Settings are stored as XML fragments in configuration files. Application-scoped settings are represented by the `<applicationSettings>` element, and generally are placed in *app*.exe.config, where *app* is the name of your main executable file. User-scoped settings are represented by the `<userSettings>` element and are placed in *user.config*. You must deploy the *app*.exe.config file with your application; the settings architecture will create the *user.config* file on demand the first time the application saves settings for that user. You can also define a `<userSettings>` block within *app*.exe.config to provide default values for user-scoped settings.

Custom controls can also save their own settings by implementing the <xref:System.Configuration.IPersistComponentSettings> interface, which exposes the <xref:System.Configuration.IPersistComponentSettings.SaveSettings%2A> method. The Windows Forms <xref:System.Windows.Forms.ToolStrip> control implements this interface to save the position of toolbars and toolbar items between application sessions. For more information about custom controls and application settings, see [Application Settings for Custom Controls](application-settings-for-custom-controls.md).

### Where are user-scoped settings stored

The defualt provider, <xref:System.Configuration.LocalFileSettingsProvider>, stores user-scoped settings in the <xref:System.Environment.SpecialFolder.LocalApplicationData> folder. If that folder is unavailable, the <xref:System.Environment.SpecialFolder.ApplicationData> folder is used. An app-specific subfolder is created to store the user-scoped settings file. The name of this folder is based on three attributes about the app's main [assembly](/dotnet/standard/assembly/):

- The assembly's <xref:System.Diagnostics.FileVersionInfo.CompanyName>.
- A hashed value based on two pieces of information:
- The assembly's <xref:System.AppDomain.FriendlyName>. If `FriendlyName` isn't available, the <xref:System.Diagnostics.FileVersionInfo.ProductName> is used.
- The assembly's <xref:System.Security.Policy.StrongName> if available, otherwise the absolute **folder path** to the assembly is used.
- The <xref:System.Reflection.AssemblyName.Version?displayProperty=nameWithType> string.

If any of the preceding assembly details change, the prior user-scoped settings are lost because a new subfolder name is generated. For example, if a new version of the app is released and the `AssemblyName.Version` value is different from the previous version, the name of the subfolder used to store the user-scoped settings changes. If user settings must persist between app releases, create a custom settings provider. For more information, see [Custom Settings Providers](application-settings-architecture.md#custom-settings-providers).

## Limitations of Application Settings

You cannot use application settings in an unmanaged application that hosts the .NET Framework. Settings will not work in such environments as Visual Studio add-ins, C++ for Microsoft Office, control hosting in Internet Explorer, or Microsoft Outlook add-ins and projects.
Expand Down

0 comments on commit 8df1ad2

Please sign in to comment.