ToolLocationHelper.GetPathToReferenceAssemblies Method

Reference

Definition

Namespace:: Microsoft.Build.Utilities

Assembly:: Microsoft.Build.Utilities.Core.dll

Assembly:: Microsoft.Build.Utilities.v4.0.dll

Package:: Microsoft.Build.Utilities.Core v15.9.20

Package:: Microsoft.Build.Utilities.Core v16.11.0

Package:: Microsoft.Build.Utilities.Core v17.9.5

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.

Gets the paths to the reference assemblies location for the given target framework.

Overloads

GetPathToReferenceAssemblies(String, String, String, String, String)	Returns the paths to the reference assemblies location for the given target framework. This method will assume the requested ReferenceAssemblyRoot path will be the ProgramFiles directory specified by Environment.SpecialFolder.ProgramFiles In addition when the .NETFramework or .NET Framework targetFrameworkIdentifiers are seen and targetFrameworkVersion is 2.0, 3.0, 3.5 or 4.0 we will return the correctly chained reference assembly paths for the legacy .net frameworks. This chaining will use the existing GetPathToDotNetFrameworkReferenceAssemblies to build up the list of reference assembly paths.
GetPathToReferenceAssemblies(FrameworkName)	Returns the paths to the reference assemblies location for the given target framework. This method will assume the requested ReferenceAssemblyRoot path will be the ProgramFiles directory specified by Environment.SpecialFolder.ProgramFiles In additon when the .NETFramework or .NET Framework targetFrameworkIdentifiers are seen and targetFrameworkVersion is 2.0, 3.0, 3.5 or 4.0 we will return the correctly chained reference assembly paths for the legacy .net frameworks. This chaining will use the existing GetPathToDotNetFrameworkReferenceAssemblies to build up the list of reference assembly paths.
GetPathToReferenceAssemblies(String, FrameworkName)	Returns the paths to the reference assemblies location for the given framework version relative to a given targetFrameworkRoot. The method will not check to see if the path exists or not.
GetPathToReferenceAssemblies(String, String, FrameworkName)	Returns the paths to the reference assemblies location for the given framework version relative to a given targetFrameworkRoot. The method will not check to see if the path exists or not.
GetPathToReferenceAssemblies(String, String, String)	Returns the paths to the reference assemblies location for the given target framework. This method will assume the requested ReferenceAssemblyRoot path will be the ProgramFiles directory specified by Environment.SpecialFolder.ProgramFiles In additon when the .NETFramework or .NET Framework targetFrameworkIdentifiers are seen and targetFrameworkVersion is 2.0, 3.0, 3.5 or 4.0 we will return the correctly chained reference assembly paths for the legacy .net frameworks. This chaining will use the existing GetPathToDotNetFrameworkReferenceAssemblies to build up the list of reference assembly paths.
GetPathToReferenceAssemblies(String, String, String, String)	Returns the paths to the reference assemblies location for the given target framework. This method will assume the requested ReferenceAssemblyRoot path will be the ProgramFiles directory specified by Environment.SpecialFolder.ProgramFiles In additon when the .NETFramework or .NET Framework targetFrameworkIdentifiers are seen and targetFrameworkVersion is 2.0, 3.0, 3.5 or 4.0 we will return the correctly chained reference assembly paths for the legacy .net frameworks. This chaining will use the existing GetPathToDotNetFrameworkReferenceAssemblies to build up the list of reference assembly paths.

GetPathToReferenceAssemblies(String, String, String, String, String)

Returns the paths to the reference assemblies location for the given target framework. This method will assume the requested ReferenceAssemblyRoot path will be the ProgramFiles directory specified by Environment.SpecialFolder.ProgramFiles In addition when the .NETFramework or .NET Framework targetFrameworkIdentifiers are seen and targetFrameworkVersion is 2.0, 3.0, 3.5 or 4.0 we will return the correctly chained reference assembly paths for the legacy .net frameworks. This chaining will use the existing GetPathToDotNetFrameworkReferenceAssemblies to build up the list of reference assembly paths.

public:
 static System::Collections::Generic::IList<System::String ^> ^ GetPathToReferenceAssemblies(System::String ^ targetFrameworkIdentifier, System::String ^ targetFrameworkVersion, System::String ^ targetFrameworkProfile, System::String ^ targetFrameworkRootPath, System::String ^ targetFrameworkFallbackSearchPaths);

public static System.Collections.Generic.IList<string> GetPathToReferenceAssemblies (string targetFrameworkIdentifier, string targetFrameworkVersion, string targetFrameworkProfile, string targetFrameworkRootPath, string targetFrameworkFallbackSearchPaths);

static member GetPathToReferenceAssemblies : string * string * string * string * string -> System.Collections.Generic.IList<string>

Public Shared Function GetPathToReferenceAssemblies (targetFrameworkIdentifier As String, targetFrameworkVersion As String, targetFrameworkProfile As String, targetFrameworkRootPath As String, targetFrameworkFallbackSearchPaths As String) As IList(Of String)

Parameters

targetFrameworkIdentifier: String

Identifier being targeted

targetFrameworkVersion: String

Version being targeted

targetFrameworkProfile: String

Profile being targeted

targetFrameworkRootPath: String

Root directory which will be used to calculate the reference assembly path. The references assemblies will be generated in the following way TargetFrameworkRootPath\TargetFrameworkIdentifier\TargetFrameworkVersion\SubType\TargetFrameworkSubType. Uses the default path if this is null.

targetFrameworkFallbackSearchPaths: String

';' separated list of paths that are looked up if the framework cannot be found in targetFrameworkRootPath

Returns

IList<String>

Collection of reference assembly locations.

Exceptions

ArgumentNullException

When the frameworkName is null

Remarks

This method assumes the requested ReferenceAssemblyRoot path is the ProgramFiles directory specified by Environment.SpecialFolder.ProgramFiles. In addition, when the .NETFramework or .NET Framework targetFrameworkIdentifiers are seen and targetFrameworkVersion is 2.0, 3.0, 3.5, or 4.0, it returns the correctly chained reference assembly paths for the legacy .NET frameworks. This chaining uses the existing GetPathToDotNetFrameworkReferenceAssemblies to build up the list of reference assembly paths.

Applies to

GetPathToReferenceAssemblies(FrameworkName)

Returns the paths to the reference assemblies location for the given target framework. This method will assume the requested ReferenceAssemblyRoot path will be the ProgramFiles directory specified by Environment.SpecialFolder.ProgramFiles In additon when the .NETFramework or .NET Framework targetFrameworkIdentifiers are seen and targetFrameworkVersion is 2.0, 3.0, 3.5 or 4.0 we will return the correctly chained reference assembly paths for the legacy .net frameworks. This chaining will use the existing GetPathToDotNetFrameworkReferenceAssemblies to build up the list of reference assembly paths.

public:
 static System::Collections::Generic::IList<System::String ^> ^ GetPathToReferenceAssemblies(System::Runtime::Versioning::FrameworkName ^ frameworkName);

public static System.Collections.Generic.IList<string> GetPathToReferenceAssemblies (System.Runtime.Versioning.FrameworkName frameworkName);

static member GetPathToReferenceAssemblies : System.Runtime.Versioning.FrameworkName -> System.Collections.Generic.IList<string>

Public Shared Function GetPathToReferenceAssemblies (frameworkName As FrameworkName) As IList(Of String)

Parameters

frameworkName: FrameworkName

Framework required

Returns

IList<String>

Collection of reference assembly locations.

Exceptions

ArgumentNullException

When the frameworkName is null

Remarks

This method assumes that the requested ReferenceAssemblyRoot path will be the ProgramFiles directory that is specified by Environment.SpecialFolder.ProgramFiles. In addition, when the .NETFramework or .NET Framework targetFrameworkIdentifiers are seen and targetFrameworkVersion is 2.0, 3.0, 3.5, or 4, the correctly chained reference assembly paths for the legacy .NET Framework versions will be returned. This chaining will use the existing GetPathToDotNetFrameworkReferenceAssemblies to build up the list of reference assembly paths.

Applies to

GetPathToReferenceAssemblies(String, FrameworkName)

Returns the paths to the reference assemblies location for the given framework version relative to a given targetFrameworkRoot. The method will not check to see if the path exists or not.

public:
 static System::Collections::Generic::IList<System::String ^> ^ GetPathToReferenceAssemblies(System::String ^ targetFrameworkRootPath, System::Runtime::Versioning::FrameworkName ^ frameworkName);

public static System.Collections.Generic.IList<string> GetPathToReferenceAssemblies (string targetFrameworkRootPath, System.Runtime.Versioning.FrameworkName frameworkName);

static member GetPathToReferenceAssemblies : string * System.Runtime.Versioning.FrameworkName -> System.Collections.Generic.IList<string>

Public Shared Function GetPathToReferenceAssemblies (targetFrameworkRootPath As String, frameworkName As FrameworkName) As IList(Of String)

Parameters

targetFrameworkRootPath: String

frameworkName: FrameworkName

A frameworkName class which represents a TargetFrameworkMoniker. This cannot be null.

Returns

IList<String>

Collection of reference assembly locations.

Remarks

This method does not check to see if the path exists or not.

Applies to

GetPathToReferenceAssemblies(String, String, FrameworkName)

Returns the paths to the reference assemblies location for the given framework version relative to a given targetFrameworkRoot. The method will not check to see if the path exists or not.

public:
 static System::Collections::Generic::IList<System::String ^> ^ GetPathToReferenceAssemblies(System::String ^ targetFrameworkRootPath, System::String ^ targetFrameworkFallbackSearchPaths, System::Runtime::Versioning::FrameworkName ^ frameworkName);

public static System.Collections.Generic.IList<string> GetPathToReferenceAssemblies (string targetFrameworkRootPath, string targetFrameworkFallbackSearchPaths, System.Runtime.Versioning.FrameworkName frameworkName);

static member GetPathToReferenceAssemblies : string * string * System.Runtime.Versioning.FrameworkName -> System.Collections.Generic.IList<string>

Public Shared Function GetPathToReferenceAssemblies (targetFrameworkRootPath As String, targetFrameworkFallbackSearchPaths As String, frameworkName As FrameworkName) As IList(Of String)

Parameters

targetFrameworkRootPath: String

targetFrameworkFallbackSearchPaths: String

';' separated list of paths that are looked up if the framework cannot be found in @targetFrameworkRootPath

frameworkName: FrameworkName

A frameworkName class which represents a TargetFrameworkMoniker. This cannot be null.

Returns

IList<String>

Collection of reference assembly locations.

Applies to

GetPathToReferenceAssemblies(String, String, String)

Returns the paths to the reference assemblies location for the given target framework. This method will assume the requested ReferenceAssemblyRoot path will be the ProgramFiles directory specified by Environment.SpecialFolder.ProgramFiles In additon when the .NETFramework or .NET Framework targetFrameworkIdentifiers are seen and targetFrameworkVersion is 2.0, 3.0, 3.5 or 4.0 we will return the correctly chained reference assembly paths for the legacy .net frameworks. This chaining will use the existing GetPathToDotNetFrameworkReferenceAssemblies to build up the list of reference assembly paths.

public:
 static System::Collections::Generic::IList<System::String ^> ^ GetPathToReferenceAssemblies(System::String ^ targetFrameworkIdentifier, System::String ^ targetFrameworkVersion, System::String ^ targetFrameworkProfile);

public static System.Collections.Generic.IList<string> GetPathToReferenceAssemblies (string targetFrameworkIdentifier, string targetFrameworkVersion, string targetFrameworkProfile);

static member GetPathToReferenceAssemblies : string * string * string -> System.Collections.Generic.IList<string>

Public Shared Function GetPathToReferenceAssemblies (targetFrameworkIdentifier As String, targetFrameworkVersion As String, targetFrameworkProfile As String) As IList(Of String)

Parameters

targetFrameworkIdentifier: String

Identifier being targeted

targetFrameworkVersion: String

Version being targeted

targetFrameworkProfile: String

Profile being targeted

Returns

IList<String>

Collection of reference assembly locations.

Exceptions

ArgumentNullException

When the frameworkName is null

Applies to

GetPathToReferenceAssemblies(String, String, String, String)

Returns the paths to the reference assemblies location for the given target framework. This method will assume the requested ReferenceAssemblyRoot path will be the ProgramFiles directory specified by Environment.SpecialFolder.ProgramFiles In additon when the .NETFramework or .NET Framework targetFrameworkIdentifiers are seen and targetFrameworkVersion is 2.0, 3.0, 3.5 or 4.0 we will return the correctly chained reference assembly paths for the legacy .net frameworks. This chaining will use the existing GetPathToDotNetFrameworkReferenceAssemblies to build up the list of reference assembly paths.

public:
 static System::Collections::Generic::IList<System::String ^> ^ GetPathToReferenceAssemblies(System::String ^ targetFrameworkIdentifier, System::String ^ targetFrameworkVersion, System::String ^ targetFrameworkProfile, System::String ^ targetFrameworkRootPath);

public static System.Collections.Generic.IList<string> GetPathToReferenceAssemblies (string targetFrameworkIdentifier, string targetFrameworkVersion, string targetFrameworkProfile, string targetFrameworkRootPath);

static member GetPathToReferenceAssemblies : string * string * string * string -> System.Collections.Generic.IList<string>

Public Shared Function GetPathToReferenceAssemblies (targetFrameworkIdentifier As String, targetFrameworkVersion As String, targetFrameworkProfile As String, targetFrameworkRootPath As String) As IList(Of String)

Parameters

targetFrameworkIdentifier: String

Identifier being targeted

targetFrameworkVersion: String

Version being targeted

targetFrameworkProfile: String

Profile being targeted

targetFrameworkRootPath: String

Returns

IList<String>

Collection of reference assembly locations.

Exceptions

ArgumentNullException

When the frameworkName is null

Applies to

ToolLocationHelper.GetPathToReferenceAssemblies Method

Definition

Overloads

GetPathToReferenceAssemblies(String, String, String, String, String)

Parameters

Returns

Exceptions

Remarks

Applies to

GetPathToReferenceAssemblies(FrameworkName)

Parameters

Returns

Exceptions

Remarks

Applies to

GetPathToReferenceAssemblies(String, FrameworkName)

Parameters

Returns

Remarks

Applies to

GetPathToReferenceAssemblies(String, String, FrameworkName)

Parameters

Returns

Applies to

GetPathToReferenceAssemblies(String, String, String)

Parameters

Returns

Exceptions

Applies to

GetPathToReferenceAssemblies(String, String, String, String)

Parameters

Returns

Exceptions

Applies to

その他のリソース