|
|
Log
|
[ToolboxBitmapAttribute(typeof(LogFile))] public class LogFile : Component, ISupportLifecycle, IDisposable, ISupportInitialize, IProvideStatus, IPersistSettings
The LogFile type exposes the following members.
| Name | Description | |
|---|---|---|
| LogFile | Initializes a new instance of the LogFile class. | |
| LogFile(IContainer) | Initializes a new instance of the LogFile class. |
| Name | Description | |
|---|---|---|
| CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component) | |
| Container | Gets the IContainer that contains the Component. (Inherited from Component) | |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) | |
| Enabled | Gets or sets a boolean value that indicates whether the LogFile object is currently enabled. | |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) | |
| FileFullOperation | Gets or sets the type of operation to be performed when the LogFile is full. | |
| FileName | Gets or sets the name of the LogFile, including the file extension. | |
| FileSize | Gets or sets the size of the LogFile in MB. | |
| FlushTimerInterval | Gets or sets the number of seconds of inactivity before the LogFile automatically flushes the file stream. | |
| IsDisposed | Gets a flag that indicates whether the object has been disposed. | |
| IsOpen | Gets a boolean value that indicates whether the LogFile is open. | |
| LogFilesDuration | Gets or sets the time duration, in hours, to save the LogFile . | |
| Name | Gets the unique identifier of the LogFile object. | |
| PersistSettings | Gets or sets a boolean value that indicates whether the settings of LogFile object are to be saved to the config file. | |
| SettingsCategory | Gets or sets the category under which the settings of LogFile object are to be saved to the config file if the PersistSettings property is set to true. | |
| Site | Gets or sets the ISite of the Component. (Inherited from Component) | |
| Status | Gets the descriptive status of the LogFile object. | |
| TextEncoding | Gets or sets the Encoding to be used to encode the messages being logged. |
| Name | Description | |
|---|---|---|
| BeginInit | Performs necessary operations before the LogFile object properties are initialized. | |
| Close | Closes the LogFile if it is open. | |
| Close(Boolean) | Closes the LogFile if it is open. | |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) | |
| Dispose | Releases all resources used by the Component. (Inherited from Component) | |
| Dispose(Boolean) |
Releases the unmanaged resources used by the LogFile object and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean)) | |
| EndInit | Performs necessary operations after the LogFile object properties are initialized. | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component) | |
| Flush | Forces queued log entries to be written to the LogFile. | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) | |
| GetService | Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| Initialize | Initializes the LogFile object. | |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) | |
| LoadSettings | Loads saved settings for the LogFile object from the config file if the PersistSettings property is set to true. | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) | |
| OnFileFull | Raises the FileFull event. | |
| OnLogException | Raises the LogException event. | |
| Open | Opens the LogFile for use if it is closed. | |
| ReadLines | Reads text from the LogFile and returns a list of lines created by separating the text by the "newline" characters if and where present. | |
| ReadText | Reads and returns the text from the LogFile. | |
| SaveSettings | Saves settings for the LogFile object to the config file if the PersistSettings property is set to true. | |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) | |
| Write | Queues the text for writing to the LogFile. | |
| WriteLine | Queues the text for writing to the LogFile. | |
| WriteTimestampedLine | Queues the text for writing to the log file. |
| Name | Description | |
|---|---|---|
| Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component) | |
| FileFull | Occurs when the LogFile is full. | |
| LogException | Occurs when an Exception is encountered while writing entries to the LogFile. |
| Name | Description | |
|---|---|---|
| DefaultFileFullOperation | Specifies the default value for the FileFullOperation property. | |
| DefaultFileName | Specifies the default value for the FileName property. | |
| DefaultFileSize | Specifies the default value for the FileSize property. | |
| DefaultFlushTimerInterval | Specifies the default value for the FlushTimerInterval property. | |
| DefaultLogFilesDuration | Specifies the default value for the LogFilesDuration property. | |
| DefaultPersistSettings | Specifies the default value for the PersistSettings property. | |
| DefaultSettingsCategory | Specifies the default value for the SettingsCategory property. | |
| MaxFileSize | Specifies the maximum size for a LogFile. | |
| MinFileSize | Specifies the minimum size for a LogFile. |
| Name | Description | |
|---|---|---|
| GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) | |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
using System; using GSF.IO; class Program { static void Main(string[] args) { LogFile log = new LogFile(); log.Initialize(); // Initialize the log file. log.Open(); // Open the log file. log.WriteTimestampedLine("Test entry"); // Write message to the log file. log.Flush(); // Flush message to the log file. log.Close(); // Close the log file. Console.ReadLine(); } }