IVsWritableSettingsStore.DeleteCollection(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assemblies:: Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assemblies:: Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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 a collection, as well as all its properties and sub-collections.

public:
 int DeleteCollection(System::String ^ collectionPath);

public:
 int DeleteCollection(Platform::String ^ collectionPath);

int DeleteCollection(std::wstring const & collectionPath);

public int DeleteCollection (string collectionPath);

abstract member DeleteCollection : string -> int

Public Function DeleteCollection (collectionPath As String) As Integer

Parameters

collectionPath: String

[in] The path to the collection to delete.

Returns

Int32

Returns S_OK if the collection was deleted. If the collection does not exist or an empty string ("") is passed, returns S_FALSE.

Remarks

This method is safe to access from any thread.

Applies to

Share via