Delen via


ExternalSettingOperationResult<T>.Failure Constructor

Definition

Constructs an instance of ExternalSettingOperationResult<T> representing a failed operation.

public Failure (string errorMessage, Microsoft.VisualStudio.Utilities.UnifiedSettings.ExternalSettingsErrorScope scope, bool isTransient);
new Microsoft.VisualStudio.Utilities.UnifiedSettings.ExternalSettingOperationResult<'T>.Failure : string * Microsoft.VisualStudio.Utilities.UnifiedSettings.ExternalSettingsErrorScope * bool -> Microsoft.VisualStudio.Utilities.UnifiedSettings.ExternalSettingOperationResult<'T>.Failure
Public Sub New (errorMessage As String, scope As ExternalSettingsErrorScope, isTransient As Boolean)

Parameters

errorMessage
String

A localized error message to display. May include links to other settings or categories using a markdown- like syntax: "Here is a link to another setting" where settingMoniker is the full hierarchical moniker of a normal setting or category (e.g. "environment.visualExperience.colorTheme") or the moniker of another setting in the same external region as this one.

scope
ExternalSettingsErrorScope

Indicates whether this error applies only to this specific setting (so operations on other settings in the same external region would be expected to succeed) or to the entire external region.

isTransient
Boolean

True if the error may be resolved (spontaneously or by user action); false if it should be considered a permanent condition.

Applies to