EndFile(Int32,String) Method

In This Topic

End the current log file (but not the session) and open a new file to continue logging, specifying an optional reason and attributing the request farther back in the call stack.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Sub EndFile( _
   ByVal skipFrames As Integer, _
   ByVal reason As String _
)

public static void EndFile( 
   int skipFrames,
   string reason
)

Parameters

skipFrames: The number of stack frames to skip back over to determine the original caller. (0 means the immediate caller of this method; 1 means their immediate caller, and so on.)
reason: An optionally-declared reason for invoking this operation (may be null or empty).

Remarks

This method is provided to support user-initiated roll-over to a new log file (instead of waiting for an automatic maintenance roll-over) in order to allow the logs of an ongoing session up to that point to be collected and submitted for analysis without shutting down the subject application.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Log Class
Log Members
Overload List

Send Feedback