Skip to content

Commit b108b2e

Browse files
v-regandownerv-regandowner
authored
Merge pull request MicrosoftDocs#5443 from Rageking8/update-relog-and-variants-in-build-insights-reference
Update `Relog` and variants in build insights reference
2 parents eb4fc85 + 97dcde0 commit b108b2e

File tree

3 files changed

+37
-35
lines changed

3 files changed

+37
-35
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: "RelogA"
33
description: "The C++ Build Insights SDK RelogA function reference."
4-
ms.date: "02/12/2020"
4+
ms.date: 02/12/2020
55
helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "RelogA", "throughput analysis", "build time analysis", "vcperf.exe"]
66
---
7-
# RelogA
7+
# `RelogA`
88

99
::: moniker range="<=msvc-140"
1010

@@ -26,17 +26,17 @@ enum RESULT_CODE RelogA(
2626
2727
### Parameters
2828
29-
*inputLogFile*\
29+
*`inputLogFile`*\
3030
The input ETW trace that you wish to read events from.
3131
32-
*outputLogFile*\
32+
*`outputLogFile`*\
3333
The file in which to write the new events.
3434
35-
*relogDescriptor*\
36-
Pointer to a [RELOG_DESCRIPTOR](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session.
35+
*`relogDescriptor`*\
36+
Pointer to a [`RELOG_DESCRIPTOR`](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session.
3737
3838
### Return Value
3939
40-
A result code from the [RESULT_CODE](../other-types/result-code-enum.md) enum.
40+
A result code from the [`RESULT_CODE`](../other-types/result-code-enum.md) enum.
4141
4242
::: moniker-end

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: "RelogW"
33
description: "The C++ Build Insights SDK RelogW function reference."
4-
ms.date: "02/12/2020"
4+
ms.date: 02/12/2020
55
helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "RelogW", "throughput analysis", "build time analysis", "vcperf.exe"]
66
---
7-
# RelogW
7+
# `RelogW`
88

99
::: moniker range="<=msvc-140"
1010

@@ -26,17 +26,17 @@ enum RESULT_CODE RelogW(
2626
2727
### Parameters
2828
29-
*inputLogFile*\
29+
*`inputLogFile`*\
3030
The input ETW trace that you wish to read events from.
3131
32-
*outputLogFile*\
32+
*`outputLogFile`*\
3333
The file in which to write the new events.
3434
35-
*relogDescriptor*\
36-
Pointer to a [RELOG_DESCRIPTOR](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session.
35+
*`relogDescriptor`*\
36+
Pointer to a [`RELOG_DESCRIPTOR`](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session.
3737
3838
### Return Value
3939
40-
A result code from the [RESULT_CODE](../other-types/result-code-enum.md) enum.
40+
A result code from the [`RESULT_CODE`](../other-types/result-code-enum.md) enum.
4141
4242
::: moniker-end

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

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: "Relog"
33
description: "The C++ Build Insights SDK Relog function reference."
4-
ms.date: "02/12/2020"
4+
ms.date: 02/12/2020
55
helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "Relog", "throughput analysis", "build time analysis", "vcperf.exe"]
66
---
7-
# Relog
7+
# `Relog`
88

99
::: moniker range="<=msvc-140"
1010

@@ -41,42 +41,44 @@ RESULT_CODE Relog(
4141
StaticReloggerGroup<TReloggerGroupMembers...> reloggerGroup);
4242
```
4343
44-
### Parameters
44+
### Template parameters
45+
46+
*`TAnalyzerGroupMembers`*\
47+
This template parameter pack is always deduced.
4548
46-
*TAnalyzerGroupMembers*\
47-
This parameter is always deduced.
49+
*`TReloggerGroupMembers`*\
50+
This template parameter pack is always deduced.
4851
49-
*TReloggerGroupMembers*\
50-
This parameter is always deduced.
52+
### Parameters
5153
52-
*inputLogFile*\
54+
*`inputLogFile`*\
5355
The input ETW trace that you wish to read events from.
5456
55-
*outputLogFile*\
57+
*`outputLogFile`*\
5658
The file in which to write the new events.
5759
58-
*numberOfAnalysisPasses*\
60+
*`numberOfAnalysisPasses`*\
5961
The number of analysis passes to run on the input trace. The trace gets passed through the provided analyzer group once per analysis pass.
6062
61-
*systemEventsRetentionFlags*\
62-
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).
63+
*`systemEventsRetentionFlags`*\
64+
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).
6365
64-
*analyzerGroup*\
65-
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`.
66+
*`analyzerGroup`*\
67+
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`.
6668
67-
*reloggerGroup*\
68-
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`.
69+
*`reloggerGroup`*\
70+
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`.
6971
7072
### Return Value
7173
72-
A result code from the [RESULT_CODE](../other-types/result-code-enum.md) enum.
74+
A result code from the [`RESULT_CODE`](../other-types/result-code-enum.md) enum.
7375
74-
### Remark
76+
### Remarks
7577
76-
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.
78+
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.
7779
78-
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.
80+
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.
7981
80-
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`).
82+
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`).
8183
8284
::: moniker-end

0 commit comments

Comments
 (0)