Visual Studio Setup Configuration Samples

The included samples show how to use the new setup configuration API for discovering instances of Visual Studio 2017 and newer.

Visual Studio Instances

You can install multiple instances of Visual Studio with different workloads, or from different channels or versions. The majority of components are now lightweight installs using the same container format as VSIX packages for faster installs and cleaner uninstalls.

This change to the Visual Studio platform requires new ways of discovering Visual Studio where simple registry detection does not provide the flexibility required in many scenarios.

The new setup configuration API provides simple access for native and managed code, as well as a means to output JSON, XML, or other formats for consumption in batch or PowerShell scripts.

Available Packages

The following packages are available on nuget.org that provide access to the setup configuration API.

• Microsoft.VisualStudio.Setup.Configuration.Native

  Adds the header location and automatically links the library. You only need to add the #include as shown below.

  #include <Setup.Configuration.h>

• Microsoft.VisualStudio.Setup.Configuration.Interop

  Provides embeddable interop types. If the interop types are embedded you do not need to redistribute additional assemblies. Simply instantiate the SetupConfiguration runtime callable wrapper (RCW) as shown below.

  var configuration = new SetupConfiguration();

Updates

For the most recent updates to these samples, please see https://github.com/microsoft/vs-setup-samples.

Related

We have published a number of related projects that are intended for real-world scenarios and may show a more extensive use of the APIs than shown in these samples.

• VSSetup.PowerShell PowerShell module to interact with Visual Studio Setup
• VSIXBootstrapper An installer that can be chained with other packages to locate the latest VSIXInstaller.exe to use for installing VSIX extensions
• vswhere Locate Visual Studio 2017 and newer installations

License

Licensed under the MIT license. See LICENSE.txt in the project root for license information.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.