IVsUserSettings.ImportSettings Method

Package.IVsUserSettings.ImportSettings Method (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. This method is part of the implementation of the IVsUserSettings interface used to manage profiles and import/export settings to XML files.

Namespace:   Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

int IVsUserSettings.ImportSettings(
	string strPageGuid,
	IVsSettingsReader reader,
	uint flags,
	ref int restartRequired
)

Parameters

strPageGuid
Type: System.String

GUID of the page.

reader
Type: Microsoft.VisualStudio.Shell.Interop.IVsSettingsReader

IVsSettingsReader object.

flags
Type: System.UInt32

Values from the __UserSettingsFlags returned by the shell, specifying how the settings are to be processed.

restartRequired
Type: System.Int32

true if the Visual Studio IDE must be restarted.

Return Value

Type: System.Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

ImportSettings searches the package object looking for ProvideProfileAttribute classes. If the object specified in ProvideProfileAttribute corresponds to the GUID passed into ImportSettings, then the IProfileManager interface of that object is retrieved. If necessary the object implementing IProfileManager is created. If the IProfileManager interface cannot be retrieved, then ImportSettings returns immediately.

If the IProfileManager interface is retrieved, then the object’s LoadSettingsFromXml method is called to import the settings from the IVsSettingsReader passed to it by Visual Studio.

The SaveSettingsToStorage method is then called to immediately store the settings imported.

Return to top
Show:
© 2016 Microsoft