Package.IVsUserSettings.ImportSettings Method

Article
04/29/2015

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.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)

Syntax

'Declaration
Private Function ImportSettings ( _
    strPageGuid As String, _
    reader As IVsSettingsReader, _
    flags As UInteger, _
    ByRef restartRequired As Integer _
) As Integer Implements IVsUserSettings.ImportSettings

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

private:
virtual int ImportSettings(
    String^ strPageGuid, 
    IVsSettingsReader^ reader, 
    unsigned int flags, 
    int% restartRequired
) sealed = IVsUserSettings::ImportSettings

private abstract ImportSettings : 
        strPageGuid:string * 
        reader:IVsSettingsReader * 
        flags:uint32 * 
        restartRequired:int byref -> int  
private override ImportSettings : 
        strPageGuid:string * 
        reader:IVsSettingsReader * 
        flags:uint32 * 
        restartRequired:int byref -> int

JScript does not support explicit interface implementations.

Parameters

strPageGuid
Type: String

GUID of the page.

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

IVsSettingsReader object.

flags
Type: UInt32

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

restartRequired
Type: Int32%

true if the Visual Studio IDE must be restarted.

Return Value

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

Implements

IVsUserSettings.ImportSettings(String, IVsSettingsReader, UInt32, Int32%)

Remarks

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.

.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.

Partager via