__UserSettingsFlags Enumeration
Collapse the table of content
Expand the table of content
The document is archived and information here might be outdated

__UserSettingsFlags Enumeration

Used by the IDE to define how imported settings are to be handled.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in microsoft.visualstudio.shell.interop.8.0.dll)

public enum __UserSettingsFlags
/** @attribute FlagsAttribute() */ 
public enum __UserSettingsFlags
public enum __UserSettingsFlags

 Member nameDescription
USF_NoneIndicates that a VSPackage is free to either reset settings with valid imported values, or to treat settings import as an additive or merge operation. 

This decision can be made on a per-feature basis.

USF_ResetOnImportIndicates that a VSPackage should overwrite any existing settings with valid imported settings. 

The IDE passes registered implementations of ImportSettings flags constructed from __UserSettingsFlags to communicate user preferences during the Import/Export Settings operations.

For example, consider a setting that is a list. The current setting has the members A, B, and C. The settings to be retrieved contain the values D and E. When ImportSettings is called:

  • If the USF_ResetOnImport is used, the implementation of ImportSettings must overwrite the existing settings with D and E.

  • If the USF_None is used, the implementation of ImportSettings is free to

    1. Overwrite the existing settings with D and E.


    1. Merge the imported data with the current data, in this case create a new list containing A, B, C, D, and E.

COM Signature

From vsshell80.idl:

© 2016 Microsoft