Partager via


WritableSettingsStore.SetString Method

Updates the value of the specified property to the given string value while setting its data type to [!:SettingsType.String].

Namespace:  Microsoft.VisualStudio.Settings
Assemblies:   Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
  Microsoft.VisualStudio.Settings (in Microsoft.VisualStudio.Settings.dll)

Syntax

'Declaration
Public MustOverride Sub SetString ( _
    collectionPath As String, _
    propertyName As String, _
    value As String _
)
public abstract void SetString(
    string collectionPath,
    string propertyName,
    string value
)
public:
virtual void SetString(
    String^ collectionPath, 
    String^ propertyName, 
    String^ value
) abstract
abstract SetString : 
        collectionPath:string * 
        propertyName:string * 
        value:string -> unit
public abstract function SetString(
    collectionPath : String, 
    propertyName : String, 
    value : String
)

Parameters

  • collectionPath
    Type: String

    Path of the collection of the property.

  • propertyName
    Type: String

    Name of the property.

  • value
    Type: String

    New value of the property.

Exceptions

Exception Condition
ArgumentException

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

Remarks

If the previous data type of the property is different, it overwrites it.

If the property does not exist, it creates one.

.NET Framework Security

See Also

Reference

WritableSettingsStore Class

Microsoft.VisualStudio.Settings Namespace