ISettingsWriter.Commit(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Utilities.UnifiedSettings

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.

Caution

This method will be removed. Use RequestCommit instead.

This method is deprecated. Use RequestCommit(String) instead. Commits all queued changes. This may require user approval to complete. In that case, this method will return immediately and the commit will complete later once the user has approved it.

[System.Obsolete("This method will be removed. Use RequestCommit instead.")]
public Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingCommitResult Commit (string changeDescription);

[<System.Obsolete("This method will be removed. Use RequestCommit instead.")>]
abstract member Commit : string -> Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingCommitResult

Public Function Commit (changeDescription As String) As SettingCommitResult

Parameters

changeDescription: String

A human-readable, localized description of the change. Example: "migration from a previous version".

Returns

SettingCommitResult

Attributes: ObsoleteAttribute

Exceptions

ArgumentNullException

Thrown if changeDescription is null.

ArgumentException

Thrown if changeDescription is empty.

Applies to

Delen via