ISettingsService.DeleteSettingAsync(String, Guid) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Settings

Assembly:: Microsoft.VisualStudio.Utilities.dll

Package:: Microsoft.VisualStudio.Utilities 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 setting.

public:
 System::Threading::Tasks::Task<bool> ^ DeleteSettingAsync(System::String ^ settingName, Guid clientId);

public System.Threading.Tasks.Task<bool> DeleteSettingAsync (string settingName, Guid clientId);

abstract member DeleteSettingAsync : string * Guid -> System.Threading.Tasks.Task<bool>

Public Function DeleteSettingAsync (settingName As String, clientId As Guid) As Task(Of Boolean)

Parameters

settingName: String

The setting name (case insensitive)

clientId: Guid

The idenitifier of the client, included in the resulting change event

Returns

Task<Boolean>

Exceptions

InvalidOperationException

Thrown when this is called before InitAsync(String, Boolean, Int32, Guid, String).

Applies to

Compartilhar via