Declaration Syntax| C# | Visual Basic | Visual C++ |
public class FileLoggerConfiguration
Public Class FileLoggerConfiguration
public ref class FileLoggerConfiguration
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | FileLoggerConfiguration()()() |
Provides configuration options for logging messages and exceptions to a file.
For further information on the configuration options see the Caplin document
"StreamLink Configuration XML Reference".
|
| Equals(Object) | (Inherited from Object.) |
 | Finalize()()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode()()() | Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetType()()() | Gets the Type of the current instance. (Inherited from Object.) |
 | LogFileName |
Gets or sets the name of the log file.
|
| LogFileNameSuffix |
Gets or sets the suffix that StreamLink appends to a log file name when the file is renamed.
|
| MaxLogFileSize |
Gets or sets the maximum size that the log file can reach
before it is closed and renamed and a new file is opened.
|
| MemberwiseClone()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString()()() | (Inherited from Object.) |
RemarksThe file logger logs all log messages and exceptions generated by the StreamLink library to a file on disc. If you need to report a fault in StreamLink to Caplin Support, you may be asked to send this log file with the fault report.
The file logger is disabled by default. To enable it, insert a <FileLoggerConfiguration> tag in the RttpConfiguration section of the StreamLink configuration file.
For example:
<RttpConfiguration>
<FileLoggerConfiguration>
<LogFileName>
C:\sl4net.log
</LogFileName>
</FileLoggerConfiguration>
...
</RttpConfiguration>
The default name of the log file is sl4net. When the file size reaches 5,000,000 bytes, StreamLink closes the file, renames it to sl4net.old (replacing any existing sl4net.old file), and opens a new sl4net file.
You can change the file name, the suffix of the renamed file (default .old), and the maximum file size, by defining additional configuration tags inside the <FileLoggerConfiguration> tag. For more information on how to do this see the StreamLink Configuration XML Reference.
Inheritance Hierarchy| Object | |
 | FileLoggerConfiguration |