UA Bundle SDK .NET  2.2.0.255
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaBase.TraceFileListener Class Reference

Implements a trace listener that writes to a file on disk. More...

Inherits UnifiedAutomation.UaBase.ITraceListener.

Public Member Functions

void Open ()
 Opens the listener for writing. More...
 
void Output (TraceEntry entry)
 Writes a trace entry to the listener. More...
 
void Close ()
 Closes the listener. More...
 
void Dispose ()
 Frees any unmanaged resources. More...
 

Properties

string LogFilePath [get, set]
 The path to the log file. More...
 
byte MaxLogFileBackups [get, set]
 The maximum number of backup files to keep. More...
 
uint MaxEntriesPerLog [get, set]
 The maximum number of entries in the trace file More...
 
bool FastTrace [get, set]
 Whether the entries should be written to disk immediately. More...
 

Detailed Description

Implements a trace listener that writes to a file on disk.

Member Function Documentation

void UnifiedAutomation.UaBase.TraceFileListener.Close ( )
inline

Closes the listener.

Implements UnifiedAutomation.UaBase.ITraceListener.

void UnifiedAutomation.UaBase.TraceFileListener.Dispose ( )
inline

Frees any unmanaged resources.

void UnifiedAutomation.UaBase.TraceFileListener.Open ( )
inline

Opens the listener for writing.

Implements UnifiedAutomation.UaBase.ITraceListener.

void UnifiedAutomation.UaBase.TraceFileListener.Output ( TraceEntry  entry)
inline

Writes a trace entry to the listener.

Parameters
entryThe entry to write to the trace log.

Implements UnifiedAutomation.UaBase.ITraceListener.

Property Documentation

bool UnifiedAutomation.UaBase.TraceFileListener.FastTrace
getset

Whether the entries should be written to disk immediately.

true if new log entries are flushed immediately; otherwise, false.

string UnifiedAutomation.UaBase.TraceFileListener.LogFilePath
getset

The path to the log file.

The log file path.

uint UnifiedAutomation.UaBase.TraceFileListener.MaxEntriesPerLog
getset

The maximum number of entries in the trace file

The max entries per log.

byte UnifiedAutomation.UaBase.TraceFileListener.MaxLogFileBackups
getset

The maximum number of backup files to keep.

The max log file backups.


The documentation for this class was generated from the following file: