Share via


IVsWritableSettingsStore.DeleteCollection(String) Method

Definition

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

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