WritableSettingsStore.DeleteCollection(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Settings

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

public:
 abstract bool DeleteCollection(System::String ^ collectionPath);

public:
 abstract bool DeleteCollection(Platform::String ^ collectionPath);

 abstract bool DeleteCollection(std::wstring const & collectionPath);

public abstract bool DeleteCollection (string collectionPath);

abstract member DeleteCollection : string -> bool

Public MustOverride Function DeleteCollection (collectionPath As String) As Boolean

Parameters

collectionPath: String

Path of the collection to be deleted.

Returns

Boolean

Result of the deletion.

Remarks

This method is safe to access from any thread.

Applies to

Share via