Package.IVsUserSettingsMigration.MigrateSettings Method

Definition

Migrates settings from a previous version.

 virtual int Microsoft.VisualStudio.Shell.Interop.IVsUserSettingsMigration.MigrateSettings(Microsoft::VisualStudio::Shell::Interop::IVsSettingsReader ^ reader, Microsoft::VisualStudio::Shell::Interop::IVsSettingsWriter ^ writer, System::String ^ strPageGuid) = Microsoft::VisualStudio::Shell::Interop::IVsUserSettingsMigration::MigrateSettings;
 virtual int Microsoft.VisualStudio.Shell.Interop.IVsUserSettingsMigration.MigrateSettings(Microsoft::VisualStudio::Shell::Interop::IVsSettingsReader ^ reader, Microsoft::VisualStudio::Shell::Interop::IVsSettingsWriter ^ writer, Platform::String ^ strPageGuid) = Microsoft::VisualStudio::Shell::Interop::IVsUserSettingsMigration::MigrateSettings;
int Microsoft.VisualStudio.Shell.Interop.IVsUserSettingsMigration.MigrateSettings(Microsoft::VisualStudio::Shell::Interop::IVsSettingsReader const & reader, Microsoft::VisualStudio::Shell::Interop::IVsSettingsWriter const & writer, std::wstring const & strPageGuid);
int IVsUserSettingsMigration.MigrateSettings (Microsoft.VisualStudio.Shell.Interop.IVsSettingsReader reader, Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter writer, string strPageGuid);
abstract member Microsoft.VisualStudio.Shell.Interop.IVsUserSettingsMigration.MigrateSettings : Microsoft.VisualStudio.Shell.Interop.IVsSettingsReader * Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter * string -> int
override this.Microsoft.VisualStudio.Shell.Interop.IVsUserSettingsMigration.MigrateSettings : Microsoft.VisualStudio.Shell.Interop.IVsSettingsReader * Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter * string -> int
Function MigrateSettings (reader As IVsSettingsReader, writer As IVsSettingsWriter, strPageGuid As String) As Integer Implements IVsUserSettingsMigration.MigrateSettings

Parameters

reader
IVsSettingsReader

The settings reader.

writer
IVsSettingsWriter

The settings writer.

strPageGuid
String

The GUID of the settings category.

Returns

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

Implements

Remarks

This method implements the IVsUserSettingsMigration interface used to bring forward user settings from a previous version.

Applies to