Skip to content

Commit 255b779

Browse files
author
Colin Robertson
authored
Merge pull request #3648 from MicrosoftDocs/main637776089259770212
Repo sync for protected CLA branch
2 parents f0ac49d + 5380d3b commit 255b779

File tree

4 files changed

+77
-85
lines changed

4 files changed

+77
-85
lines changed

docs/build/walkthrough-header-units.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: "Learn more about C++ header units by converting a header file to a header unit by using Visual Studio 2019."
33
title: "Walkthrough: Build and import header units in Visual C++ projects"
4-
ms.date: "5/18/2021"
4+
ms.date: 01/10/2022
55
ms.custom: "conceptual"
66
author: "tylermsft"
77
ms.author: "twhitney"
@@ -12,7 +12,7 @@ helpviewer_keywords: ["import", "header unit", "ifc"]
1212

1313
This article is about building and importing header units by using Visual Studio 2019. See [Walkthrough: Import STL libraries as header units](walkthrough-import-stl-header-units.md) to learn specifically how to import Standard Template Library headers as header units.
1414

15-
Header units are the recommended alternative to [precompiled header files](creating-precompiled-header-files.md) (PCH). They're easier to set up and use than [shared PCH](https://devblogs.microsoft.com/cppblog/shared-pch-usage-sample-in-visual-studio), but they provide similar performance benefits. Unlike a PCH, when a header unit changes, only it and its dependencies are rebuilt.
15+
Header units are the recommended alternative to [precompiled header files](creating-precompiled-header-files.md) (PCH). They're easier to set up and use than a [shared PCH](https://devblogs.microsoft.com/cppblog/shared-pch-usage-sample-in-visual-studio), but they provide similar performance benefits. Unlike a PCH, when a header unit changes, only it and what depends on it are rebuilt.
1616

1717
## Prerequisites
1818

@@ -26,27 +26,27 @@ An important difference between a header unit and a header file is that header u
2626

2727
A similarity is that everything visible from a header file is also visible from a header unit.
2828

29-
Before you can import a header unit, you need to compile a header file into a header unit. An advantage of header units over PCH is that they can be used in distributed builds. For example, as long as you're using the same compiler to compile the *`.ifc`* and the program that imports it and are targeting the same platform and architecture, a header unit produced on one computer can be used on another.
29+
Before you can import a header unit, you need to compile a header file into a header unit. An advantage of header units over PCH is that they can be used in distributed builds. For example, as long as you compile the *`.ifc`* and the program that imports it with the same compiler, and target the same platform and architecture, a header unit produced on one computer can be used on another.
3030

31-
Another advantage of header units over PCH is that there's more flexibility for the compiler flags used to compile the header unit and for the program that imports it. With a PCH, more compiler flags must be the same. But with header units, these flags should be the same:
31+
Another advantage of header units over PCH is that there's more flexibility for differences between the compiler flags used to compile the header unit and the program that imports it. With a PCH, more compiler flags must be the same. With header units, only the following flags need to be the same:
3232

3333
- Exception handling options like **`/EHsc`**.
3434
- **`/MD[d]`** or **`MT[d]`**.
35-
- **`/D`**. You can define additional macros when you build the program that imports the header unit. But the ones used to build the header unit should also be present and defined the same way when you build the program that imports the header unit.
35+
- **`/D`**. You can define other macros when you build the program that imports the header unit. But the ones used to build the header unit should also be present and defined the same way when you build the program that imports the header unit.
3636

3737
## Ways to compile a header unit
3838

3939
There are several ways to compile a file into a header unit:
4040

4141
- **Automatically scan for header units**. This approach is best suited to smaller projects that include many different header files. See [Walkthrough: Import STL libraries as header units](walkthrough-import-stl-header-units.md#approach1) for a demonstration of this approach. This approach is better suited to smaller projects because it can't guarantee optimal build throughput. That's because it scans all the files to find what should be built into header units.
4242

43-
- **Build a shared header unit project**. This approach is best suited for larger projects and for when you want more control over the organization of the imported header units. You create a static library project (or projects) that contain the header units that you want. Then reference the library project (or projects) from the project that then imports the header units it needs. See [Walkthrough: Import STL libraries as header units](walkthrough-import-stl-header-units.md#approach2) for a demonstration of this approach.
43+
- **Build a shared header unit project**. This approach is best suited for larger projects and for when you want more control over the organization of the imported header units. You create a static library project (or projects) that contain the header units that you want. Then reference that library project (or projects) to import the header units. See [Walkthrough: Import STL libraries as header units](walkthrough-import-stl-header-units.md#approach2) for a demonstration of this approach.
4444

45-
- **Choose individual header units to build**. This approach gives you file-by-file control over which header files are treated as header units. It's also a good way to quickly and selectively try out header units in your project. This approach is demonstrated in this walkthrough.
45+
- **Choose individual header units to build**. This approach gives you file-by-file control over which header files are treated as header units. It's also a good way to try out header units in your project. This approach is demonstrated in this walkthrough.
4646

4747
## Convert a project to use header units
4848

49-
In this example, you'll compile a header file as a header unit. Start by creating the following project in Visual Studio:
49+
Compile a header file as a header unit using the following steps in Visual Studio:
5050

5151
1. Create a new C++ console app project.
5252
1. Replace the source file content as follows:
@@ -61,7 +61,7 @@ In this example, you'll compile a header file as a header unit. Start by creatin
6161
}
6262
```
6363

64-
1. Add a header file called `Pythagorean.h`, and replace its content with this code:
64+
1. Add a header file called `Pythagorean.h` and then replace its content with this code:
6565

6666
```cpp
6767
#ifndef PYTHAGOREAN
@@ -76,31 +76,29 @@ In this example, you'll compile a header file as a header unit. Start by creatin
7676
#endif
7777
```
7878

79-
To enable header units, first set the **C++ Language Standard** to [`/std:c++20`](./reference/std-specify-language-standard-version.md) or later.
79+
To enable header units, first set the **C++ Language Standard** to [`/std:c++20`](./reference/std-specify-language-standard-version.md) or later:
8080

8181
1. On the Visual Studio main menu, select **Project** > **Properties**.
8282
1. In the left pane of the project property pages window, select **Configuration Properties** > **General**.
83-
1. In the **C++ Language Standard** list, select **ISO C++20 Standard (/std:c++20)** or later. (In versions before Visual Studio 2019 version 16.11, select **Preview - Features from the Latest C++ Working Draft (/std:c++latest)**.)
83+
1. In the **C++ Language Standard** list, select **ISO C++20 Standard (/std:c++20)** or later. In versions before Visual Studio 2019 version 16.11, select **Preview - Features from the Latest C++ Working Draft (/std:c++latest)**.
8484

8585
### Compile a header file as a header unit
8686

87-
In **Solution Explorer**, select the file you want to compile as a header unit. Right-click the file and select **Properties**. Then do one of the following, depending on the file type:
88-
89-
**For header files**:
90-
91-
Set the **Item Type** property to **C/C++ compiler**. By default, header files have an **Item Type** of **C/C++ header**. Setting this property also sets **C/C++** > **Advanced** > **Compile As** to **Compile as C++ Header Unit (/exportHeader)**.
87+
In **Solution Explorer**, select the file you want to compile as a header unit (in this case, `Pythagorean.h`). Right-click the file and select **Properties**. Since this is a header file, set the **Item Type** property to **C/C++ compiler**. By default, header files have an **Item Type** of **C/C++ header**. Setting this property also sets **C/C++** > **Advanced** > **Compile As** to **Compile as C++ Header Unit (/exportHeader)**.
9288
:::image type="content" source="media/change-item-type.png" alt-text="Screenshot that shows changing the item type to C/C++ compiler.":::
9389

94-
**For source files** (or header files that don't have an *`.h`* or *`.hpp`* extension):
90+
**Compile a source file as a header unit**:
9591

96-
Set the **Compile As** property to **Compile as C++ Header Unit (/exportHeader)**.
92+
If you want to compile a file that doesn't have an *`.h`* or *`.hpp`* extension as a header unit, set the **Compile As** property to **Compile as C++ Header Unit (/exportHeader)**.
9793
:::image type="content" source="media/change-compile-as.png" alt-text="Screenshot that shows changing Compile As to Compile as C++ Header Unit.":::
9894

9995
### Change your code to import a header unit
10096

101-
In the source file for the example project, that is, the file that contains `main()`, change `#include "Pythagorean.h"` to `import "Pythagorean.h";`. (Don't forget the trailing semicolon that's required for `import` statements.) When you're compiling a header unit from a system header, use angle brackets (`import <file>;`). If it's a project header, use `import "file";`.
97+
In the source file for the example project that contains `main()`, change `#include "Pythagorean.h"` to `import "Pythagorean.h";`. Don't forget the trailing semicolon that's required for `import` statements.
98+
99+
When compiling a header unit from a system header, use angle brackets (`import <file>;`). If it's a project header, use `import "file";`.
102100

103-
Build the solution. (**Build** > **Build Solution** on the main menu.) Run it to see that it produces the expected output: `Pythagorean triple a:2 b:3 c:13`
101+
Build the solution by selecting **Build** > **Build Solution** on the main menu. Run it to see that it produces the expected output: `Pythagorean triple a:2 b:3 c:13`
104102

105103
In your own projects, repeat this process to compile the header files you want to import as header units.
106104

0 commit comments

Comments
 (0)