Merge pull request #6014 from MicrosoftDocs/main

Auto Publish – main to live - 2025-07-18 17:30 UTC

Author: learn-build-service-prod[bot]

docs/build-insights/reference/sdk/functions/relog-a.md

@@ -1,10 +1,10 @@
 ---
 title: "RelogA"
 description: "The C++ Build Insights SDK RelogA function reference."
-ms.date: "02/12/2020"
+ms.date: 02/12/2020
 helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "RelogA", "throughput analysis", "build time analysis", "vcperf.exe"]
 ---
-# RelogA
+# `RelogA`
 
 ::: moniker range="<=msvc-140"
 
@@ -26,17 +26,17 @@ enum RESULT_CODE RelogA(
 
 ### Parameters
 
-*inputLogFile*\
+*`inputLogFile`*\
 The input ETW trace that you wish to read events from.
 
-*outputLogFile*\
+*`outputLogFile`*\
 The file in which to write the new events.
 
-*relogDescriptor*\
-Pointer to a [RELOG_DESCRIPTOR](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session.
+*`relogDescriptor`*\
+Pointer to a [`RELOG_DESCRIPTOR`](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session.
 
 ### Return Value
 
-A result code from the [RESULT_CODE](../other-types/result-code-enum.md) enum.
+A result code from the [`RESULT_CODE`](../other-types/result-code-enum.md) enum.
 
 ::: moniker-end

docs/build-insights/reference/sdk/functions/relog-w.md

@@ -1,10 +1,10 @@
 ---
 title: "RelogW"
 description: "The C++ Build Insights SDK RelogW function reference."
-ms.date: "02/12/2020"
+ms.date: 02/12/2020
 helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "RelogW", "throughput analysis", "build time analysis", "vcperf.exe"]
 ---
-# RelogW
+# `RelogW`
 
 ::: moniker range="<=msvc-140"
 
@@ -26,17 +26,17 @@ enum RESULT_CODE RelogW(
 
 ### Parameters
 
-*inputLogFile*\
+*`inputLogFile`*\
 The input ETW trace that you wish to read events from.
 
-*outputLogFile*\
+*`outputLogFile`*\
 The file in which to write the new events.
 
-*relogDescriptor*\
-Pointer to a [RELOG_DESCRIPTOR](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session.
+*`relogDescriptor`*\
+Pointer to a [`RELOG_DESCRIPTOR`](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session.
 
 ### Return Value
 
-A result code from the [RESULT_CODE](../other-types/result-code-enum.md) enum.
+A result code from the [`RESULT_CODE`](../other-types/result-code-enum.md) enum.
 
 ::: moniker-end

docs/build-insights/reference/sdk/functions/relog.md

@@ -1,10 +1,10 @@
 ---
 title: "Relog"
 description: "The C++ Build Insights SDK Relog function reference."
-ms.date: "02/12/2020"
+ms.date: 02/12/2020
 helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "Relog", "throughput analysis", "build time analysis", "vcperf.exe"]
 ---
-# Relog
+# `Relog`
 
 ::: moniker range="<=msvc-140"
 
@@ -41,42 +41,44 @@ RESULT_CODE Relog(
     StaticReloggerGroup<TReloggerGroupMembers...> reloggerGroup);
 ```
 
-### Parameters
+### Template parameters
+
+*`TAnalyzerGroupMembers`*\
+This template parameter pack is always deduced.
 
-*TAnalyzerGroupMembers*\
-This parameter is always deduced.
+*`TReloggerGroupMembers`*\
+This template parameter pack is always deduced.
 
-*TReloggerGroupMembers*\
-This parameter is always deduced.
+### Parameters
 
-*inputLogFile*\
+*`inputLogFile`*\
 The input ETW trace that you wish to read events from.
 
-*outputLogFile*\
+*`outputLogFile`*\
 The file in which to write the new events.
 
-*numberOfAnalysisPasses*\
+*`numberOfAnalysisPasses`*\
 The number of analysis passes to run on the input trace. The trace gets passed through the provided analyzer group once per analysis pass.
 
-*systemEventsRetentionFlags*\
-A bitmask that specifies which system ETW events to keep in the relogged trace. For more information, see [RELOG_RETENTION_SYSTEM_EVENT_FLAGS](../other-types/relog-retention-system-event-flags-constants.md).
+*`systemEventsRetentionFlags`*\
+A bitmask that specifies which system ETW events to keep in the relogged trace. For more information, see [`RELOG_RETENTION_SYSTEM_EVENT_FLAGS`](../other-types/relog-retention-system-event-flags-constants.md).
 
-*analyzerGroup*\
-The analyzer group used for the analysis phase of the relogging session. Call [MakeStaticAnalyzerGroup](make-static-analyzer-group.md) to create an analyzer group. To use a dynamic analyzer group obtained from [MakeDynamicAnalyzerGroup](make-dynamic-analyzer-group.md), first encapsulate it inside a static analyzer group by passing its address to `MakeStaticAnalyzerGroup`.
+*`analyzerGroup`*\
+The analyzer group used for the analysis phase of the relogging session. Call [`MakeStaticAnalyzerGroup`](make-static-analyzer-group.md) to create an analyzer group. To use a dynamic analyzer group obtained from [`MakeDynamicAnalyzerGroup`](make-dynamic-analyzer-group.md), first encapsulate it inside a static analyzer group by passing its address to `MakeStaticAnalyzerGroup`.
 
-*reloggerGroup*\
-The relogger group that relogs events into the trace file specified in *outputLogFile*. Call [MakeStaticReloggerGroup](make-static-relogger-group.md) to create a relogger group. To use a dynamic relogger group obtained from [MakeDynamicReloggerGroup](make-dynamic-relogger-group.md), first encapsulate it inside a static relogger group by passing its address to `MakeStaticReloggerGroup`.
+*`reloggerGroup`*\
+The relogger group that relogs events into the trace file specified in *`outputLogFile`*. Call [`MakeStaticReloggerGroup`](make-static-relogger-group.md) to create a relogger group. To use a dynamic relogger group obtained from [`MakeDynamicReloggerGroup`](make-dynamic-relogger-group.md), first encapsulate it inside a static relogger group by passing its address to `MakeStaticReloggerGroup`.
 
 ### Return Value
 
-A result code from the [RESULT_CODE](../other-types/result-code-enum.md) enum.
+A result code from the [`RESULT_CODE`](../other-types/result-code-enum.md) enum.
 
-### Remark
+### Remarks
 
-The input trace is passed through the analyzer group *numberOfAnalysisPasses* times. There's no similar option for relogging passes. The trace is passed trough the relogger group only once, after all analysis passes are complete.
+The input trace is passed through the analyzer group *`numberOfAnalysisPasses`* times. There's no similar option for relogging passes. The trace is passed trough the relogger group only once, after all analysis passes are complete.
 
-The relogging of system events like CPU samples from within a relogger class isn't supported. Use the *systemEventsRetentionFlags* parameter to decide which system events to keep in the output trace.
+The relogging of system events like CPU samples from within a relogger class isn't supported. Use the *`systemEventsRetentionFlags`* parameter to decide which system events to keep in the output trace.
 
-The `relog` function depends on the COM API. You must call `CoInitialize` before you call `relog`. Call `CoUninitialize` once `relog` has finished. If you call `relog` without a call to `CoInitialize` first, you'll get error code 9 (`RESULT_CODE_FAILURE_START_RELOGGER`).
+The `relog` function depends on the COM API. You must call [`CoInitialize`](/windows/win32/api/objbase/nf-objbase-coinitialize) before you call `relog`. Call [`CoUninitialize`](/windows/win32/api/combaseapi/nf-combaseapi-couninitialize) once `relog` has finished. If you call `relog` without a call to `CoInitialize` first, you'll get error code 9 (`RESULT_CODE_FAILURE_START_RELOGGER`).
 
 ::: moniker-end

docs/cpp/modules-cpp.md

@@ -6,7 +6,7 @@ helpviewer_keywords: ["modules [C++]", "modules [C++], overview"]
 ---
 # Overview of modules in C++
 
-C++20 introduces *modules*. A *module* is a set of source code files that are compiled independently of the source files (or more precisely, the [translation units](https://wikipedia.org/wiki/Translation_unit_(programming)) that import them).
+C++20 introduces *modules*. A *module* is a set of source code files that are compiled independently of the source files (or more precisely, the [translation units](https://wikipedia.org/wiki/Translation_unit_(programming))) that import them.
 
 Modules eliminate or reduce many of the problems associated with the use of header files. They often reduce compilation times, sometimes significantly. Macros, preprocessor directives, and nonexported names declared in a module aren't visible outside the module. They have no effect on the compilation of the translation unit that imports the module. You can import modules in any order without concern for macro redefinitions. Declarations in the importing translation unit don't participate in overload resolution or name lookup in the imported module. After a module is compiled once, the results are stored in a binary file that describes all the exported types, functions, and templates. The compiler can process that file much faster than a header file. And, the compiler can reuse it every place where the module is imported in a project.
 

docs/cpp/nothrow-cpp.md

@@ -1,10 +1,9 @@
 ---
-description: "Learn more about: nothrow (C++)"
 title: "nothrow (C++)"
-ms.date: "01/03/2018"
+description: "Learn more about: nothrow (C++)"
+ms.date: 01/03/2018
 f1_keywords: ["nothrow_cpp"]
 helpviewer_keywords: ["__declspec keyword [C++], nothrow", "nothrow __declspec keyword"]
-ms.assetid: 0a475139-459c-4ec6-99e8-7ecd0d7f44a3
 ---
 # `nothrow` (C++)
 
@@ -20,7 +19,7 @@ A **`__declspec`** extended attribute which can be used in the declaration of fu
 
 We recommend that all new code use the [`noexcept`](noexcept-cpp.md) operator rather than `__declspec(nothrow)`.
 
-This attribute tells the compiler that the declared function and the functions it calls never throw an exception. However, it does not enforce the directive. In other words, it never causes [`std::terminate`](../standard-library/exception-functions.md#terminate) to be invoked, unlike **`noexcept`**, or in **`std:c++17`** mode (Visual Studio 2017 version 15.5 and later), `throw()`.
+This attribute tells the compiler that the declared function and the functions it calls never throw an exception. However, it does not enforce the directive. In other words, it never causes [`std::terminate`](../standard-library/exception-functions.md#terminate) to be invoked, unlike **`noexcept`**, or in **`/std:c++17`** mode (Visual Studio 2017 version 15.5 and later), `throw()`.
 
 With the synchronous exception handling model, now the default, the compiler can eliminate the mechanics of tracking the lifetime of certain unwindable objects in such a function, and significantly reduce the code size. Given the following preprocessor directive, the three function declarations below are equivalent in **`/std:c++14`** mode:
 

docs/cpp/results-of-calling-example.md

@@ -1,9 +1,8 @@
 ---
-description: "Learn more about: Results of Calling Example"
 title: "Results of Calling Example"
-ms.date: "11/19/2018"
+description: "Learn more about: Results of Calling Example"
+ms.date: 11/19/2018
 helpviewer_keywords: ["examples [C++], results of calling", "results, thiscall call", "results, __fastcall keyword call", "results, __cdecl call", "results, __stdcall call"]
-ms.assetid: aa70a7cb-ba1d-4aa6-bd0a-ba783da2e642
 ---
 # Results of Calling Example
 
@@ -20,7 +19,7 @@ The **`__cdecl`** calling convention
 
 The C decorated name (**`__stdcall`**) is `_MyFunc@20`. The C++ decorated name is implementation-specific.
 
-![Diagram showing the stack and registers for the S T D call and this call calling conventions.](../cpp/media/vc37i02.gif )<br/>
+![Diagram showing the stack and registers for the S T D call and this call calling conventions.](../cpp/media/vc37i02.gif)<br/>
 The __stdcall and thiscall calling conventions
 
 ## `__fastcall`

docs/data/oledb/creating-an-updatable-provider.md

@@ -1,9 +1,8 @@
 ---
-description: "Learn more about: Creating an Updatable Provider"
 title: "Creating an Updatable Provider"
-ms.date: "08/16/2018"
+description: "Learn more about: Creating an Updatable Provider"
+ms.date: 08/16/2018
 helpviewer_keywords: ["OLE DB providers, updatable", "notifications, support in providers", "OLE DB providers, creating"]
-ms.assetid: bdfd5c9f-1c6f-4098-822c-dd650e70ab82
 ---
 # Creating an Updatable Provider
 
@@ -174,7 +173,7 @@ Making sure that the data store can handle changes.
 
 Handling NULL values.
 
-### Handling default values.
+### Handling default values
 
 To implement your own `FlushData` method, you need to:
 

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

@@ -1,13 +1,14 @@
 ---
-description: "Learn more about: Compiler Error C2121"
 title: "Compiler Error C2121"
-ms.date: "11/04/2016"
+description: "Learn more about: Compiler Error C2121"
+ms.date: 11/04/2016
 f1_keywords: ["C2121"]
 helpviewer_keywords: ["C2121"]
-ms.assetid: e04f32da-3736-4df3-8a1c-d687afcecf5c
 ---
 # Compiler Error C2121
 
-'#' : invalid character : possibly the result of a macro expansion
+> '#' : invalid character : possibly the result of a macro expansion
+
+## Remarks
 
 An invalid # character may have been inserted by an incorrect macro that uses the token-pasting operator (##) instead of the stringizing operator (#).

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

@@ -1,13 +1,14 @@
 ---
-description: "Learn more about: Compiler Error C2122"
 title: "Compiler Error C2122"
-ms.date: "11/04/2016"
+description: "Learn more about: Compiler Error C2122"
+ms.date: 11/04/2016
 f1_keywords: ["C2122"]
 helpviewer_keywords: ["C2122"]
-ms.assetid: bc060002-cd38-481b-a144-65af035ce851
 ---
 # Compiler Error C2122
 
-'identifier' : prototype parameter in name list illegal
+> 'identifier' : prototype parameter in name list illegal
+
+## Remarks
 
 The parameter is not a legal type. ANSI C does not support user-defined types.

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

@@ -1,18 +1,21 @@
 ---
-description: "Learn more about: Compiler Error C2124"
 title: "Compiler Error C2124"
-ms.date: "11/04/2016"
+description: "Learn more about: Compiler Error C2124"
+ms.date: 11/04/2016
 f1_keywords: ["C2124"]
 helpviewer_keywords: ["C2124"]
-ms.assetid: 93392aaa-5582-4d68-8cc5-bd9c62a0ae7e
 ---
 # Compiler Error C2124
 
-divide or mod by zero
+> divide or mod by zero
+
+## Remarks
 
 A constant expression has a zero denominator. To resolve the error, do not divide by zero.
 
-The following sample generates C2124:
+## Example
+
+The following example generates C2124:
 
 ```cpp
 // C2124.cpp