{"id":17385,"date":"2017-11-02T10:36:29","date_gmt":"2017-11-02T17:36:29","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/vcblog\/?p=17385"},"modified":"2021-01-05T10:06:14","modified_gmt":"2021-01-05T10:06:14","slug":"customizing-your-environment-with-visual-c-and-open-folder","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/cppblog\/customizing-your-environment-with-visual-c-and-open-folder\/","title":{"rendered":"Customizing your Environment with Visual C++ and Open Folder"},"content":{"rendered":"

\u70b9\u8fd9\u91cc\u770b\u4e2d\u6587\u7248<\/a><\/p>\n

Ever since we shipped support for opening a folder of C++ code, the community has been asking for more control over their build and editing environments. \u00a0To achieve this, we have added new ways to customize your environment with CppProperties.json in the latest version of Visual Studio 2017<\/a>.<\/p>\n

This new customization surface enables you to use a broader variety of tools, write more succinct CppProperties files, and have powerful per-configuration customization similar to MSBuild.\u00a0 The topics below expand on several concepts described in the original C++ Open Folder<\/a> post.\u00a0 If you are not familiar with editing CppProperties.json, Launch.vs.json, and Tasks.vs.json it might be worth reading that post first.<\/p>\n

This post is a companion to our previous post on customizing your environment for CMake projects<\/a> so if you have already read it, you may find that some of this content will be similar since we strive to keep the experiences consistent.\u00a0 The most important differences are under \u201cWhat about Launch.vs.json and Tasks.vs.json\u201d regarding how to use configuration-specific variables.<\/p>\n

What\u2019s new in CppProperties.json<\/h3>\n

The heart of this new flexibility is inside your project\u2019s CppProperties.json file and it stems from two new concepts:<\/p>\n

    \n
  1. The ability to inherit a set of default environment variables globally or per configuration using the \u201cinheritEnvironments\u201d property.<\/li>\n
  2. The ability to define custom environment variables and their values globally or per configuration by defining an \u201cenvironments\u201d block.<\/li>\n<\/ol>\n

    Combining these new concepts with the existing ability to consume environment variables in CppProperties.json, launch.vs.json, and tasks.vs.json using the \u201c${env.VAR}\u201d syntax, provides a powerful mechanism for creating rich development environments.<\/p>\n

    Let\u2019s start with a quick example of how using this feature might look:<\/p>\n

    {\r\n  \/\/ The \"environments\" property is an array of key value pairs of the form\r\n  \/\/ { \"EnvVar1\": \"Value1\", \"EnvVar2\": \"Value2\" }\r\n  \"environments\": [\r\n    {\r\n      \"INCLUDE\": \"${workspaceRoot}\\\\src\\\\includes\"\r\n    }\r\n  ],\r\n\r\n  \"configurations\": [\r\n    {\r\n      \"inheritEnvironments\": [\r\n        \/\/ Inherit the MSVC 32-bit environment and toolchain.\r\n        \"msvc_x86\"\r\n      ],\r\n      \"name\": \"x86\",\r\n      \"includePath\": [\r\n        \/\/ Use the include path defined above.\r\n        \"${env.INCLUDE}\"\r\n      ],\r\n      \"defines\": [ \"WIN32\", \"_DEBUG\", \"UNICODE\", \"_UNICODE\" ],\r\n      \"intelliSenseMode\": \"msvc-x86\"\r\n    },\r\n    {\r\n      \"inheritEnvironments\": [\r\n        \/\/ Inherit the MSVC 64-bit environment and toolchain.\r\n        \"msvc_x64\"\r\n      ],\r\n      \"name\": \"x64\",\r\n      \"includePath\": [\r\n        \/\/ Use the include path defined above.\r\n        \"${env.INCLUDE}\"\r\n      ],\r\n      \"defines\": [ \"WIN32\", \"_DEBUG\", \"UNICODE\", \"_UNICODE\" ],\r\n      \"intelliSenseMode\": \"msvc-x64\"\r\n    }\r\n  ]\r\n}\r\n<\/pre>\n
    To unpack this a bit, this example defines two configurations that build with Microsoft\u2019s Visual C++ toolchain. The first builds for x86 (since it inherits the \u201cmsvc_x86\u201d environment) while the other builds for x64. It also defines an environment variable \u201cINCLUDE\u201d (line 6) that is used by both configurations.<\/p>\n
    Keep in mind, both the \u201cenvironments\u201d (line 4) and \u201cinheritEnvironments\u201d (lines 12 and 25) properties can be defined globally for all configurations, per configuration, or both. In the example above, the \u201cINCLUDE\u201d variable will be global and the \u201cinheritEnvironment\u201d property will only apply to each individual configuration.<\/p>\n
    The following environments are available today:<\/p>\n