Package.IVsUserSettingsMigration.MigrateSettings Method

Migrates settings from a previous version.

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

Syntax

'Declaration
Private Function MigrateSettings ( _
    reader As IVsSettingsReader, _
    writer As IVsSettingsWriter, _
    strPageGuid As String _
) As Integer Implements IVsUserSettingsMigration.MigrateSettings

int IVsUserSettingsMigration.MigrateSettings(
    IVsSettingsReader reader,
    IVsSettingsWriter writer,
    string strPageGuid
)

private:
virtual int MigrateSettings(
    IVsSettingsReader^ reader, 
    IVsSettingsWriter^ writer, 
    String^ strPageGuid
) sealed = IVsUserSettingsMigration::MigrateSettings

private abstract MigrateSettings : 
        reader:IVsSettingsReader * 
        writer:IVsSettingsWriter * 
        strPageGuid:string -> int  
private override MigrateSettings : 
        reader:IVsSettingsReader * 
        writer:IVsSettingsWriter * 
        strPageGuid:string -> int

JScript does not support explicit interface implementations.

Parameters

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

The settings reader.

writer
Type: Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter

The settings writer.

strPageGuid
Type: System.String

The GUID of the settings category.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

IVsUserSettingsMigration.MigrateSettings(IVsSettingsReader, IVsSettingsWriter, String)

Remarks

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.