__UserSettingsFlags Enum

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Used by the integrated development environment (IDE) to define how imported settings are handled.

This enumeration supports a bitwise combination of its member values.

public enum class __UserSettingsFlags

public enum class __UserSettingsFlags

enum __UserSettingsFlags

[System.Flags]
public enum __UserSettingsFlags

[<System.Flags>]
type __UserSettingsFlags = 

Public Enum __UserSettingsFlags

Inheritance

Enum

__UserSettingsFlags

Attributes

FlagsAttribute

Fields

Name	Value	Description
USF_None	0	Specifies that a VSPackage is free to either reset settings with valid imported values, or to treat settings import as an additive or merge operation.
USF_ResetOnImport	1	Specifies that a VSPackage should overwrite any existing settings with valid imported settings.
USF_DisableOptimizations	2	Specifies that a VSPackage should disable optimizations.

Remarks

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.

  -or-

  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:

enum __UserSettingsFlags  
{  
    USF_None                 = 0x00000000,  
    USF_ResetOnImport        = 0x00000001,  
    USF_DisableOptimizations = 0x00000002  
};  
typedef DWORD UserSettingsFlags;