RollingFlatFileSink.StreamWriterRollingHelper.CheckIsRollNecessary Method

Applies to: Semantic Logging 2.0

Checks whether rolling should be performed, and returns the date to use when performing the roll.

Namespace: Microsoft.Practices.EnterpriseLibrary.SemanticLogging.Sinks
Assembly: Microsoft.Practices.EnterpriseLibrary.SemanticLogging.TextFile (in Microsoft.Practices.EnterpriseLibrary.SemanticLogging.TextFile.dll) Version: 2.0.1406.1

Syntax

public Nullable<DateTime> CheckIsRollNecessary()

'Declaration
Public Function CheckIsRollNecessary As Nullable(Of DateTime)

Return Value

Type: Nullable<DateTime>
The date roll to use if performing a roll, or nulla null reference (Nothing in Visual Basic) if no rolling should occur.

Remarks

Defer request for the roll date until it is necessary to avoid overhead.

Information used for rolling checks should be set by now.

See Also

RollingFlatFileSink.StreamWriterRollingHelper Class

RollingFlatFileSink.StreamWriterRollingHelper Members

Microsoft.Practices.EnterpriseLibrary.SemanticLogging.Sinks Namespace