IFileLoggingSession IFileLoggingSession IFileLoggingSession IFileLoggingSession Interface

Definition

Represents the destination of logged messages from LoggingChannel instances.

public : interface IFileLoggingSession : IClosable
public interface IFileLoggingSession : IDisposable
Public Interface IFileLoggingSession Implements IDisposable
// You can't instantiate an interface directly in JavaScript. You can use objects that implement the interface, however.
Inheritance
IClosableIDisposableIDisposableIDisposable
IFileLoggingSessionIFileLoggingSessionIFileLoggingSessionIFileLoggingSession
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

Name Name Name Name

Gets the name of the logging session.

public : Platform::String Name { get; }
public string Name { get; }
Public ReadOnly Property Name As string
var string = iFileLoggingSession.name;
Value
Platform::String string string string

The session name.

Methods

AddLoggingChannel(ILoggingChannel) AddLoggingChannel(ILoggingChannel) AddLoggingChannel(ILoggingChannel) AddLoggingChannel(ILoggingChannel)

Adds a logging channel to the current logging session.

public : void AddLoggingChannel(ILoggingChannel loggingChannel)
public void AddLoggingChannel(ILoggingChannel loggingChannel)
Public Function AddLoggingChannel(loggingChannel As ILoggingChannel) As void
iFileLoggingSession.addLoggingChannel(loggingChannel);
Parameters
loggingChannel
ILoggingChannel ILoggingChannel ILoggingChannel ILoggingChannel

The logging channel to add.

See Also

AddLoggingChannel(ILoggingChannel, LoggingLevel) AddLoggingChannel(ILoggingChannel, LoggingLevel) AddLoggingChannel(ILoggingChannel, LoggingLevel) AddLoggingChannel(ILoggingChannel, LoggingLevel)

Adds a logging channel with the specified logging level to the current logging session.

public : void AddLoggingChannel(ILoggingChannel loggingChannel, LoggingLevel maxLevel)
public void AddLoggingChannel(ILoggingChannel loggingChannel, LoggingLevel maxLevel)
Public Function AddLoggingChannel(loggingChannel As ILoggingChannel, maxLevel As LoggingLevel) As void
iFileLoggingSession.addLoggingChannel(loggingChannel, maxLevel);
Parameters
loggingChannel
ILoggingChannel ILoggingChannel ILoggingChannel ILoggingChannel

The logging channel to add.

maxLevel
LoggingLevel LoggingLevel LoggingLevel LoggingLevel

The logging level for loggingChannel.

See Also

Close Close Close Close

Inherited from IClosable

CloseAndSaveToFileAsync() CloseAndSaveToFileAsync() CloseAndSaveToFileAsync() CloseAndSaveToFileAsync()

Ends the current logging session and saves it to a file.

public : IAsyncOperation<StorageFile> CloseAndSaveToFileAsync()
public IAsyncOperation<StorageFile> CloseAndSaveToFileAsync()
Public Function CloseAndSaveToFileAsync() As IAsyncOperation( Of StorageFile )
Windows.Foundation.Diagnostics.IFileLoggingSession.closeAndSaveToFileAsync().done( /* Your success and error handlers */ );
Returns

RemoveLoggingChannel(ILoggingChannel) RemoveLoggingChannel(ILoggingChannel) RemoveLoggingChannel(ILoggingChannel) RemoveLoggingChannel(ILoggingChannel)

Removes the specified logging channel from the current logging session.

public : void RemoveLoggingChannel(ILoggingChannel loggingChannel)
public void RemoveLoggingChannel(ILoggingChannel loggingChannel)
Public Function RemoveLoggingChannel(loggingChannel As ILoggingChannel) As void
iFileLoggingSession.removeLoggingChannel(loggingChannel);
Parameters
loggingChannel
ILoggingChannel ILoggingChannel ILoggingChannel ILoggingChannel

The logging channel to remove.

Events

LogFileGenerated LogFileGenerated LogFileGenerated LogFileGenerated

Raised when a log file is saved.

public : event TypedEventHandler LogFileGenerated<IFileLoggingSession, LogFileGeneratedEventArgs>
public event TypedEventHandler LogFileGenerated<IFileLoggingSession, LogFileGeneratedEventArgs>
Public Event TypedEventHandler LogFileGenerated( Of ( Of IFileLoggingSession ), ( Of LogFileGeneratedEventArgs ))
function onLogFileGenerated(eventArgs){/* Your code */}


iFileLoggingSession.addEventListener("logFileGenerated", onLogFileGenerated);
iFileLoggingSession.removeEventListener("logFileGenerated", onLogFileGenerated);

See Also

  • IClosable IDisposable IDisposable IDisposable