Delen via

ISettingsManager.GetWriter Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Utilities.UnifiedSettings
Assembly:
Microsoft.VisualStudio.Utilities.dll
Package:
Microsoft.VisualStudio.Utilities v17.12.40391

Overloads

GetWriter(String)

Gets a reader/writer for the given caller.
GetWriter(String, Guid)

Gets a reader/writer for the given caller with a specified event source.

GetWriter(String)

Gets a reader/writer for the given caller.

public Microsoft.VisualStudio.Utilities.UnifiedSettings.ISettingsWriter GetWriter (string callerName);
abstract member GetWriter : string -> Microsoft.VisualStudio.Utilities.UnifiedSettings.ISettingsWriter
Public Function GetWriter (callerName As String) As ISettingsWriter

Parameters

callerName
String

The name of the component doing the writing, in human readable form. Examples: "Live Share", "Database Tools".

Returns

ISettingsWriter

Exceptions

ArgumentNullException

Thrown if callerName is null.

ArgumentException

Thrown if callerName is empty.

Applies to

GetWriter(String, Guid)

Gets a reader/writer for the given caller with a specified event source.

public Microsoft.VisualStudio.Utilities.UnifiedSettings.ISettingsWriter GetWriter (string callerName, Guid eventSource);
abstract member GetWriter : string * Guid -> Microsoft.VisualStudio.Utilities.UnifiedSettings.ISettingsWriter
Public Function GetWriter (callerName As String, eventSource As Guid) As ISettingsWriter

Parameters

callerName
String

The name of the component doing the writing, in human readable form. Examples: "Live Share", "Database Tools".

eventSource
Guid

Sets the value of EventSource for change events from this writer.

Returns

ISettingsWriter

Exceptions

ArgumentNullException

Thrown if callerName is null.

ArgumentException

Thrown if callerName is empty.

Applies to