Share via

Toolset.GenerateSubToolsetVersion Method

  • Reference

Definition

Namespace:
Microsoft.Build.Evaluation
Assembly:
Microsoft.Build.dll
Package:
Microsoft.Build v15.9.20
Package:
Microsoft.Build v16.11.0
Package:
Microsoft.Build v17.11.4

Creates the sub toolset version to be used with this toolset.

Overloads

GenerateSubToolsetVersion()

Generates the sub-toolset version to be used with this toolset. Sub-toolset version is based on:

  1. If "VisualStudioVersion" is set as a property on the toolset itself (global or environment), use that.
  2. Otherwise, use the default sub-toolset version for this toolset.

The sub-toolset version returned may be null; if so, that means that no sub-toolset should be used, just the base toolset on its own. The sub-toolset version returned may not map to an existing sub-toolset.
GenerateSubToolsetVersion(IDictionary<String,String>, Int32)

Generates the sub-toolset version to be used with this toolset. Sub-toolset version is based on:

  1. If the "VisualStudioVersion" global property exists in the set of properties passed to us, use it.
  2. Otherwise, if "VisualStudioVersion" is set as a property on the toolset itself (global or environment), use that.
  3. Otherwise, use Visual Studio version from solution file if it maps to an existing sub-toolset.
  4. Otherwise, use the default sub-toolset version for this toolset.

The sub-toolset version returned may be null; if so, that means that no sub-toolset should be used, just the base toolset on its own. The sub-toolset version returned may not map to an existing sub-toolset.

The global properties dictionary may be null.

GenerateSubToolsetVersion()

Source:
Toolset.cs

Generates the sub-toolset version to be used with this toolset. Sub-toolset version is based on:

  1. If "VisualStudioVersion" is set as a property on the toolset itself (global or environment), use that.
  2. Otherwise, use the default sub-toolset version for this toolset.

The sub-toolset version returned may be null; if so, that means that no sub-toolset should be used, just the base toolset on its own. The sub-toolset version returned may not map to an existing sub-toolset.

public:
 System::String ^ GenerateSubToolsetVersion();
public string GenerateSubToolsetVersion ();
member this.GenerateSubToolsetVersion : unit -> string
Public Function GenerateSubToolsetVersion () As String

Returns

String

The sub toolset version to be used with this toolset.

Remarks

If "VisualStudioVersion" is set as a property on the toolset itself, then sub toolset version is set to "VisualStudioVersion".

Otherwise, sub toolset version is set to the DefaultSubToolsetVersion of the toolset.

Applies to

GenerateSubToolsetVersion(IDictionary<String,String>, Int32)

Source:
Toolset.cs

Generates the sub-toolset version to be used with this toolset. Sub-toolset version is based on:

  1. If the "VisualStudioVersion" global property exists in the set of properties passed to us, use it.
  2. Otherwise, if "VisualStudioVersion" is set as a property on the toolset itself (global or environment), use that.
  3. Otherwise, use Visual Studio version from solution file if it maps to an existing sub-toolset.
  4. Otherwise, use the default sub-toolset version for this toolset.

The sub-toolset version returned may be null; if so, that means that no sub-toolset should be used, just the base toolset on its own. The sub-toolset version returned may not map to an existing sub-toolset.

The global properties dictionary may be null.

public:
 System::String ^ GenerateSubToolsetVersion(System::Collections::Generic::IDictionary<System::String ^, System::String ^> ^ overrideGlobalProperties, int solutionVersion);
public string GenerateSubToolsetVersion (System.Collections.Generic.IDictionary<string,string> overrideGlobalProperties, int solutionVersion);
member this.GenerateSubToolsetVersion : System.Collections.Generic.IDictionary<string, string> * int -> string
Public Function GenerateSubToolsetVersion (overrideGlobalProperties As IDictionary(Of String, String), solutionVersion As Integer) As String

Parameters

overrideGlobalProperties
IDictionary<String,String>

Set of global properties to use to create the sub toolset version. May be null.

solutionVersion
Int32

The solution version to use to create the sub toolset version.

Returns

String

The sub toolset version.

Remarks

If the "VisualStudioVersion" global property exists in the set of global properties passed in, then sub toolset version is set to "VisualStudioVersion".

Otherwise, if "VisualStudioVersion" is set as a property on the toolset itself, then sub toolset version is set to "VisualStudioVersion".

Otherwise, if the Visual Studio version corresponding to the solution version (Visual Studio version = solution version - 1) passed in maps to an existing sub toolset, then sub toolset version is set to the Visual Studio version.

Otherwise, sub toolset version is set to the DefaultSubToolsetVersion of the toolset.

Applies to