You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -19,7 +19,7 @@ The content inside the **docs** folder is organized into sections that are organ
19
19
20
20
You can skip this first step for small changes.
21
21
22
-
**Step 2:** Fork the `MicrosoftDocs/cpp-docs`repo.
22
+
**Step 2:** Fork the `MicrosoftDocs/cpp-docs`repository.
23
23
24
24
**Step 3:** Create a `branch` for your article.
25
25
@@ -30,17 +30,17 @@ If it's a new topic, you can use this [template file](./styleguide/template.md)
30
30
Navigate to the folder that corresponds to the TOC location determined for your article in step 1.
31
31
That folder contains the Markdown files for all articles in that section. If necessary, create a new folder to place the files for your content.
32
32
33
-
For images and other static resources, add them to the subfolder called **media**. If you are creating a new folder for content, add a media folder to the new folder.
33
+
For images and other static resources, add them to the subfolder called `media`. If you are creating a new folder for content, add a media folder to the new folder.
34
34
35
35
Be sure to follow the proper Markdown syntax. See the [style guide](./styleguide/template.md) for more information.
36
36
37
37
### Example structure
38
38
39
39
docs
40
-
/standard-library
41
-
wstring-convert-class.md
42
-
/media
43
-
wstring-conversion.png
40
+
/standard-library
41
+
wstring-convert-class.md
42
+
/media
43
+
wstring-conversion.png
44
44
45
45
**Step 5:** Submit a Pull Request (PR) from your branch to `MicrosoftDocs/cpp-docs/master`.
46
46
@@ -70,30 +70,28 @@ Below is a short list of guiding rules that you should keep in mind when you are
70
70
71
71
## Building the docs
72
72
73
-
The documentation is written in [GitHub Flavored Markdown](https://help.github.com/categories/writing-on-github/) and built using [DocFX](http://dotnet.github.io/docfx/) and other internal publishing/building tools. It is hosted at [docs.microsoft.com](https://docs.microsoft.com/).
73
+
The documentation is written in [GitHub Flavored Markdown](https://help.github.com/categories/writing-on-github/) and built using [DocFX](https://dotnet.github.io/docfx/) and other internal publishing/building tools. It is hosted at [docs.microsoft.com](https://docs.microsoft.com/).
74
74
75
75
If you want to build the docs locally, you need to install [DocFX](https://dotnet.github.io/docfx/); latest versions are the best.
76
76
77
-
There are several ways to use DocFX, and most of them are covered in the [DocFX getting started guide](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html).
78
-
The following instructions use the [command-line based](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool) version of the tool.
79
-
If you are comfortable with other ways listed on the link above, feel free to use those.
77
+
There are several ways to use DocFX, and most of them are covered in the [DocFX getting started guide](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html). The following instructions use the [command-line based](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool) version of the tool. If you are comfortable with other ways listed on the link above, feel free to use those.
80
78
81
79
**Note:** Currently DocFX requires the .NET Framework on Windows or Mono (for Linux or macOS). We hope to port it to .NET Core in the future.
82
80
83
81
You can build and preview the resulting site locally using a built-in web server. Navigate to the `cpp-docs\docs` folder on your machine and type the following command:
84
82
85
-
`docfx -t default --serve`
83
+
> docfx -t default --serve
86
84
87
85
This starts the local preview on [localhost:8080](http://localhost:8080). You can then view the changes by going to `http://localhost:8080/[path]`, such as `http://localhost:8080/cpp/visual-cpp-in-visual-studio.html`.
88
86
89
87
**Note:** the local preview currently doesn't contain any themes at the moment so the look and feel won't be the same as in the documentation site. We're working towards fixing that experience. We also use some custom extensions for embedded video, notes, and included documents, that won't be visible in the preview.
90
88
91
89
## Contributing to samples
92
90
93
-
For now, include required sample code as inline code blocks in your article. The repo has a codesnippets folder, but this is not ready for public contributions.
91
+
For now, include required sample code as inline code blocks in your article. The repository has a `codesnippets` folder, but this is not ready for public contributions.
94
92
95
93
## Contributor license agreement
96
94
97
-
You must sign the [Contribution License Agreement (CLA)](LICENSE) before your PR is merged. This is a one-time requirement for projects in docs.microsoft.com. You can read more about [Contribution License Agreements (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) on Uncyclopedia.
95
+
You must sign the [Contribution License Agreement (CLA)](LICENSE) before your PR is merged. This is a one-time requirement for projects in docs.microsoft.com. You can read more about [Contribution License Agreements (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) on Uncyclopedia.
98
96
99
-
You don't have to sign the agreement up-front. You can clone, fork, and submit your PR as usual. When your PR is created, it is classified by a CLA bot. If the change is trivial (for example, you fixed a typo), then the PR is labeled with cla-not-required. Otherwise, it's classified as cla-required. Once you signed the CLA, the current and all future pull requests are labeled as cla-signed.
97
+
You don't have to sign the agreement up-front. You can clone, fork, and submit your PR as usual. When your PR is created, it is classified by a CLA bot. If the change is trivial (for example, you fixed a typo), then the PR is labeled with CLA-not-required. Otherwise, it's classified as CLA-required. Once you signed the CLA, the current and all future pull requests are labeled as CLA-signed.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
4
-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
5
-
6
1
# Visual Studio 2017 documentation for Visual C++
7
2
8
-
Welcome! This repo contains source files for the work-in-progress Visual C++ technical documentation. The topics are published on the [Visual C++ documentation site](https://docs.microsoft.com/cpp).
3
+
Welcome! This repository contains source files for the work-in-progress Visual C++ technical documentation. The topics are published on the [Visual C++ documentation site](https://docs.microsoft.com/cpp).
9
4
10
-
This repo was moved from Microsoft/vcppdocs to MicrosoftDocs/cpp-docs-pr on June 23, 2017.
5
+
This repository was moved from Microsoft/vcppdocs to MicrosoftDocs/cpp-docs-pr on June 23, 2017.
11
6
12
-
The documentation for Visual Basic and Visual C# are located in a separate repo at [http://github.com/dotnet/core-docs](http://github.com/dotnet/core-docs), and the Visual Studio 2017 documentation is located in the repo located at [http://github.com/Microsoft/visualstudio-docs](http://github.com/Microsoft/visualstudio-docs).
7
+
The documentation for Visual Basic and Visual C# are located in a separate repository at [http://github.com/dotnet/core-docs](http://github.com/dotnet/core-docs), and the Visual Studio 2017 documentation is located in the repository located at [http://github.com/Microsoft/visualstudio-docs](http://github.com/Microsoft/visualstudio-docs).
13
8
14
9
## Contributing to the documentation
15
10
16
11
To contribute to this documentation, please see the [Contributing guide](CONTRIBUTING.md).
17
12
We welcome your contributions to help us improve the Visual C++ docs. All the articles in this repository use GitHub flavored markdown.
18
13
19
-
Several feature areas of Visual Studio have their own folders in this repo, such as **standard-library** for topics on the C++ Standard Library, **ide** for topics on the Visual Studio interactive development environment (IDE), and so forth. The **/media** subfolder in each folder contains art files for the topics. The [Contributing guide](CONTRIBUTING.md) has more information.
14
+
Several feature areas of Visual Studio have their own folders in this repository, such as `standard-library` for topics on the C++ Standard Library, `ide` for topics on the Visual Studio interactive development environment (IDE), and so forth. The `/media` subfolder in each folder contains art files for the topics. The [Contributing guide](CONTRIBUTING.md) has more information.
15
+
16
+
## Microsoft Open Source Code of Conduct
20
17
21
18
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
Copy file name to clipboardExpand all lines: docs/assembler/inline/inline-assembler.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ ms.workload: ["cplusplus"]
19
19
> [!NOTE]
20
20
> Programs with inline assembler code are not fully portable to other hardware platforms. If you are designing for portability, avoid using inline assembler.
21
21
22
-
Inline assembly is not supported on the ARM and [!INCLUDE[vcprx64](../../assembler/inline/includes/vcprx64_md.md)] processors. The following topics explain how to use the Visual C/C++ inline assembler with x86 processors:
22
+
Inline assembly is not supported on the ARM and x64 processors. The following topics explain how to use the Visual C/C++ inline assembler with x86 processors:
The buffer memory is automatically freed when the `CSimpleStringT` object is destroyed.
428
428
429
-
If you keep track of the string length yourself, do not not append the terminating null character. You must specify the final string length when you release the buffer by using `ReleaseBuffer`. If you do append a terminating null character when you call `ReleaseBuffer`, pass -1 (the default) for the length to `ReleaseBuffer`, and `ReleaseBuffer` will perform a `strlen` on the buffer to determine its length.
429
+
If you keep track of the string length yourself, do not append the terminating null character. You must specify the final string length when you release the buffer by using `ReleaseBuffer`. If you do append a terminating null character when you call `ReleaseBuffer`, pass -1 (the default) for the length to `ReleaseBuffer`, and `ReleaseBuffer` will perform a `strlen` on the buffer to determine its length.
430
430
431
431
For more information about reference counting, see the following articles:
Copy file name to clipboardExpand all lines: docs/atl/atl-com-property-pages.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ COM property pages provide a user interface for setting the properties (or calli
18
18
19
19
Each property page can be built completely independently of the objects whose properties can be set. All that a property page needs is to understand a particular interface (or set of interfaces) and to provide a user interface for calling methods on that interface.
20
20
21
-
For more information, see [Property Sheets and Property Pages](http://msdn.microsoft.com/library/windows/desktop/ms686577) in the [!INCLUDE[winSDK](../atl/includes/winsdk_md.md)].
21
+
For more information, see [Property Sheets and Property Pages](http://msdn.microsoft.com/library/windows/desktop/ms686577) in the Windows SDK.
The virtual key code and modifiers for the hot key associated with the window. For a list of possible modifiers, see [WM_GETHOTKEY](http://msdn.microsoft.com/library/windows/desktop/ms646278) in the Windows SDK. For a list of of standard virtual key codes, see Winuser.h.
821
+
The virtual key code and modifiers for the hot key associated with the window. For a list of possible modifiers, see [WM_GETHOTKEY](http://msdn.microsoft.com/library/windows/desktop/ms646278) in the Windows SDK. For a list of standard virtual key codes, see Winuser.h.
822
822
823
823
## <aname="geticon"></a> CWindow::GetIcon
824
824
Retrieves the handle to the window's large or small icon.
@@ -1933,7 +1933,7 @@ int SetHotKey(WORD wVirtualKeyCode, WORD wModifiers) throw();
1933
1933
1934
1934
### Parameters
1935
1935
*wVirtualKeyCode*
1936
-
[in] The virtual key code of the hot key. For a list of of standard virtual key codes, see Winuser.h.
1936
+
[in] The virtual key code of the hot key. For a list of standard virtual key codes, see Winuser.h.
1937
1937
1938
1938
*wModifiers*
1939
1939
[in] The modifiers of the hot key. For a list of possible values, see WM_SETHOTKEY in the Windows SDK.
Copy file name to clipboardExpand all lines: docs/build/building-c-cpp-programs.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ ms.workload: ["cplusplus"]
14
14
---
15
15
# Building C/C++ Programs
16
16
17
-
You can build Visual C++ projects either in Visual Studio or on the command line. The Visual Studio IDE uses [MSBuild](../build/msbuild-visual-cpp.md) to build projects and solutions. On the command line, you can use the C/C++ compiler (cl.exe) and linker (link.exe) to build simple projects. To build more complex projects on the command line, you can use MSBuild or [NMAKE](../build/nmake-reference.md). For an overview about how to use [!INCLUDE[vsprvs](../assembler/masm/includes/vsprvs_md.md)] to build projects and solutions, see [Compiling and Building](/visualstudio/ide/compiling-and-building-in-visual-studio).
17
+
You can build Visual C++ projects either in Visual Studio or on the command line. The Visual Studio IDE uses [MSBuild](../build/msbuild-visual-cpp.md) to build projects and solutions. On the command line, you can use the C/C++ compiler (cl.exe) and linker (link.exe) to build simple projects. To build more complex projects on the command line, you can use MSBuild or [NMAKE](../build/nmake-reference.md). For an overview about how to use Visual Studio to build projects and solutions, see [Compiling and Building](/visualstudio/ide/compiling-and-building-in-visual-studio).
Copy file name to clipboardExpand all lines: docs/build/common-visual-cpp-arm-migration-issues.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ On the ARM architecture, parameters from the variable arguments list that are pa
64
64
printf("%d\n", 1LL);
65
65
```
66
66
67
-
In this case, the bug can be fixed by making sure that the correct format specification is used so that that the alignment of the argument is considered. This code is correct:
67
+
In this case, the bug can be fixed by making sure that the correct format specification is used so that the alignment of the argument is considered. This code is correct:
Copy file name to clipboardExpand all lines: docs/build/configuring-programs-for-windows-xp.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ To get the platform toolset and components to target [!INCLUDE[winxp](../build/i
19
19
20
20
## Windows XP targeting experience
21
21
22
-
The Windows XP platform toolset that's included in Visual Studio is a version of the [!INCLUDE[win7](../build/includes/win7_md.md)] SDK, but it uses the current C++ compiler. It also configures project properties to appropriate default values, for example, the specification of a compatible linker for down-level targeting. Only Windows desktop apps that are created by using a Windows XP platform toolset run on [!INCLUDE[winxp](../build/includes/winxp_md.md)] and [!INCLUDE[WinXPSvr](../build/includes/winxpsvr_md.md)], but those apps can also run on more recent Windows operating systems.
22
+
The Windows XP platform toolset that's included in Visual Studio is a version of the Windows 7 SDK, but it uses the current C++ compiler. It also configures project properties to appropriate default values, for example, the specification of a compatible linker for down-level targeting. Only Windows desktop apps that are created by using a Windows XP platform toolset run on [!INCLUDE[winxp](../build/includes/winxp_md.md)] and [!INCLUDE[WinXPSvr](../build/includes/winxpsvr_md.md)], but those apps can also run on more recent Windows operating systems.
23
23
24
24
#### To target Windows XP
25
25
@@ -59,7 +59,7 @@ Due to differences in platform and library support, the development experience f
59
59
60
60
-**Static analysis**
61
61
62
-
The Windows XP platform toolsets don't support static analysis because the SAL annotations for the [!INCLUDE[win7](../build/includes/win7_md.md)] SDK and the runtime libraries are incompatible. When you want to perform static analysis on an app that supports [!INCLUDE[winxp](../build/includes/winxp_md.md)] or [!INCLUDE[WinXPSvr](../build/includes/winxpsvr_md.md)], you can temporarily switch the solution to target the default platform toolset to perform the analysis, and then switch back to the Windows XP platform toolset to build the app.
62
+
The Windows XP platform toolsets don't support static analysis because the SAL annotations for the Windows 7 SDK and the runtime libraries are incompatible. When you want to perform static analysis on an app that supports [!INCLUDE[winxp](../build/includes/winxp_md.md)] or [!INCLUDE[WinXPSvr](../build/includes/winxpsvr_md.md)], you can temporarily switch the solution to target the default platform toolset to perform the analysis, and then switch back to the Windows XP platform toolset to build the app.
Copy file name to clipboardExpand all lines: docs/build/dynamic-parameter-stack-area-construction.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ ms.author: "corob"
11
11
ms.workload: ["cplusplus"]
12
12
---
13
13
# Dynamic Parameter Stack Area Construction
14
-
If a frame pointer is used, the option exists to dynamically create the parameter stack area. This is not currently done in the [!INCLUDE[vcprx64](../assembler/inline/includes/vcprx64_md.md)] compiler.
14
+
If a frame pointer is used, the option exists to dynamically create the parameter stack area. This is not currently done in the x64 compiler.
Copy file name to clipboardExpand all lines: docs/build/exception-handling-x64.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ ms.author: "corob"
12
12
ms.workload: ["cplusplus"]
13
13
---
14
14
# Exception Handling (x64)
15
-
This section discusses structured exception handling and C++ exception handling behavior on the [!INCLUDE[vcprx64](../assembler/inline/includes/vcprx64_md.md)].
15
+
This section discusses structured exception handling and C++ exception handling behavior on the x64.
16
16
17
17
-[Unwind Data for Exception Handling, Debugger Support](../build/unwind-data-for-exception-handling-debugger-support.md)
0 commit comments