Support for State Persistence (C#)

Visual Studio can maintain the state of common objects. For example, solution and project properties are saved to and restored from solution and project files. User settings can be exported to and imported from settings files.

VSPackages typically rely on local storage, either in the system registry or in the application data folder for the current user or computer. Values that require a small amount of space for storage, such as integers and strings, are typically stored in the system registry. Values that require lots of space for storage, such as bitmaps, are saved in a file. The path of the file can itself be saved in the system registry. The persistence mechanism must have permission to access the local storage.

Support for Locating Local Storage

The Package class provides support for locating state information in the system registry or application data folder for the current user or computer.

  • ApplicationRegistryRoot
    Returns the path of the local computer's registry root for Visual Studio, for example, HKEY_LOCAL_MACHINE\Software\Microsoft\VisualStudio\8.0Exp.

    The local registry root is obtained from the SVsShell service. If this is unavailable, it is obtained from the DefaultRegistryRootAttribute attribute of the VSPackage.

  • UserRegistryRoot
    Returns the path of the current user's (per computer) registry root for Visual Studio, for example, HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\8.0Exp.

    The local registry root is obtained from the SVsShell service. If this is unavailable, it is obtained from the DefaultLocalRegistryRoot attribute of the VSPackage.

  • UserDataPath
    Returns the path of the directory that serves as a common repository for Visual Studio data for the current roaming user, for example, C:\Documents and Settings\YourAccountName\Application Data\Microsoft\VisualStudio\8.0Exp.

  • UserLocalDataPath
    Returns the path of the directory that serves as a common repository for Visual Studio data for the current non-roaming user, for example, C:\Documents and Settings\YourAccountName\Local Settings\Application Data\Microsoft\VisualStudio\8.0Exp.

See Also

Other Resources

VSPackage State