Merge pull request #5803 from MicrosoftDocs/main

2/25/2025 AM Publish

Author: Albertyang0

docs/build/cmake-remote-debugging.md

@@ -1,8 +1,8 @@
 ---
 title: "Tutorial: Debug a CMake project on a remote Windows machine"
+description: "How to use Visual Studio C++ on Windows to create and build a CMake project. You'll then deploy and debug it on a remote Windows machine."
 ms.date: "12/4/2020"
 ms.topic: tutorial
-description: "How to use Visual Studio C++ on Windows to create and build a CMake project. You'll then deploy and debug it on a remote Windows machine."
 ---
 
 # Tutorial: Debug a CMake project on a remote Windows machine
@@ -115,7 +115,7 @@ For example, on the remote machine, from the Visual Studio Remote Debugger menu
 
 Then, in Visual Studio on the host machine, update the *`launch.vs.json`* file to match. For example, if you choose **No Authentication** on the remote debugger, update the *`launch.vs.json`* file in your project by adding `"authenticationType": "none"` to the `configurations` section *`launch.vs.json`*. Otherwise, `"authenticationType"` defaults to `"windows"` and doesn't need to be explicitly stated. This example shows a *`launch.vs.json`* file configured for no authentication:
 
-``` XAML
+```XAML
 {
   "version": "0.2.1",
   "defaults": {},

docs/build/how-to-use-build-events-in-msbuild-projects.md

@@ -1,9 +1,8 @@
 ---
-description: "Learn more about: How to: Use Build Events in MSBuild Projects"
 title: "How to: Use Build Events in MSBuild Projects"
+description: "Learn more about: How to: Use Build Events in MSBuild Projects"
 ms.date: "11/04/2016"
 helpviewer_keywords: ["msbuild (c++), howto: use build events in projects"]
-ms.assetid: 2a58dc9d-3d50-4e49-97c1-86c5a05ce218
 ---
 # How to: Use Build Events in MSBuild Projects
 
@@ -33,7 +32,7 @@ The following table lists each *use-in-build* element:
 
 The following example can be added inside of the Project element of the myproject.vcxproj file created in [Walkthrough: Using MSBuild to Create a C++ Project](walkthrough-using-msbuild-to-create-a-visual-cpp-project.md). A *pre-build* event makes a copy of main.cpp; a *pre-link* event makes a copy of main.obj; and a *post-build* event makes a copy of myproject.exe. If the project is built using a release configuration, the build events are executed. If the project is built using a debug configuration, the build events are not executed.
 
-``` xml
+```xml
 <ItemDefinitionGroup>
   <PreBuildEvent>
     <Command>copy $(ProjectDir)main.cpp $(ProjectDir)copyOfMain.cpp</Command>
@@ -64,5 +63,5 @@ The following example can be added inside of the Project element of the myprojec
 
 ## See also
 
-[MSBuild on the command line - C++](msbuild-visual-cpp.md)<br/>
+[MSBuild on the command line - C++](msbuild-visual-cpp.md)\
 [Walkthrough: Using MSBuild to Create a C++ Project](walkthrough-using-msbuild-to-create-a-visual-cpp-project.md)

docs/build/reference/guard-enable-control-flow-guard.md

@@ -1,9 +1,8 @@
 ---
 description: "Learn more about: /guard (Enable Control Flow Guard)"
 title: "/guard (Enable Control Flow Guard)"
-ms.date: 09/19/2022
+ms.date: 2/24/2025
 f1_keywords: ["/guard", "VC.Project.VCCLCompilerTool.ControlFlowGuard"]
-ms.assetid: be495323-f59f-4cf3-a6b6-8ee69e6a19dd
 ---
 # `/guard` (Enable Control Flow Guard)
 
@@ -16,15 +15,21 @@ Enable compiler generation of Control Flow Guard security checks.
 
 ## Remarks
 
-The **`/guard:cf`** option causes the compiler to analyze control flow for indirect call targets at compile time, and then to insert code to verify the targets at runtime. By default, **`/guard:cf`** is off and must be explicitly enabled. To explicitly disable this option, use **`/guard:cf-`**.
+The **`/guard:cf`** option causes the compiler to analyze control flow for indirect call targets at compile time, and inserts code at runtime to verify the targets. By default, **`/guard:cf`** is off and must be explicitly enabled. To explicitly disable this option, use **`/guard:cf-`**.
 
 **Visual Studio 2017 and later**: This option adds guards for **`switch`** statements that generate jump tables.
 
 When the **`/guard:cf`** Control Flow Guard (CFG) option is specified, the compiler and linker insert extra runtime security checks to detect attempts to compromise your code. During compiling and linking, all indirect calls in your code are analyzed to find every location that the code can reach when it runs correctly. This information is stored in extra structures in the headers of your binaries. The compiler also injects a check before every indirect call in your code that ensures the target is one of the verified locations. If the check fails at runtime on a CFG-aware operating system, the operating system closes the program.
 
 A common attack on software takes advantage of bugs in handling extreme or unexpected inputs. Carefully crafted input to the application may overwrite a location that contains a pointer to executable code. This technique can be used to redirect control flow to code controlled by the attacker. The CFG runtime checks don't fix the data corruption bugs in your executable. They instead make it more difficult for an attacker to use them to execute arbitrary code. CFG is a mitigation tool that prevents calls to locations other than function entry points in your code. It's similar to how Data Execution Prevention (DEP),  [/GS](gs-buffer-security-check.md) stack checks, and [`/DYNAMICBASE`](dynamicbase-use-address-space-layout-randomization.md) and [/HIGHENTROPYVA](highentropyva-support-64-bit-aslr.md) address space layout randomization (ASLR) lower the chances that your code becomes an exploit vector.
 
-The **`/guard:cf`** option must be passed to both the compiler and linker to build code that uses the CFG exploit mitigation technique. If your binary is built by using a single `cl` command, the compiler passes the option to the linker. If you compile and link separately, the option must be set on both the compiler and linker commands. The /DYNAMICBASE linker option is also required. To verify that your binary has CFG data, use the `dumpbin /headers /loadconfig` command. CFG-enabled binaries have `Guard` in the list of EXE or DLL characteristics, and Guard Flags include `CF Instrumented` and `FID table present`.
+To use the CFG exploit mitigation technique, pass **`/guard:cf`** to the compiler and **`/GUARD:CF`** to the linker.
+
+To disable the CFG exploit mitigation technique, pass **`/guard:cf-`** to the compiler **`/GUARD:NO`** to the linker.
+
+If you build using a single `cl` command, the compiler passes the option to the linker. If you compile and link separately, set the option for both the compiler and linker commands. The `/DYNAMICBASE` linker option is also required.
+
+To verify that your binary has CFG data, use the `dumpbin /headers /loadconfig` command. CFG-enabled binaries have `Guard` in the list of EXE or DLL characteristics, and Guard Flags include `CF Instrumented` and `FID table present`.
 
 The **`/guard:cf`** option is incompatible with [`/ZI`](z7-zi-zi-debug-information-format.md) (Edit and Continue debug information) or [`/clr`](clr-common-language-runtime-compilation.md) (Common Language Runtime Compilation).
 
@@ -33,11 +38,8 @@ Code compiled by using **`/guard:cf`** can be linked to libraries and object fil
 ### To set this compiler option in the Visual Studio development environment
 
 1. Open the **Property Pages** dialog box for the project. For more information, see [Set compiler and build properties](../working-with-project-properties.md).
-
 1. Select the **Configuration Properties** > **C/C++** > **Code Generation** property page.
-
 1. Select the **Control Flow Guard** property.
-
 1. In the dropdown control, choose **Yes** to enable Control Flow Guard, or **No** to disable it.
 
 ## See also

docs/c-runtime-library/heapset.md

@@ -1,14 +1,13 @@
 ---
-description: "Learn more about: _heapset"
 title: "_heapset"
+description: "Learn more about: _heapset"
 ms.date: "11/04/2016"
 api_name: ["_heapset"]
 api_location: ["msvcr90.dll", "msvcr80.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcrt.dll", "msvcr120.dll", "msvcr100.dll"]
 api_type: ["DLLExport"]
 topic_type: ["apiref"]
 f1_keywords: ["_heapset", "heapset"]
 helpviewer_keywords: ["checking heap", "heapset function", "heaps, checking", "debugging [CRT], heap-related problems", "_heapset function"]
-ms.assetid: 9667eeb0-55bc-4c19-af5f-d1fd0a142b3c
 ---
 # `_heapset`
 
@@ -47,7 +46,7 @@ In addition, if an error occurs, **`_heapset`** sets `errno` to `ENOSYS`.
 
 The **`_heapset`** function shows free memory locations or nodes that have been unintentionally overwritten.
 
-**`_heapset`** checks for minimal consistency on the heap and then sets each byte of the heap's free entries to the `fill` value. This known value shows which memory locations of the heap contain free nodes and which contain data that were unintentionally written to freed memory. If the operating system doesn't support **`_heapset`**(for example, Windows 98), the function returns `_HEAPOK` and sets `errno` to `ENOSYS`.
+**`_heapset`** checks for minimal consistency on the heap and then sets each byte of the heap's free entries to the `fill` value. This known value shows which memory locations of the heap contain free nodes and which contain data that were unintentionally written to freed memory. If the operating system doesn't support **`_heapset`** (for example, Windows 98), the function returns `_HEAPOK` and sets `errno` to `ENOSYS`.
 
 ## Requirements
 

docs/c-runtime-library/reference/heapchk.md

@@ -1,14 +1,13 @@
 ---
-description: "Learn more about: _heapchk"
 title: "_heapchk"
+description: "Learn more about: _heapchk"
 ms.date: "4/2/2020"
 api_name: ["_heapchk", "_o__heapchk"]
 api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-heap-l1-1-0.dll"]
 api_type: ["DLLExport"]
 topic_type: ["apiref"]
 f1_keywords: ["_heapchk", "heapchk"]
 helpviewer_keywords: ["debugging [CRT], heap-related problems", "consistency checking of heaps", "heapchk function", "heaps, checking consistency", "_heapchk function"]
-ms.assetid: 859619a5-1e35-4f02-9e09-11d9fa266ec0
 ---
 # `_heapchk`
 
@@ -36,7 +35,7 @@ In addition, if an error occurs, **`_heapchk`** sets `errno` to `ENOSYS`.
 
 ## Remarks
 
-The **`_heapchk`** function helps debug heap-related problems by checking for minimal consistency of the heap. If the operating system doesn't support **`_heapchk`**(for example, Windows 98), the function returns `_HEAPOK` and sets `errno` to `ENOSYS`.
+The **`_heapchk`** function helps debug heap-related problems by checking for minimal consistency of the heap. If the operating system doesn't support **`_heapchk`** (for example, Windows 98), the function returns `_HEAPOK` and sets `errno` to `ENOSYS`.
 
 By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md).
 

docs/c-runtime-library/reference/heapmin.md

@@ -1,14 +1,13 @@
 ---
-description: "Learn more about: _heapmin"
 title: "_heapmin"
+description: "Learn more about: _heapmin"
 ms.date: "4/2/2020"
 api_name: ["_heapmin", "_o__heapmin"]
 api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-heap-l1-1-0.dll"]
 api_type: ["DLLExport"]
 topic_type: ["apiref"]
 f1_keywords: ["_heapmin", "heapmin"]
 helpviewer_keywords: ["heap memory", "minimizing heaps", "memory, releasing", "heaps, releasing unused memory", "_heapmin function", "heapmin function"]
-ms.assetid: c0bccdf6-2d14-4d7b-a7ff-d6a17bdb410f
 ---
 # `_heapmin`
 
@@ -28,7 +27,7 @@ For more information about this and other return codes, see [`errno`, `_doserrno
 
 ## Remarks
 
-The **`_heapmin`** function minimizes the heap by releasing unused heap memory to the operating system. If the operating system doesn't support **`_heapmin`**(for example, Windows 98), the function returns -1 and sets `errno` to `ENOSYS`.
+The **`_heapmin`** function minimizes the heap by releasing unused heap memory to the operating system. If the operating system doesn't support **`_heapmin`** (for example, Windows 98), the function returns -1 and sets `errno` to `ENOSYS`.
 
 By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md).
 

docs/code-quality/c6030.md

@@ -6,33 +6,32 @@ f1_keywords: ["C6030", "USE_ATTRIBUTE_NORETURN", "__WARNING_USE_ATTRIBUTE_NORETU
 helpviewer_keywords: ["C6030"]
 ---
 
-# Warning  C6030
+# Warning C6030
 
 > Use attribute [[noreturn]] over __declspec(noreturn) in function '*function-name*'
 
 ## Remarks
 
-This warning suggests using the C++11 standard attribute `[[noreturn]]` in place of the declspec variant `__declspec(noreturn)`. The standard attribute provides better cross-platform support because it doesn't rely on language extensions.
+This warning suggests using the C++11 standard attribute [`[[noreturn]]`](../cpp/attributes.md#noreturn) in place of the declspec variant [`__declspec(noreturn)`](../cpp/noreturn.md). The standard attribute provides better cross-platform support because it doesn't rely on language extensions.
 
 This warning is off by default and isn't part of the `All Rules` rule set. To enable this warning, it must be added to the rule set file being used.
 
 This check is available in Visual Studio 2022 version 17.0 and later versions.
+
 Code analysis name: `USE_ATTRIBUTE_NORETURN`
 
 ## Example
 
 The following code generates C6030:
 
 ```cpp
-__declspec(noreturn) void TerminateApplication();
-
+__declspec(noreturn) void terminate_application();
 ```
 
 Fix the issue by using the `[[noreturn]]` attribute:
 
 ```cpp
-[[ noreturn ]] void TerminateApplication();
-
+[[noreturn]] void terminate_application();
 ```
 
 ## See also

docs/cpp/unhook.md

@@ -64,7 +64,7 @@ A pointer to the event handler method to be unhooked from an event. The handler
 
 - Managed events: *`ReceiverClass`* is the event receiver class and *`HandlerMethod`* is the handler.
 
-*`receiver`*(optional)
+*`receiver`* (optional)
 A pointer to an instance of the event receiver class. If you don't specify a receiver, the default is the receiver class or structure in which **`__unhook`** is called.
 
 ## Usage

docs/dotnet/data-access-using-adonet-cpp-cli.md

@@ -1,9 +1,8 @@
 ---
-description: "Learn more about: Data Access Using ADO.NET (C++/CLI)"
 title: "Data Access Using ADO.NET (C++/CLI)"
+description: "Learn more about: Data Access Using ADO.NET (C++/CLI)"
 ms.date: "11/04/2016"
 helpviewer_keywords: ["ADO.NET [C++]", ".NET Framework [C++], data access", "databases [C++], accessing in C++", "data access [C++], ADO.NET", "data [C++], ADO.NET", "native strings [C++]", "ADO.NET [C++], marshaling ANSI strings", "strings [C++], ADO.NET", "BSTRs, strings", "ADO.NET [C++], marshaling BSTR strings", "strings [C++], marshaling BSTR strings", "ADO.NET [C++], marshaling Unicode strings", "Unicode [C++], strings", "strings [C++], Unicode", "VARIANT, marshaling", "ADO.NET [C++], marshaling VARIANT types", "VARIANT", "SAFEARRAY, marshaling", "ADO.NET [C++], marshaling SAFEARRAY types"]
-ms.assetid: b0cd987d-1ea7-4f76-ba01-cbd52503d06d
 ---
 # Data Access Using ADO.NET (C++/CLI)
 
@@ -152,7 +151,7 @@ The rest of the code in this example is native C++ code, as is indicated by the
 > [!NOTE]
 > The memory allocated by <xref:System.Runtime.InteropServices.Marshal.StringToBSTR%2A> must be deallocated by calling either <xref:System.Runtime.InteropServices.Marshal.FreeBSTR%2A> or `SysFreeString`.
 
-``` cpp
+```cpp
 // adonet_marshal_string_bstr.cpp
 // compile with: /clr /FU System.dll /FU System.Data.dll /FU System.Xml.dll
 #include <comdef.h>

docs/extensions/compiler-support-for-type-traits-cpp-component-extensions.md

@@ -1,11 +1,10 @@
 ---
-description: "Learn more about: Compiler Support for Type Traits (C++/CLI and C++/CX)"
 title: "Compiler Support for Type Traits (C++/CLI and C++/CX)"
+description: "Learn more about: Compiler Support for Type Traits (C++/CLI and C++/CX)"
 ms.date: "10/12/2018"
 ms.topic: "reference"
 f1_keywords: ["__is_simple_value_class", "__has_trivial_destructor", "__has_assign", "__is_union", "__is_class", "__is_abstract", "__has_trivial_assign", "__has_virtual_destructor", "__is_ref_array", "__is_base_of", "__has_copy", "__is_polymorphic", "__has_nothrow_constructor", "__is_ref_class", "__is_delegate", "__is_convertible_to", "__is_value_class", "__is_interface_class", "__has_nothrow_copy", "__is_sealed", "__has_trivial_constructor", "__has_trivial_copy", "__is_enum", "__has_nothrow_assign", "__has_finalizer", "__is_empty", "__is_pod", "__has_user_destructor"]
 helpviewer_keywords: ["__is_class keyword [C++]", "__is_pod keyword [C++]", "__is_delegate keyword [C++]", "__is_value_class keyword [C++]", "__has_copy keyword [C++]", "__has_nothrow_copy keyword [C++]", "__is_interface_class keyword [C++]", "__is_sealed keyword [C++]", "__is_convertible_to keyword [C++]", "__is_ref_class keyword [C++]", "__has_trivial_copy keyword [C++]", "__has_user_destructor keyword [C++]", "__is_abstract keyword [C++]", "__is_empty keyword [C++]", "__has_trivial_assign keyword [C++]", "__has_nothrow_constructor keyword [C++]", "__is_ref_array keyword [C++]", "__is_base_of keyword [C++]", "__has_nothrow_assign keyword [C++]", "__has_virtual_destructor keyword [C++]", "__has_finalizer keyword [C++]", "__is_union keyword [C++]", "__has_assign keyword [C++]", "__has_trivial_destructor keyword [C++]", "__is_polymorphic keyword [C++]", "__is_enum keyword [C++]", "__is_simple_value_class keyword [C++]", "__has_trivial_constructor keyword [C++]"]
-ms.assetid: cd440630-0394-48c0-a16b-1580b6ef5844
 ---
 # Compiler Support for Type Traits (C++/CLI and C++/CX)
 
@@ -160,7 +159,7 @@ The following list contains the type traits that are supported by the compiler.
 
    Returns **`true`** if the type has a trivial, compiler-generated destructor.
 
-    ``` cpp
+    ```cpp
     // has_trivial_destructor.cpp
     #include <stdio.h>
     struct S {};