Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
75 lines (72 sloc) 4.33 KB
<Type Name="DiskSpaceExhaustedOption" FullName="Microsoft.VisualBasic.Logging.DiskSpaceExhaustedOption">
<TypeSignature Language="C#" Value="public enum DiskSpaceExhaustedOption" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed DiskSpaceExhaustedOption extends System.Enum" />
<TypeSignature Language="DocId" Value="T:Microsoft.VisualBasic.Logging.DiskSpaceExhaustedOption" />
<TypeSignature Language="VB.NET" Value="Public Enum DiskSpaceExhaustedOption" />
<TypeSignature Language="C++ CLI" Value="public enum class DiskSpaceExhaustedOption" />
<TypeSignature Language="F#" Value="type DiskSpaceExhaustedOption = " />
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Determines what to do when the <see cref="T:Microsoft.VisualBasic.Logging.FileLogTraceListener" /> object attempts to write to a log and there is less free disk space available than specified by the <see cref="P:Microsoft.VisualBasic.Logging.FileLogTraceListener.ReserveDiskSpace" /> property.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When the <xref:Microsoft.VisualBasic.Logging.FileLogTraceListener.DiskSpaceExhaustedBehavior%2A> property is set to DiscardMessages, the log messages are by default discarded if there is not enough reserved disk space. This prevents simple applications from failing if the disk gets too full.
For a more robust application, set the <xref:Microsoft.VisualBasic.Logging.FileLogTraceListener.DiskSpaceExhaustedBehavior%2A> property to ThrowException, and add `Try...Catch` blocks around all code that writes to the log.
]]></format>
</remarks>
<altmember cref="T:Microsoft.VisualBasic.Logging.FileLogTraceListener" />
<altmember cref="P:Microsoft.VisualBasic.Logging.FileLogTraceListener.ReserveDiskSpace" />
</Docs>
<Members>
<Member MemberName="DiscardMessages">
<MemberSignature Language="C#" Value="DiscardMessages" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.VisualBasic.Logging.DiskSpaceExhaustedOption DiscardMessages = int32(1)" />
<MemberSignature Language="DocId" Value="F:Microsoft.VisualBasic.Logging.DiskSpaceExhaustedOption.DiscardMessages" />
<MemberSignature Language="VB.NET" Value="DiscardMessages" />
<MemberSignature Language="C++ CLI" Value="DiscardMessages" />
<MemberSignature Language="F#" Value="DiscardMessages = 1" Usage="Microsoft.VisualBasic.Logging.DiskSpaceExhaustedOption.DiscardMessages" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.VisualBasic.Logging.DiskSpaceExhaustedOption</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Discard log messages.</summary>
</Docs>
</Member>
<Member MemberName="ThrowException">
<MemberSignature Language="C#" Value="ThrowException" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.VisualBasic.Logging.DiskSpaceExhaustedOption ThrowException = int32(0)" />
<MemberSignature Language="DocId" Value="F:Microsoft.VisualBasic.Logging.DiskSpaceExhaustedOption.ThrowException" />
<MemberSignature Language="VB.NET" Value="ThrowException" />
<MemberSignature Language="C++ CLI" Value="ThrowException" />
<MemberSignature Language="F#" Value="ThrowException = 0" Usage="Microsoft.VisualBasic.Logging.DiskSpaceExhaustedOption.ThrowException" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.VisualBasic.Logging.DiskSpaceExhaustedOption</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Throw an exception.</summary>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.