WritableSettingsStore.SetString(String, String, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Settings

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Updates the value of the specified property to the given string value while setting its data type to String. If the previous data type of the property is different, it overwrites it. If the property does not exist it creates one.

public:
 abstract void SetString(System::String ^ collectionPath, System::String ^ propertyName, System::String ^ value);

public:
 abstract void SetString(Platform::String ^ collectionPath, Platform::String ^ propertyName, Platform::String ^ value);

 abstract void SetString(std::wstring const & collectionPath, std::wstring const & propertyName, std::wstring const & value);

public abstract void SetString (string collectionPath, string propertyName, string value);

abstract member SetString : string * string * string -> unit

Public MustOverride Sub SetString (collectionPath As String, propertyName As String, value As String)

Parameters

collectionPath

String

Path of the collection of the property.

propertyName

String

Name of the property.

value

String

New value of the property.

Exceptions

ArgumentException

If the collection does not exist, this exception is thrown.

Remarks

This method is safe to access from any thread.