SdkResultFactory.IndicateSuccess Method
Definition
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.
Overloads
| IndicateSuccess(String, String, IEnumerable<String>) |
Create an SdkResolver object indicating success resolving the SDK. |
| IndicateSuccess(IEnumerable<String>, String, IDictionary<String,String>, IDictionary<String,SdkResultItem>, IEnumerable<String>) |
Create an SdkResolver object indicating success. |
| IndicateSuccess(String, String, IDictionary<String,String>, IDictionary<String,SdkResultItem>, IEnumerable<String>) |
Create an SdkResolver object indicating success resolving the SDK. |
IndicateSuccess(String, String, IEnumerable<String>)
- Source:
- SdkResultFactory.cs
Create an SdkResolver object indicating success resolving the SDK.
public abstract Microsoft.Build.Framework.SdkResult IndicateSuccess (string path, string version, System.Collections.Generic.IEnumerable<string> warnings = default);abstract member IndicateSuccess : string * string * seq<string> -> Microsoft.Build.Framework.SdkResultPublic MustOverride Function IndicateSuccess (path As String, version As String, Optional warnings As IEnumerable(Of String) = Nothing) As SdkResultParameters
- path
- String
Path to the SDK.
- version
- String
Version of the SDK that was resolved.
- warnings
- IEnumerable<String>
Optional warnings to display during resolution.
Returns
Applies to
IndicateSuccess(IEnumerable<String>, String, IDictionary<String,String>, IDictionary<String,SdkResultItem>, IEnumerable<String>)
- Source:
- SdkResultFactory.cs
Create an SdkResolver object indicating success.
public virtual Microsoft.Build.Framework.SdkResult IndicateSuccess (System.Collections.Generic.IEnumerable<string> paths, string version, System.Collections.Generic.IDictionary<string,string> propertiesToAdd = default, System.Collections.Generic.IDictionary<string,Microsoft.Build.Framework.SdkResultItem> itemsToAdd = default, System.Collections.Generic.IEnumerable<string> warnings = default);abstract member IndicateSuccess : seq<string> * string * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, Microsoft.Build.Framework.SdkResultItem> * seq<string> -> Microsoft.Build.Framework.SdkResult
override this.IndicateSuccess : seq<string> * string * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, Microsoft.Build.Framework.SdkResultItem> * seq<string> -> Microsoft.Build.Framework.SdkResultPublic Overridable Function IndicateSuccess (paths As IEnumerable(Of String), version As String, Optional propertiesToAdd As IDictionary(Of String, String) = Nothing, Optional itemsToAdd As IDictionary(Of String, SdkResultItem) = Nothing, Optional warnings As IEnumerable(Of String) = Nothing) As SdkResultParameters
- paths
- IEnumerable<String>
SDK paths which should be imported
- version
- String
SDK version which should be imported
- propertiesToAdd
- IDictionary<String,String>
Properties to set in the evaluation
- itemsToAdd
- IDictionary<String,SdkResultItem>
Items to add to the evaluation
- warnings
- IEnumerable<String>
Optional warnings to display during resolution.
Returns
Remarks
This overload allows any number (zero, one, or many) of SDK paths to be returned. This means a "successful" result may not resolve to any SDKs. The resolver can also supply properties or items to communicate information to the build. This can allow resolvers to report SDKs that could not be resolved without hard-failing the evaluation, which can allow other components to take more appropriate action (for example installing optional workloads or downloading NuGet SDKs).
Applies to
IndicateSuccess(String, String, IDictionary<String,String>, IDictionary<String,SdkResultItem>, IEnumerable<String>)
- Source:
- SdkResultFactory.cs
Create an SdkResolver object indicating success resolving the SDK.
public virtual Microsoft.Build.Framework.SdkResult IndicateSuccess (string path, string version, System.Collections.Generic.IDictionary<string,string> propertiesToAdd, System.Collections.Generic.IDictionary<string,Microsoft.Build.Framework.SdkResultItem> itemsToAdd, System.Collections.Generic.IEnumerable<string> warnings = default);abstract member IndicateSuccess : string * string * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, Microsoft.Build.Framework.SdkResultItem> * seq<string> -> Microsoft.Build.Framework.SdkResult
override this.IndicateSuccess : string * string * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, Microsoft.Build.Framework.SdkResultItem> * seq<string> -> Microsoft.Build.Framework.SdkResultPublic Overridable Function IndicateSuccess (path As String, version As String, propertiesToAdd As IDictionary(Of String, String), itemsToAdd As IDictionary(Of String, SdkResultItem), Optional warnings As IEnumerable(Of String) = Nothing) As SdkResultParameters
- path
- String
Path to the SDK.
- version
- String
Version of the SDK that was resolved.
- propertiesToAdd
- IDictionary<String,String>
Properties to set in the evaluation
- itemsToAdd
- IDictionary<String,SdkResultItem>
Items to add to the evaluation
- warnings
- IEnumerable<String>
Optional warnings to display during resolution.