-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
LogPolicy.xml
409 lines (353 loc) · 23.3 KB
/
LogPolicy.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
<Type Name="LogPolicy" FullName="System.IO.Log.LogPolicy">
<TypeSignature Language="C#" Value="public sealed class LogPolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit LogPolicy extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.IO.Log.LogPolicy" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class LogPolicy" />
<TypeSignature Language="F#" Value="type LogPolicy = class" />
<TypeSignature Language="C++ CLI" Value="public ref class LogPolicy sealed" />
<AssemblyInfo>
<AssemblyName>System.IO.Log</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents the policy associated with a <see cref="T:System.IO.Log.LogStore" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A policy is a set of rules to be followed by a <xref:System.IO.Log.LogStore> instance and its clients. A <xref:System.IO.Log.LogPolicy> instance is used to examine and modify the policy associated with a specific <xref:System.IO.Log.LogStore>. A policy can describe the minimum and maximum allowable log sizes, or how the <xref:System.IO.Log.LogStore> instance is allowed to grow. In addition, you can also control whether a <xref:System.IO.Log.LogStore> instance can be archived.
After changing any of the properties, you should use the <xref:System.IO.Log.LogPolicy.Commit%2A> method to ensure that the changes are applied to the <xref:System.IO.Log.LogStore>. You can call the <xref:System.IO.Log.LogPolicy.Refresh%2A> method to discard changes or to get the most current policy.
## Examples
This example shows how to use the <xref:System.IO.Log.LogPolicy> class to set policy for a log record sequence.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uelogrecordsequence/cs/mylogrecordsequence.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uelogrecordsequence/vb/mylogrecordsequence.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="AutoGrow">
<MemberSignature Language="C#" Value="public bool AutoGrow { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AutoGrow" />
<MemberSignature Language="DocId" Value="P:System.IO.Log.LogPolicy.AutoGrow" />
<MemberSignature Language="VB.NET" Value="Public Property AutoGrow As Boolean" />
<MemberSignature Language="F#" Value="member this.AutoGrow : bool with get, set" Usage="System.IO.Log.LogPolicy.AutoGrow" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool AutoGrow { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Log</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether the <see cref="T:System.IO.Log.LogStore" /> can grow automatically.</summary>
<value>
<see langword="true" /> if the <see cref="T:System.IO.Log.LogStore" /> can grow its size automatically; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
This example shows how to use the <xref:System.IO.Log.LogPolicy> class to set policy for a log record sequence.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uelogrecordsequence/cs/mylogrecordsequence.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uelogrecordsequence/vb/mylogrecordsequence.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="AutoShrinkPercentage">
<MemberSignature Language="C#" Value="public int AutoShrinkPercentage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 AutoShrinkPercentage" />
<MemberSignature Language="DocId" Value="P:System.IO.Log.LogPolicy.AutoShrinkPercentage" />
<MemberSignature Language="VB.NET" Value="Public Property AutoShrinkPercentage As Integer" />
<MemberSignature Language="F#" Value="member this.AutoShrinkPercentage : int with get, set" Usage="System.IO.Log.LogPolicy.AutoShrinkPercentage" />
<MemberSignature Language="C++ CLI" Value="public:
 property int AutoShrinkPercentage { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Log</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the percentage of free space the <see cref="T:System.IO.Log.LogStore" /> can shrink.</summary>
<value>The percentage of free space the <see cref="T:System.IO.Log.LogStore" /> can shrink.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When the amount of free space in the <xref:System.IO.Log.LogStore> is greater than the amount specified by this property, the <xref:System.IO.Log.LogStore> automatically reduces its size until it reaches the size specified by the <xref:System.IO.Log.LogPolicy.MinimumExtentCount%2A> property.
## Examples
This example shows how to use the <xref:System.IO.Log.LogPolicy> class to set policy for a log record sequence.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uelogrecordsequence/cs/mylogrecordsequence.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uelogrecordsequence/vb/mylogrecordsequence.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Commit">
<MemberSignature Language="C#" Value="public void Commit ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Commit() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Log.LogPolicy.Commit" />
<MemberSignature Language="VB.NET" Value="Public Sub Commit ()" />
<MemberSignature Language="F#" Value="member this.Commit : unit -> unit" Usage="logPolicy.Commit " />
<MemberSignature Language="C++ CLI" Value="public:
 void Commit();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Log</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Sets this policy as the current policy for the <see cref="T:System.IO.Log.LogStore" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
You must call <xref:System.IO.Log.LogPolicy.Commit%2A> after making any changes to ensure that the changes are recorded.
## Examples
This example shows how to use the <xref:System.IO.Log.LogPolicy> class to set policy for a log record sequence.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uelogrecordsequence/cs/mylogrecordsequence.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uelogrecordsequence/vb/mylogrecordsequence.vb" id="Snippet2":::
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The set of policies installed on the log is invalid.
-or-
A policy of the log prevented this operation from completing.</exception>
<exception cref="T:System.IO.IOException">The request could not be performed because of an unexpected I/O exception.</exception>
<exception cref="T:System.NotSupportedException">Setting this policy is not supported on the current platform.</exception>
<exception cref="T:System.ObjectDisposedException">The method was called after the sequence has been disposed of.</exception>
<exception cref="T:System.OutOfMemoryException">There is not enough memory to continue the execution of the program.</exception>
<exception cref="T:System.IO.PathTooLongException">The new extent prefix is invalid or too long. A valid prefix must be provided.</exception>
<exception cref="T:System.IO.Log.SequenceFullException">The record sequence is full.</exception>
<exception cref="T:System.UnauthorizedAccessException">Access for the specified log store is denied by the operating system.</exception>
</Docs>
</Member>
<Member MemberName="GrowthRate">
<MemberSignature Language="C#" Value="public System.IO.Log.PolicyUnit GrowthRate { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.IO.Log.PolicyUnit GrowthRate" />
<MemberSignature Language="DocId" Value="P:System.IO.Log.LogPolicy.GrowthRate" />
<MemberSignature Language="VB.NET" Value="Public Property GrowthRate As PolicyUnit" />
<MemberSignature Language="F#" Value="member this.GrowthRate : System.IO.Log.PolicyUnit with get, set" Usage="System.IO.Log.LogPolicy.GrowthRate" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IO::Log::PolicyUnit GrowthRate { System::IO::Log::PolicyUnit get(); void set(System::IO::Log::PolicyUnit value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Log</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Log.PolicyUnit</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the rate of automatic growth of the <see cref="T:System.IO.Log.LogStore" />.</summary>
<value>The rate of automatic growth of the <see cref="T:System.IO.Log.LogStore" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When the <xref:System.IO.Log.LogStore> becomes full, this policy value determines how much more space can be added. Space will not be added if it causes the number of extents in the <xref:System.IO.Log.LogStore> to exceed <xref:System.IO.Log.LogPolicy.MaximumExtentCount%2A>.
## Examples
This example shows how to use the <xref:System.IO.Log.LogPolicy> class to set policy for a log record sequence.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uelogrecordsequence/cs/mylogrecordsequence.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uelogrecordsequence/vb/mylogrecordsequence.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MaximumExtentCount">
<MemberSignature Language="C#" Value="public int MaximumExtentCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaximumExtentCount" />
<MemberSignature Language="DocId" Value="P:System.IO.Log.LogPolicy.MaximumExtentCount" />
<MemberSignature Language="VB.NET" Value="Public Property MaximumExtentCount As Integer" />
<MemberSignature Language="F#" Value="member this.MaximumExtentCount : int with get, set" Usage="System.IO.Log.LogPolicy.MaximumExtentCount" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MaximumExtentCount { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Log</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum number of <see cref="T:System.IO.Log.LogExtent" /> instances the <see cref="T:System.IO.Log.LogStore" /> can contain.</summary>
<value>The maximum number of <see cref="T:System.IO.Log.LogExtent" /> instances the <see cref="T:System.IO.Log.LogStore" /> can contain.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
This example shows how to use the <xref:System.IO.Log.LogPolicy> class to set policy for a log record sequence.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uelogrecordsequence/cs/mylogrecordsequence.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uelogrecordsequence/vb/mylogrecordsequence.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MinimumExtentCount">
<MemberSignature Language="C#" Value="public int MinimumExtentCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MinimumExtentCount" />
<MemberSignature Language="DocId" Value="P:System.IO.Log.LogPolicy.MinimumExtentCount" />
<MemberSignature Language="VB.NET" Value="Public Property MinimumExtentCount As Integer" />
<MemberSignature Language="F#" Value="member this.MinimumExtentCount : int with get, set" Usage="System.IO.Log.LogPolicy.MinimumExtentCount" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MinimumExtentCount { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Log</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the minimum number of <see cref="T:System.IO.Log.LogExtent" /> instances the <see cref="T:System.IO.Log.LogStore" /> can contain.</summary>
<value>An integer that specifies the minimum number of <see cref="T:System.IO.Log.LogExtent" /> instances the <see cref="T:System.IO.Log.LogStore" /> can contain. Since the CLFS requires that the minimum extent count to be 2 extents, this value should be at least 2.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
This example shows how to use the <xref:System.IO.Log.LogPolicy> class to set policy for a log record sequence.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uelogrecordsequence/cs/mylogrecordsequence.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uelogrecordsequence/vb/mylogrecordsequence.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="NewExtentPrefix">
<MemberSignature Language="C#" Value="public string NewExtentPrefix { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string NewExtentPrefix" />
<MemberSignature Language="DocId" Value="P:System.IO.Log.LogPolicy.NewExtentPrefix" />
<MemberSignature Language="VB.NET" Value="Public Property NewExtentPrefix As String" />
<MemberSignature Language="F#" Value="member this.NewExtentPrefix : string with get, set" Usage="System.IO.Log.LogPolicy.NewExtentPrefix" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ NewExtentPrefix { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Log</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the prefix string for automatically created extents.</summary>
<value>The prefix string for automatically created extents.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This string can contain a full path to the directory where the new extent is created. The default path to the extent is the directory that contains the base <xref:System.IO.Log.LogStore> file.
## Examples
This example shows how to use the <xref:System.IO.Log.LogPolicy> class to set policy for a log record sequence.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uelogrecordsequence/cs/mylogrecordsequence.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uelogrecordsequence/vb/mylogrecordsequence.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="NextExtentSuffix">
<MemberSignature Language="C#" Value="public long NextExtentSuffix { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 NextExtentSuffix" />
<MemberSignature Language="DocId" Value="P:System.IO.Log.LogPolicy.NextExtentSuffix" />
<MemberSignature Language="VB.NET" Value="Public Property NextExtentSuffix As Long" />
<MemberSignature Language="F#" Value="member this.NextExtentSuffix : int64 with get, set" Usage="System.IO.Log.LogPolicy.NextExtentSuffix" />
<MemberSignature Language="C++ CLI" Value="public:
 property long NextExtentSuffix { long get(); void set(long value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Log</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the suffix number for new extents.</summary>
<value>The suffix number for new extents.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
This example shows how to use the <xref:System.IO.Log.LogPolicy> class to set policy for a log record sequence.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uelogrecordsequence/cs/mylogrecordsequence.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uelogrecordsequence/vb/mylogrecordsequence.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="PinnedTailThreshold">
<MemberSignature Language="C#" Value="public System.IO.Log.PolicyUnit PinnedTailThreshold { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.IO.Log.PolicyUnit PinnedTailThreshold" />
<MemberSignature Language="DocId" Value="P:System.IO.Log.LogPolicy.PinnedTailThreshold" />
<MemberSignature Language="VB.NET" Value="Public Property PinnedTailThreshold As PolicyUnit" />
<MemberSignature Language="F#" Value="member this.PinnedTailThreshold : System.IO.Log.PolicyUnit with get, set" Usage="System.IO.Log.LogPolicy.PinnedTailThreshold" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IO::Log::PolicyUnit PinnedTailThreshold { System::IO::Log::PolicyUnit get(); void set(System::IO::Log::PolicyUnit value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Log</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Log.PolicyUnit</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the amount of space that the <see cref="E:System.IO.Log.LogRecordSequence.TailPinned" /> event requires for advancing the base of the log.</summary>
<value>The amount of space that the <see cref="E:System.IO.Log.LogRecordSequence.TailPinned" /> event requires for advancing the base of the log.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The amount of space can be expressed in percentage, or in bytes which is rounded off to the nearest containers in CLFS. The default is 35 percent.
## Examples
This example shows how to use the <xref:System.IO.Log.LogPolicy> class to set policy for a log record sequence.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uelogrecordsequence/cs/mylogrecordsequence.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uelogrecordsequence/vb/mylogrecordsequence.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Refresh">
<MemberSignature Language="C#" Value="public void Refresh ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Refresh() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Log.LogPolicy.Refresh" />
<MemberSignature Language="VB.NET" Value="Public Sub Refresh ()" />
<MemberSignature Language="F#" Value="member this.Refresh : unit -> unit" Usage="logPolicy.Refresh " />
<MemberSignature Language="C++ CLI" Value="public:
 void Refresh();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Log</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reads the current policy for the <see cref="T:System.IO.Log.LogStore" />, discarding any changes that may have been made.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
This example shows how to use the <xref:System.IO.Log.LogPolicy> class to set policy for a log record sequence.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uelogrecordsequence/cs/mylogrecordsequence.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uelogrecordsequence/vb/mylogrecordsequence.vb" id="Snippet2":::
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The set of policies installed on the log is invalid.
-or-
A policy of the log prevented this operation from completing.</exception>
<exception cref="T:System.IO.IOException">The request could not be performed because of an unexpected I/O exception.</exception>
<exception cref="T:System.NotSupportedException">Setting this policy is not supported on the current platform.</exception>
<exception cref="T:System.ObjectDisposedException">The method was called after the sequence has been disposed of.</exception>
<exception cref="T:System.OutOfMemoryException">There is not enough memory to continue the execution of the program.</exception>
<exception cref="T:System.IO.Log.SequenceFullException">The record sequence is full.</exception>
<exception cref="T:System.UnauthorizedAccessException">Access for the specified log store is denied by the operating system.</exception>
</Docs>
</Member>
</Members>
</Type>