IWorkspaceSettingsManager.GetAggregatedSettings(String, String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
the settings reader (note that when reading the settings hierarchy is already applied, the consumer should not differentiate between where property is defined on use). The object returned by this property is immutable. when changes happen a new object will be create (and OnWorkspaceSettingsChanged fired).
will apply build in inheritance override rules(aka PerUser > PerWorkspace > PerMachine) and return the winning value for a named property, array or child settings
Microsoft::VisualStudio::Workspace::Settings::IWorkspaceSettings GetAggregatedSettings(std::wstring const & type, std::wstring const & scopePath = null);
public Microsoft.VisualStudio.Workspace.Settings.IWorkspaceSettings GetAggregatedSettings (string type, string scopePath = default);
public Microsoft.VisualStudio.Workspace.Settings.IWorkspaceSettings GetAggregatedSettings (string type, string? scopePath = default);
abstract member GetAggregatedSettings : string * string -> Microsoft.VisualStudio.Workspace.Settings.IWorkspaceSettings
Public Function GetAggregatedSettings (type As String, Optional scopePath As String = Nothing) As IWorkspaceSettings
Parameters
- type
- String
settings type (corresponding to the independent settings file name) Use SettingsTypes class constants
- scopePath
- String
location under workspace we require the settings for. Note that because of hierarchical aggregation model different parts of the workspace tree will have different settings values.
Returns
settings reader