Share via


WritableSettingsStore.DeleteCollection Method

Deletes the given collection recursively deleting all of the sub-collections and properties in it. If the collection does not exist or an empty string ("") is passed then the method returns false.

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

Syntax

'Declaration
Public MustOverride Function DeleteCollection ( _
    collectionPath As String _
) As Boolean
public abstract bool DeleteCollection(
    string collectionPath
)
public:
virtual bool DeleteCollection(
    String^ collectionPath
) abstract
abstract DeleteCollection : 
        collectionPath:string -> bool
public abstract function DeleteCollection(
    collectionPath : String
) : boolean

Parameters

  • collectionPath
    Type: System.String

    Path of the collection to be deleted.

Return Value

Type: System.Boolean

.NET Framework Security

See Also

Reference

WritableSettingsStore Class

Microsoft.VisualStudio.Settings Namespace