Merge pull request #5860 from MicrosoftDocs/main

4/1/2025 AM Publish

Author: Albertyang0

docs/build/working-with-project-properties.md

@@ -15,7 +15,7 @@ You can view and modify these properties by using *property pages*. To access th
 
 When you create a project, the system assigns values for various properties. The defaults vary somewhat depending on the kind of project and what options you choose in the app wizard. For example, an Active Template Library (ATL) project has properties related to Microsoft Interface Definition Language (MIDL) files, but these properties are absent in a basic console application. The default properties are shown in the Advanced pane in the **Property Pages** window:
 
-:::image type="content" source="media/visual-c---project-defaults.png" alt-text="Screenshot of the Visual Studio project properties dialog box with the Advanced pane selected." lightbox="media/visual-c---project-defaults.png":::
+:::image type="content" source="media/visual-c---project-defaults.png" alt-text="Screenshot of the Visual Studio project properties dialog box with the Advanced pane selected. Properties such as Use of MFC, Character Set, and so on are highlighted." lightbox="media/visual-c---project-defaults.png":::
 
 ## Apply properties to build configurations and target platforms
 

docs/build/x64-software-conventions.md

@@ -1,7 +1,7 @@
 ---
 description: "Learn more about: x64 ABI conventions"
 title: "x64 ABI conventions"
-ms.date: 04/21/2022
+ms.date: 03/28/2025
 helpviewer_keywords: ["x64 coding conventions", "x64 abi", "Visual C++, x64 calling conventions"]
 ---
 # Overview of x64 ABI conventions
@@ -11,10 +11,11 @@ This topic describes the basic application binary interface (ABI) for x64, the 6
 ## x64 calling conventions
 
 Two important differences between x86 and x64 are:
+
 - 64-bit addressing capability
 - Sixteen 64-bit registers for general use.
 
-Given the expanded register set, x64 uses the [__fastcall](../cpp/fastcall.md) calling convention and a RISC-based exception-handling model.
+Given the expanded register set, x64 uses the [`__fastcall`](../cpp/fastcall.md) calling convention and a RISC-based exception-handling model.
 
 The **`__fastcall`** convention uses registers for the first four arguments, and the stack frame to pass more arguments. For details on the x64 calling convention, including register usage, stack parameters, return values, and stack unwinding, see [x64 calling convention](x64-calling-convention.md).
 
@@ -116,7 +117,7 @@ _declspec(align(2)) struct {
 }
 ```
 
-![Diagram showing the example 1 structure layout.](../build/media/vcamd_conv_ex_1_block.png "AMD conversion example 1 structure layout")
+:::image type="content" source="../build/media/vcamd_conv_ex_1_block.png" alt-text="Diagram showing the structure layout for example 1. The diagram shows 2 bytes of memory. Member a, a short, occupies bytes 0 through 1.":::
 
 #### Example 2
 
@@ -130,7 +131,9 @@ _declspec(align(8)) struct {
 }
 ```
 
-![Diagram showing the example 2 structure layout.](../build/media/vcamd_conv_ex_2_block.png "AMD conversion example 2 structure layout")
+:::image type="complex" source="../build/media/vcamd_conv_ex_2_block.png" alt-text="Diagram showing the structure layout for example 2.":::
+The diagram shows 24 bytes of memory. Member a, an int, occupies bytes 0 through 3. The diagram shows padding for bytes 4 through 7. Member b, a double, occupies bytes 8 through 15. Member c, a short, occupies bytes 16 through 17. Bytes 18 through 23 are unused.
+:::image-end:::
 
 #### Example 3
 
@@ -145,7 +148,9 @@ _declspec(align(4)) struct {
 }
 ```
 
-![Diagram showing the example 3 structure layout.](../build/media/vcamd_conv_ex_3_block.png "AMD conversion example 3 structure layout")
+:::image type="complex" source="../build/media/vcamd_conv_ex_3_block.png" alt-text="Diagram showing the structure layout for example 3.":::
+The diagram shows 12 bytes of memory. Member a, a char, occupies byte 0. Byte 1 is padding. Member b, a short, occupies bytes 2 through 4. Member c, a char, occupies byte 4. Bytes 5 through 7 are padding. Member d, an int, occupies bytes 8 through 11.
+:::image-end:::
 
 #### Example 4
 
@@ -159,7 +164,9 @@ _declspec(align(8)) union {
 }
 ```
 
-![Diagram showing the example 4 union layout.](../build/media/vcamd_conv_ex_4_block.png "AMD conversion example 4 union layout")
+:::image type="complex" source="../build/media/vcamd_conv_ex_4_block.png" alt-text="Diagram showing the union layout for example 4.":::
+The diagram shows 8 bytes of memory. Member p, a char, occupies byte 0. Member s, a short, occupies bytes 0 through 1. Member l, a long, occupies bytes 0 through 3. Bytes 4 through 7 are padding.
+:::image-end:::
 
 ### Bitfields
 
@@ -211,7 +218,7 @@ On function exit and on function entry to C Runtime Library calls and Windows sy
 
 ## Stack usage
 
-For details on stack allocation, alignment, function types and stack frames on x64, see [x64 stack usage](stack-usage.md).
+For details on stack allocation, alignment, function types, and stack frames on x64, see [x64 stack usage](stack-usage.md).
 
 ## Prolog and epilog
 

docs/code-quality/c6296.md

@@ -1,47 +1,35 @@
 ---
-description: "Learn more about: Warning C6296"
 title: Warning C6296
-ms.date: 11/04/2016
+description: "Learn more about: Warning C6296"
+ms.date: 03/30/2025
 f1_keywords: ["C6296", "LOOP_ONLY_EXECUTED_ONCE", "__WARNING_LOOP_ONLY_EXECUTED_ONCE"]
 helpviewer_keywords: ["C6296"]
-ms.assetid: 226573e0-db18-4c44-8fc6-0bc09d1028bc
 ---
 # Warning C6296
 
-> Ill-defined for-loop: Loop body only executed once
+> Ill-defined for-loop.  Loop body only executed once.
 
 ## Remarks
 
-This warning indicates that a for-loop might not function as intended. When the index is unsigned and a loop counts down from zero, its body is run only once.
+This warning indicates that a for-loop might unintentionally execute only once. A loop with an unsigned index counting down from zero or a mistaken use of `==` might cause this warning.
 
 Code analysis name: `LOOP_ONLY_EXECUTED_ONCE`
 
 ## Example
 
-The following code generates this warning:
+The following example generates C6296. Each for-loop shown executes exactly once.
 
 ```cpp
-void f( )
+int main()
 {
-   unsigned int i;
+    for (unsigned int i = 0; i < 10; i--) {}   // C6296
+    // Use the following line to resolve the warning:
+    // for (unsigned int i = 0; i < 10; i++) {}
 
-   for (i = 0; i < 100; i--)
-   {
-      // code ...
-   }
-}
-```
+    for (int i = 0; i == 0; i++) {}   // C6296
 
-To correct this warning, use the following code:
-
-```cpp
-void f( )
-{
-   unsigned int i;
+    for (int i = 0; i < 1; i++) {}   // OK
 
-   for (i = 0; i < 100; i++)
-   {
-      // code ...
-   }
+    for (int i = 1; i > 0; i--) {}   // OK
 }
 ```

docs/code-quality/quick-start-code-analysis-for-c-cpp.md

@@ -19,7 +19,7 @@ You can improve the quality of your application by running code analysis regular
 
 1. To run code analysis every time the project is built using the selected configuration, select the **Enable Code Analysis on Build** check box. You can also run code analysis manually by opening the **Analyze** menu and then choosing **Run Code Analysis on** *ProjectName* or **Run Code Analysis on File**.
 
-1. Choose the [rule set](using-rule-sets-to-specify-the-cpp-rules-to-run.md) that you want to use or create a [custom rule set](using-rule-sets-to-specify-the-cpp-rules-to-run.md#to-create-a-rule-set-in-a-text-editor). If using LLVM/clang-cl, see [Using Clang-Tidy in Visual Studio](../code-quality/clang-tidy.md) to configure Clang-Tidy analysis options.
+1. Choose the [rule set](using-rule-sets-to-specify-the-cpp-rules-to-run.md) that you want to use or create a [custom rule set](using-rule-sets-to-specify-the-cpp-rules-to-run.md#to-create-a-rule-set-in-a-text-editor). If using LLVM/clang-cl, see [Using Clang-Tidy in Visual Studio](clang-tidy.md) to configure Clang-Tidy analysis options.
 
 ### Standard C/C++ rule sets
 
@@ -100,7 +100,7 @@ The Error List window lists the code analysis warnings found. The results are di
 
 For detailed information about the warning, including possible solutions to the issue, choose the warning ID in the Code column to display its corresponding online help article.
 
-Double-click a warning to move the cursor to the line of code that caused the warning in the Visual Studio code editor. Or, press Enter on the selected warning.
+Double-click a warning to move the cursor to the line of code that caused the warning in the code editor. Or, press Enter on the selected warning.
 
 After you understand the problem, you can resolve it in your code. Then, rerun code analysis to make sure that the warning no longer appears in the Error List.
 
@@ -128,4 +128,4 @@ You can search long lists of warning messages and you can filter warnings in mul
 
 ## See also
 
-- [Code analysis for C/C++](../code-quality/code-analysis-for-c-cpp-overview.md)
+- [Code analysis for C/C++](code-analysis-for-c-cpp-overview.md)

docs/code-quality/understanding-sal.md

@@ -1,9 +1,8 @@
 ---
-description: "Learn more about: Understanding SAL"
 title: Understanding SAL
+description: "Learn more about: Understanding SAL"
 ms.date: 11/04/2016
 ms.topic: "conceptual"
-ms.assetid: a94d6907-55f2-4874-9571-51d52d6edcfd
 ---
 # Understanding SAL
 
@@ -94,9 +93,9 @@ These annotations help identify possible uninitialized values and invalid null p
 
 This section shows code examples for the basic SAL annotations.
 
-### Using the Visual Studio Code Analysis Tool to Find Defects
+### Using the Visual Studio code analysis tool to find defects
 
-In the examples, the Visual Studio Code Analysis tool is used together with SAL annotations to find code defects. Here's how to do that.
+In the examples, the Visual Studio code analysis tool is used together with SAL annotations to find code defects. Here's how to do that.
 
 #### To use Visual Studio code analysis tools and SAL
 
@@ -145,7 +144,7 @@ void BadInCaller()
 }
 ```
 
-If you use Visual Studio Code Analysis on this example, it validates that the callers pass a non-Null pointer to an initialized buffer for `pInt`. In this case, `pInt` pointer cannot be NULL.
+If you use Visual Studio code analysis on this example, it validates that the callers pass a non-Null pointer to an initialized buffer for `pInt`. In this case, `pInt` pointer cannot be NULL.
 
 ### Example: The \_In\_opt\_ Annotation
 
@@ -172,7 +171,7 @@ void InOptCaller()
 }
 ```
 
-Visual Studio Code Analysis validates that the function checks for NULL before it accesses the buffer.
+Visual Studio code analysis validates that the function checks for NULL before it accesses the buffer.
 
 ### Example: The \_Out\_ Annotation
 
@@ -198,7 +197,7 @@ void OutCaller()
 }
 ```
 
-Visual Studio Code Analysis Tool validates that the caller passes a non-NULL pointer to a buffer for `pInt` and that the buffer is initialized by the function before it returns.
+Visual Studio code analysis validates that the caller passes a non-NULL pointer to a buffer for `pInt` and that the buffer is initialized by the function before it returns.
 
 ### Example: The \_Out\_opt\_ Annotation
 
@@ -225,7 +224,7 @@ void OutOptCaller()
 }
 ```
 
-Visual Studio Code Analysis validates that this function checks for NULL before `pInt` is dereferenced, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
+Visual Studio code analysis validates that this function checks for NULL before `pInt` is dereferenced, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
 
 ### Example: The \_Inout\_ Annotation
 
@@ -256,7 +255,7 @@ void BadInOutCaller()
 }
 ```
 
-Visual Studio Code Analysis validates that callers pass a non-NULL pointer to an initialized buffer for `pInt`, and that, before return, `pInt` is still non-NULL and the buffer is initialized.
+Visual Studio code analysis validates that callers pass a non-NULL pointer to an initialized buffer for `pInt`, and that, before return, `pInt` is still non-NULL and the buffer is initialized.
 
 ### Example: The \_Inout\_opt\_ Annotation
 
@@ -285,7 +284,7 @@ void InOutOptCaller()
 }
 ```
 
-Visual Studio Code Analysis validates that this function checks for NULL before it accesses the buffer, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
+Visual Studio code analysis validates that this function checks for NULL before it accesses the buffer, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
 
 ### Example: The \_Outptr\_ Annotation
 
@@ -315,7 +314,7 @@ void OutPtrCaller()
 }
 ```
 
-Visual Studio Code Analysis validates that the caller passes a non-NULL pointer for `*pInt`, and that the buffer is initialized by the function before it returns.
+Visual Studio code analysis validates that the caller passes a non-NULL pointer for `*pInt`, and that the buffer is initialized by the function before it returns.
 
 ### Example: The \_Outptr\_opt\_ Annotation
 
@@ -347,7 +346,7 @@ void OutPtrOptCaller()
 }
 ```
 
-Visual Studio Code Analysis validates that this function checks for NULL before `*pInt` is dereferenced, and that the buffer is initialized by the function before it returns.
+Visual Studio code analysis validates that this function checks for NULL before `*pInt` is dereferenced, and that the buffer is initialized by the function before it returns.
 
 ### Example: The \_Success\_ Annotation in Combination with \_Out\_
 
@@ -366,7 +365,7 @@ bool GetValue(_Out_ int *pInt, bool flag)
 }
 ```
 
-The `_Out_` annotation causes Visual Studio Code Analysis to validate that the caller passes a non-NULL pointer to a buffer for `pInt`, and that the buffer is initialized by the function before it returns.
+The `_Out_` annotation causes Visual Studio code analysis to validate that the caller passes a non-NULL pointer to a buffer for `pInt`, and that the buffer is initialized by the function before it returns.
 
 ## SAL Best Practice
 
@@ -384,18 +383,18 @@ Here are some guidelines:
 
 - Annotate value-range annotations so that Code Analysis can ensure buffer and pointer safety.
 
-- Annotate locking rules and locking side effects. For more information, see [Annotating Locking Behavior](../code-quality/annotating-locking-behavior.md).
+- Annotate locking rules and locking side effects. For more information, see [Annotating Locking Behavior](annotating-locking-behavior.md).
 
 - Annotate driver properties and other domain-specific properties.
 
 Or you can annotate all parameters to make your intent clear throughout and to make it easy to check that annotations have been done.
 
 ## See also
 
-- [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md)
-- [Annotating Function Parameters and Return Values](../code-quality/annotating-function-parameters-and-return-values.md)
-- [Annotating Function Behavior](../code-quality/annotating-function-behavior.md)
-- [Annotating Structs and Classes](../code-quality/annotating-structs-and-classes.md)
-- [Annotating Locking Behavior](../code-quality/annotating-locking-behavior.md)
-- [Specifying When and Where an Annotation Applies](../code-quality/specifying-when-and-where-an-annotation-applies.md)
-- [Best Practices and Examples](../code-quality/best-practices-and-examples-sal.md)
+- [Using SAL Annotations to Reduce C/C++ Code Defects](using-sal-annotations-to-reduce-c-cpp-code-defects.md)
+- [Annotating Function Parameters and Return Values](annotating-function-parameters-and-return-values.md)
+- [Annotating Function Behavior](annotating-function-behavior.md)
+- [Annotating Structs and Classes](annotating-structs-and-classes.md)
+- [Annotating Locking Behavior](annotating-locking-behavior.md)
+- [Specifying When and Where an Annotation Applies](specifying-when-and-where-an-annotation-applies.md)
+- [Best Practices and Examples](best-practices-and-examples-sal.md)

docs/code-quality/using-the-cpp-core-guidelines-checkers.md

@@ -317,11 +317,11 @@ Because of the way the code analysis rules get loaded within Visual Studio 2015,
 
 1. In the **NuGet Package Manager** window, search for Microsoft.CppCoreCheck.
 
-    ![Nuget Package Manager window showing the CppCoreCheck package.](../code-quality/media/cppcorecheck_nuget_window.png)
+    ![Nuget Package Manager window showing the CppCoreCheck package.](media/cppcorecheck_nuget_window.png)
 
 1. Select the Microsoft.CppCoreCheck package and then choose the **Install** button to add the rules to your project.
 
-   The NuGet package adds an MSBuild *`.targets`* file to your project that is invoked when you enable code analysis on your project. The *`.targets`* file adds the C++ Core Check rules as another extension to the Visual Studio Code analysis tool. When the package is installed, you can use the Property Pages dialog to enable or disable the released and experimental rules.
+   The NuGet package adds an MSBuild *`.targets`* file to your project that is invoked when you enable code analysis on your project. The *`.targets`* file adds the C++ Core Check rules as another extension to the Visual Studio code analysis tool. When the package is installed, you can use the Property Pages dialog to enable or disable the released and experimental rules.
 
 ::: moniker-end
 

docs/dotnet/how-to-declare-override-specifiers-in-native-compilations-cpp-cli.md

@@ -1,16 +1,15 @@
 ---
-description: "Learn more about: How to: Declare Override Specifiers in Native Compilations (C++/CLI)"
 title: "How to: Declare Override Specifiers (C++/CLI)"
+description: "Learn more about: How to: Declare Override Specifiers in Native Compilations (C++/CLI)"
 ms.date: "11/04/2016"
 helpviewer_keywords: ["override specifiers in native compilation, overriding"]
-ms.assetid: d0551836-9ac7-41eb-a6e9-a4b3ef60767d
 ---
 # How to: Declare Override Specifiers in Native Compilations (C++/CLI)
 
-[sealed](../extensions/sealed-cpp-component-extensions.md), [abstract](../extensions/abstract-cpp-component-extensions.md), and [override](../extensions/override-cpp-component-extensions.md) are available in compilations that do not use **/ZW** or [/clr](../build/reference/clr-common-language-runtime-compilation.md).
+[`sealed`](../extensions/sealed-cpp-component-extensions.md), [`abstract`](../extensions/abstract-cpp-component-extensions.md), and [`override`](../extensions/override-cpp-component-extensions.md) are available in compilations that do not use **/ZW** or [`/clr`](../build/reference/clr-common-language-runtime-compilation.md).
 
 > [!NOTE]
-> The ISO C++11 Standard language has the [override](../cpp/override-specifier.md) identifier and the [final](../cpp/final-specifier.md) identifier, and both are supported in Visual Studio  Use `final` instead of **`sealed`** in code that is meant to be compiled as native-only.
+> The ISO C++11 Standard language [`override`](../cpp/override-specifier.md) and [`final`](../cpp/final-specifier.md) specifiers are supported in Visual Studio. Use `final` instead of **`sealed`** in code that is meant to be compiled as native-only.
 
 ## Example: sealed is valid
 
@@ -67,7 +66,7 @@ public:
 
 ### Description
 
-This example shows that **`abstract`** is valid in native compilations.
+This example shows that `abstract` is valid in native compilations.
 
 ### Code
 

docs/embedded/toc.yml

@@ -1,5 +1,5 @@
 items: 
-- name: Embedded development with Visual Studio and Visual Studio code
+- name: Embedded development with Visual Studio and Visual Studio Code
   href: ./index.yml
 - name: Download and install the Embedded Tools
   href: download-and-install-the-embedded-tooling.md

docs/error-messages/compiler-errors-1/compiler-error-c2162.md

@@ -1,26 +1,23 @@
 ---
-description: "Learn more about: Compiler Error C2162"
 title: "Compiler Error C2162"
-ms.date: "11/04/2016"
+description: "Learn more about: Compiler Error C2162"
+ms.date: "03/30/2025"
 f1_keywords: ["C2162"]
 helpviewer_keywords: ["C2162"]
-ms.assetid: 34923628-d35e-48ab-9072-b95e3b5f6b45
 ---
 # Compiler Error C2162
 
-expected macro formal parameter
+> expected macro formal parameter
 
-The token following a stringizing operator (#) is not a formal parameter name.
+The token following a [stringizing operator (#)](../../preprocessor/stringizing-operator-hash.md) or a [charizing operator (#@)](../../preprocessor/charizing-operator-hash-at.md) is not a formal parameter.
 
 ## Example
 
-The following sample generates C2162:
+The following example generates C2162:
 
 ```cpp
 // C2162.cpp
 // compile with: /c
-#include <stdio.h>
-
-#define print(a) printf_s(b)   // OK
-#define print(a) printf_s(#b)    // C2162
+#define make_string1(s) #    // C2162
+#define make_string2(s) #s   // OK
 ```