Share via

WritableSettingsStore.SetBoolean Method

  • Article

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

Namespace:  Microsoft.VisualStudio.Settings
Assembly:  Microsoft.VisualStudio.Settings (in Microsoft.VisualStudio.Settings.dll)

Syntax

'Declaration
Public MustOverride Sub SetBoolean ( _
    collectionPath As String, _
    propertyName As String, _
    value As Boolean _
)

public abstract void SetBoolean(
    string collectionPath,
    string propertyName,
    bool value
)

public:
virtual void SetBoolean(
    String^ collectionPath, 
    String^ propertyName, 
    bool value
) abstract

abstract SetBoolean : 
        collectionPath:string * 
        propertyName:string * 
        value:bool -> unit 

public abstract function SetBoolean(
    collectionPath : String, 
    propertyName : String, 
    value : boolean
)

Parameters

  • collectionPath
    Type: System.String
    Path of the collection 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