IVsWritableSettingsStore.DeleteProperty(String, 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.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 a property in a collection.

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

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

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

public int DeleteProperty (string collectionPath, string propertyName);

abstract member DeleteProperty : string * string -> int

Public Function DeleteProperty (collectionPath As String, propertyName As String) As Integer

Parameters

collectionPath: String

[in] The path to the collection.

propertyName: String

[in] The property to delete.

Returns

Int32

Returns S_OK if the property was deleted, or S_FALSE if the property or collection does not exist.

Remarks

This method is safe to access from any thread.

Applies to

Share via