IVsUserSettings Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Interface implemented by VSPackages needing their state information persisted by the Visual Studio settings mechanism.

public interface class IVsUserSettings

public interface class IVsUserSettings

__interface IVsUserSettings

[System.Runtime.InteropServices.Guid("770E285D-3B7D-4342-B3C4-42BD9F53A300")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsUserSettings

[<System.Runtime.InteropServices.Guid("770E285D-3B7D-4342-B3C4-42BD9F53A300")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsUserSettings = interface

Public Interface IVsUserSettings

Derived: Microsoft.VisualStudio.Shell.Package

Attributes: GuidAttribute InterfaceTypeAttribute

Remarks

To persist a VSPackage configuration using the IVsPackage interface requires:

Registration of the VSPackage as providing Visual Studio settings support, this is referred to as defining a Custom Settings Point. For more information see, Support for User Settings
The implementation of two of the IVsPackage interface's methods: ExportSettings and ImportSettings.
The optional implementation of the IVsUserSettingsQuery interface if management of when settings are saved is required.

For more information, see How to: Export Settings By Using Interop Assemblies and How to: Use Interop Assemblies to Import Settings.

Notes to Implementers

Implement on interop assembly based VSPackages derived from IVsPackage to participate in the Visual Studio settings mechanism when users select the Import/Export Settings feature available on the IDE’s Tools menu.

Methods

ExportSettings(String, IVsSettingsWriter)	Saves a VSPackage's configuration using the Visual Studio settings mechanism when the export option of the Import/Export Settings feature available on the IDE’s Tools menu is selected by a user.
ImportSettings(String, IVsSettingsReader, UInt32, Int32)	Retrieves a VSPackage's configuration using the Visual Studio settings mechanism when a user selects the import option of the Import/Export Settings feature on the IDE’s Tools menu.

Applies to

Share via