WritableSettingsStore.DeleteProperty(String, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Settings

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Deletes the given property from the collection. If the property or the collection does not exist then the method returns false.

public:
 abstract bool DeleteProperty(System::String ^ collectionPath, System::String ^ propertyName);

public:
 abstract bool DeleteProperty(Platform::String ^ collectionPath, Platform::String ^ propertyName);

 abstract bool DeleteProperty(std::wstring const & collectionPath, std::wstring const & propertyName);

public abstract bool DeleteProperty (string collectionPath, string propertyName);

abstract member DeleteProperty : string * string -> bool

Public MustOverride Function DeleteProperty (collectionPath As String, propertyName As String) As Boolean

Parameters

collectionPath

String

Collection that contains the property to be deleted.

propertyName

String

Name of the property.

Returns

Boolean

Result of the deletion.

Remarks

This method is safe to access from any thread.