Skip to content

Commit 512f2de

Browse files
authored
Update OverflowAction.xml
1 parent c378828 commit 512f2de

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

xml/System.Diagnostics/OverflowAction.xml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@
3737
3838
Use the <xref:System.Diagnostics.EventLog.ModifyOverflowPolicy%2A> method to set the overflow behavior for an <xref:System.Diagnostics.EventLog>. Check the current configured behavior of an <xref:System.Diagnostics.EventLog> through its <xref:System.Diagnostics.EventLog.OverflowAction%2A> property.
3939
40+
> [!WARNING]
41+
> The `OverwriteOlder` behavior is deprecated. Using this value may cause the Event Log to behave as if the `DoNotOverwrite` value was used instead, which will cause events to be discarded when the log is full.
42+
4043
## Examples
4144
4245
The following example enumerates the event logs defined on the local computer and displays configuration details for each event log.
@@ -111,5 +114,47 @@ The following example enumerates the event logs defined on the local computer an
111114
<summary>Indicates that each new entry overwrites the oldest entry when the event log is full.</summary>
112115
</Docs>
113116
</Member>
117+
<Member MemberName="OverwriteOlder">
118+
<MemberSignature Language="C#" Value="OverwriteOlder" />
119+
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Diagnostics.OverflowAction OverwriteOlder = int32(1)" />
120+
<MemberSignature Language="DocId" Value="F:System.Diagnostics.OverflowAction.OverwriteOlder" />
121+
<MemberSignature Language="VB.NET" Value="OverwriteOlder" />
122+
<MemberSignature Language="F#" Value="OverwriteOlder = 1" Usage="System.Diagnostics.OverflowAction.OverwriteOlder" />
123+
<MemberSignature Language="C++ CLI" Value="OverwriteOlder" />
124+
<MemberType>Field</MemberType>
125+
<AssemblyInfo>
126+
<AssemblyName>System</AssemblyName>
127+
<AssemblyVersion>2.0.0.0</AssemblyVersion>
128+
<AssemblyVersion>4.0.0.0</AssemblyVersion>
129+
</AssemblyInfo>
130+
<AssemblyInfo>
131+
<AssemblyName>System.Diagnostics.EventLog</AssemblyName>
132+
<AssemblyVersion>4.0.0.0</AssemblyVersion>
133+
<AssemblyVersion>4.0.1.0</AssemblyVersion>
134+
<AssemblyVersion>4.0.2.0</AssemblyVersion>
135+
<AssemblyVersion>5.0.0.0</AssemblyVersion>
136+
<AssemblyVersion>6.0.0.0</AssemblyVersion>
137+
<AssemblyVersion>7.0.0.0</AssemblyVersion>
138+
<AssemblyVersion>8.0.0.0</AssemblyVersion>
139+
</AssemblyInfo>
140+
<ReturnValue>
141+
<ReturnType>System.Diagnostics.OverflowAction</ReturnType>
142+
</ReturnValue>
143+
<MemberValue>1</MemberValue>
144+
<Docs>
145+
<summary>Deprecated</summary>
146+
<remarks>
147+
<format type="text/markdown"><![CDATA[
148+
> [!WARNING]
149+
> Do not use this value. Doing so may cause the Event Log to behave as if the `DoNotOverwrite` value was used instead.
150+
151+
]]></format>
152+
</remarks>
153+
<altmember cref="T:System.Diagnostics.EventLog" />
154+
<altmember cref="P:System.Diagnostics.EventLog.OverflowAction" />
155+
<altmember cref="P:System.Diagnostics.EventLog.MaximumKilobytes" />
156+
<altmember cref="M:System.Diagnostics.EventLog.ModifyOverflowPolicy(System.Diagnostics.OverflowAction,System.Int32)" />
157+
</Docs>
158+
</Member>
114159
</Members>
115160
</Type>

0 commit comments

Comments
 (0)