GetInstalledSDKLocations Class

  • Article

Gathers the list of installed SDKS in the registry and on disk and outputs them into the project so they can be used during SDK reference resolution and RAR for single files.

GetInstalledSDKLocations doesn't recognize a version folder if “v” appears in its name. For example, an SDK that's located at C:\Windows\Program Files\Microsoft SDKs\Windows\8.0\SDKFolders\3rdPartySDK\2.5\will be located correctly. However, the same SDK located atC:\Windows\Program Files\Microsoft SDKs\Windows\8.0\SDKFolders\3rdPartySDK\v2.5\won't be located and will be ignored. If an SDK is ignored, the failure won't be recorded in the log, and no error will be thrown.

Version folder names need to be formed as major.minor[.build[.revision]]. For more information, see TryParse.

To find an SDK with a particular version, the version sought must match the version requested. For example, if the SDK has a folder version name 8.0.0 and the customer requested the SDK with version 8.0, there is no match, and the SDK won't be found.

For more information on version matching, see CompareTo.

MSBuild is now included in Visual Studio instead of the .NET Framework.You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.

Inheritance Hierarchy

System.Object
  Microsoft.Build.Utilities.Task
    Microsoft.Build.Tasks.TaskExtension
      Microsoft.Build.Tasks.GetInstalledSDKLocations

Namespace:  Microsoft.Build.Tasks
Assembly:  Microsoft.Build.Tasks.Core (in Microsoft.Build.Tasks.Core.dll)

Syntax

'Declaration
Public Class GetInstalledSDKLocations _
    Inherits TaskExtension

public class GetInstalledSDKLocations : TaskExtension

public ref class GetInstalledSDKLocations : public TaskExtension

type GetInstalledSDKLocations =  
    class 
        inherit TaskExtension 
    end

public class GetInstalledSDKLocations extends TaskExtension

The GetInstalledSDKLocations type exposes the following members.

Constructors

  Name Description
Public method GetInstalledSDKLocations Creates a new instance of GetInstalledSDKLocations.MSBuild is now included in Visual Studio instead of the .NET Framework.You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.

Top

Properties

  Name Description
Public property BuildEngine Gets or sets the instance of the IBuildEngine object used by the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property BuildEngine2 Gets the instance of the IBuildEngine2 object used by the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property BuildEngine3 Gets the instance of the IBuildEngine3 object used by the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property BuildEngine4 Gets the instance of the IBuildEngine4 object used by the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Protected property HelpKeywordPrefix Gets or sets the prefix used to compose Help keywords from resource names.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property HostObject Gets or sets the host object associated with the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property InstalledSDKs Gets or sets the set of items that represent all of the installed SDKs found in the SDKDirectory and SDKRegistry roots. The itemspec is the SDK install location. There is a piece of metadata called SDKName which contains the name of the SDK.MSBuild is now included in Visual Studio instead of the .NET Framework.You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property Log Infrastructure. Gets an instance of a TaskLoggingHelperExtension containing task logging methods.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from TaskExtension.)
Public property SDKDirectoryRoots Gets or sets the root directory on disk in which to look for SDKs.MSBuild is now included in Visual Studio instead of the .NET Framework.You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property SDKExtensionDirectoryRoots Gets or sets the root directories on disk to look for new style extension SDKs.
Public property SDKRegistryRoot Gets or sets the root registry root in which to look for SDKs.MSBuild is now included in Visual Studio instead of the .NET Framework.You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property TargetPlatformIdentifier Gets the platform identifier we are targeting.MSBuild is now included in Visual Studio instead of the .NET Framework.You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property TargetPlatformVersion Gets the platform version we are targeting.MSBuild is now included in Visual Studio instead of the .NET Framework.You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Protected property TaskResources Gets or sets the culture-specific resources associated with the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Public method Execute Get the SDKs.MSBuild is now included in Visual Studio instead of the .NET Framework.You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides Task.Execute().)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Build.Tasks Namespace