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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Thank you for your interest in contributing to the Visual C++ documentation!
4
4
5
-
In this topic, you'll see the basic process for adding or updating content in the [Visual C++ documentation site](https://docs.microsoft.com/cpp/).
5
+
In this topic, you'll see the basic process for adding or updating content in the [Visual C++ documentation site](https://learn.microsoft.com/cpp/).
6
6
7
7
In this topic, we'll cover:
8
8
@@ -54,7 +54,7 @@ The Visual Studio team will review your PR and let you know if the change looks
54
54
55
55
The maintainers will merge your PR into the main branch once feedback has been applied and your change looks good.
56
56
57
-
On a certain cadence, we push all commits from main branch into the live branch and then you'll be able to see your contribution on [Microsoft Docs](https://docs.microsoft.com/cpp/).
57
+
On a certain cadence, we push all commits from main branch into the live branch and then you'll be able to see your contribution on [Microsoft Learn](https://learn.microsoft.com/cpp/).
58
58
59
59
## DOs and DON'Ts
60
60
@@ -72,7 +72,7 @@ Below is a short list of guiding rules that you should keep in mind when you are
72
72
73
73
## Building the docs
74
74
75
-
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 and build tools. It's published on[Microsoft Docs](https://docs.microsoft.com/).
75
+
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 and build tools. It's published to[Microsoft Learn](https://learn.microsoft.com/).
76
76
77
77
If you want to build the docs locally, you need to install [DocFX](https://dotnet.github.io/docfx/); latest versions are the best.
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# Visual Studio documentation for Microsoft C++
2
2
3
-
Welcome! This repository contains source files for the work-in-progress Microsoft C++ (MSVC or Visual C++) technical documentation. The articles are published on the [C++ in Visual Studio documentation site](https://docs.microsoft.com/cpp).
3
+
Welcome! This repository contains source files for the work-in-progress Microsoft C++ (MSVC or Visual C++) technical documentation. The articles are published on the [C++ in Visual Studio documentation site](https://learn.microsoft.com/cpp).
4
4
5
5
The documentation for Visual Basic and Visual C# are located in a separate repository at [https://github.com/dotnet/core-docs](https://github.com/dotnet/core-docs), and the Visual Studio documentation is located in the repository located at [https://github.com/Microsoft/visualstudio-docs](https://github.com/Microsoft/visualstudio-docs).
6
6
7
7
## Contributing to the documentation
8
8
9
-
We welcome your contributions to help us improve the MSVC docs. For a comprehensive guide to contributing to Microsoft Docs, see the [contributor guide overview](https://docs.microsoft.com/contribute). For details on how to make a contribution to the MSVC documentation, see the[Contributing guide](CONTRIBUTING.md).
9
+
We welcome your contributions to help us improve the MSVC docs. For a comprehensive guide to contributing, see the [Microsoft Docs contributor guide](https://learn.microsoft.com/contribute). For details on how to make a contribution to the MSVC documentation, see our[Contributing guidance](CONTRIBUTING.md).
10
10
11
11
Several feature areas of MSVC have their own folders in this repository, such as `standard-library` for articles on the C++ Standard Library, `ide` for C++-specific articles on the Visual Studio interactive development environment (IDE), and so forth. The `/media` subfolder in each folder contains art files for the articles. The [Contributing guide](CONTRIBUTING.md) has more information.
> Returning uninitialized memory '\**parameter-name*'. A successful path through the function does not set the named \_Out\_ parameter.
13
13
14
-
A successful path through the function does not set the named `_Out_` parameter. This message is generated based on SAL annotations that indicate that the function in question always succeeds. A function that doesn't return a success/failure indication should set all of its `_Out_` parameters because the analyzer assumes that the `_Out_` parameter is uninitialized data before the function is called, and that the function will set the parameter so that it's no longer uninitialized. If the function does indicate success/failure, then the `_Out_` parameter doesn't have to be set in the case of failure, and you can detect and avoid the uninitialized location. In either case, the objective is to avoid the reading of an uninitialized location. If the function sometimes doesn't touch an `_Out_` parameter that's subsequently used, then the parameter should be initialized before the function call and be marked with the `_Inout_` annotation, or the more explicit `_Pre_null_` or `_Pre_satisfies_()` when appropriate. "Partial success" can be handled with the `_When_` annotation. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
14
+
## Remarks
15
+
16
+
This message is generated based on SAL annotations that indicate that the function in question always succeeds. A function that doesn't return a success/failure indication should set all of its `_Out_` parameters because the analyzer assumes that the `_Out_` parameter is uninitialized data before the function is called, and that the function will set the parameter so that it's no longer uninitialized. If, however, the function does indicate success/failure and failure occurs, then the `_Out_` parameter doesn't have to be set. You can then detect and avoid the uninitialized location. In either case, the objective is to avoid the reading of an uninitialized location. If the function sometimes doesn't touch an `_Out_` parameter that's later used, then the parameter should be initialized before the function call and be marked with the `_Inout_` annotation, or the more explicit `_Pre_null_` or `_Pre_satisfies_()` when appropriate. "Partial success" can be handled with the `_When_` annotation. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
17
+
18
+
Code analysis name: RETURN_UNINIT_VAR
19
+
20
+
## Example
21
+
22
+
The following code generates this warning. This issue stems from the pointer p1 not being set despite having been annotated with `_Out_`.
23
+
24
+
```cpp
25
+
voidexample_func(_Out_ int *p1)
26
+
{
27
+
return;
28
+
}
29
+
```
30
+
31
+
To resolve the issue, you can set the value of the parameter. Or, if the value is always initialized before the function is called, change the SAL annotation to `_Inout_`. By setting the value of the parameter, the following code avoids the warning:
Copy file name to clipboardExpand all lines: styleguide/template.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -121,7 +121,7 @@ To link to a header in a Markdown file in the same repo, use relative linking +
121
121
122
122
### Docs Links
123
123
124
-
To link to a file in a different Docs repo, use the docs.microsoft.com relative URL as the link. Don't include the .md suffix or the language/locale element.
124
+
To link to a file in a different Docs repo, use the `learn.microsoft.com` relative URL as the link. Don't include the .md suffix or the language/locale element.
125
125
126
126
- Example: [Universal Windows Platform documentation](/windows/uwp)
127
127
@@ -362,8 +362,8 @@ Use backticks (`) for `inline code`. Use inline code for command-line comman
362
362
363
363
### Shows
364
364
365
-
[
[
You can see an example of selectors in action at the [Intune docs](https://docs.microsoft.com/intune/deploy-use/what-to-tell-your-end-users-about-using-microsoft-intune#how-your-end-users-get-their-apps).
420
+
You can see an example of selectors in action at the [Intune docs](https://learn.microsoft.com/intune/deploy-use/what-to-tell-your-end-users-about-using-microsoft-intune#how-your-end-users-get-their-apps).
You can see an example of step-by-steps in action at the [Advanced Threat Analytics docs](https://docs.microsoft.com/advanced-threat-analytics/deploy-use/install-ata-step2).
428
+
You can see an example of step-by-steps in action at the [Advanced Threat Analytics docs](https://learn.microsoft.com/advanced-threat-analytics/deploy-use/install-ata-step2).
0 commit comments