Mercurial > repos > IBBoard.WarFoundry.GUI.GTK
changeset 16:eafbe69303ec
* Remove Log4Net documentation from project (~1.3MB of XML documentation with lots of lines)
no-open-ticket
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Sun, 05 Jul 2009 09:52:19 +0000 |
| parents | 85db2c9a1546 |
| children | 7653fab9d70e |
| files | IBBoard.WarFoundry.GUI.GTK.csproj libs/log4net.xml |
| diffstat | 2 files changed, 0 insertions(+), 27659 deletions(-) [+] |
line wrap: on
line diff
--- a/IBBoard.WarFoundry.GUI.GTK.csproj Sat Jun 27 20:13:21 2009 +0000 +++ b/IBBoard.WarFoundry.GUI.GTK.csproj Sun Jul 05 09:52:19 2009 +0000 @@ -56,7 +56,6 @@ <ItemGroup> <Content Include="App.png" /> <Content Include="libs\log4net.dll" /> - <Content Include="libs\log4net.xml" /> </ItemGroup> <ItemGroup> <None Include="COPYING.GPL">
--- a/libs/log4net.xml Sat Jun 27 20:13:21 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,27658 +0,0 @@ -<?xml version="1.0"?> -<doc> - <assembly> - <name>log4net</name> - </assembly> - <members> - <member name="T:log4net.Appender.AdoNetAppender"> - <summary> - Appender that logs to a database. - </summary> - <remarks> - <para> - <see cref="T:log4net.Appender.AdoNetAppender"/> appends logging events to a table within a - database. The appender can be configured to specify the connection - string by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionString"/> property. - The connection type (provider) can be specified by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> - property. For more information on database connection strings for - your specific database see <a href="http://www.connectionstrings.com/">http://www.connectionstrings.com/</a>. - </para> - <para> - Records are written into the database either using a prepared - statement or a stored procedure. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property - is set to <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify a prepared statement - or to <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify a stored - procedure. - </para> - <para> - The prepared statement text or the name of the stored procedure - must be set in the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property. - </para> - <para> - The prepared statement or stored procedure can take a number - of parameters. Parameters are added using the <see cref="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)"/> - method. This adds a single <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> to the - ordered list of parameters. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> - type may be subclassed if required to provide database specific - functionality. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> specifies - the parameter name, database type, size, and how the value should - be generated using a <see cref="T:log4net.Layout.ILayout"/>. - </para> - </remarks> - <example> - An example of a SQL Server table that could be logged to: - <code lang="SQL"> - CREATE TABLE [dbo].[Log] ( - [ID] [int] IDENTITY (1, 1) NOT NULL , - [Date] [datetime] NOT NULL , - [Thread] [varchar] (255) NOT NULL , - [Level] [varchar] (20) NOT NULL , - [Logger] [varchar] (255) NOT NULL , - [Message] [varchar] (4000) NOT NULL - ) ON [PRIMARY] - </code> - </example> - <example> - An example configuration to log to the above table: - <code lang="XML" escaped="true"> - <appender name="AdoNetAppender_SqlServer" type="log4net.Appender.AdoNetAppender"> - <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/> - <connectionString value="data source=SQLSVR;initial catalog=test_log4net;integrated security=false;persist security info=True;User ID=sa;Password=sa"/> - <commandText value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message]) VALUES (@log_date, @thread, @log_level, @logger, @message)"/> - <parameter> - <parameterName value="@log_date"/> - <dbType value="DateTime"/> - <layout type="log4net.Layout.PatternLayout" value="%date{yyyy'-'MM'-'dd HH':'mm':'ss'.'fff}"/> - </parameter> - <parameter> - <parameterName value="@thread"/> - <dbType value="String"/> - <size value="255"/> - <layout type="log4net.Layout.PatternLayout" value="%thread"/> - </parameter> - <parameter> - <parameterName value="@log_level"/> - <dbType value="String"/> - <size value="50"/> - <layout type="log4net.Layout.PatternLayout" value="%level"/> - </parameter> - <parameter> - <parameterName value="@logger"/> - <dbType value="String"/> - <size value="255"/> - <layout type="log4net.Layout.PatternLayout" value="%logger"/> - </parameter> - <parameter> - <parameterName value="@message"/> - <dbType value="String"/> - <size value="4000"/> - <layout type="log4net.Layout.PatternLayout" value="%message"/> - </parameter> - </appender> - </code> - </example> - <author>Julian Biddle</author> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - <author>Lance Nehring</author> - </member> - <member name="T:log4net.Appender.BufferingAppenderSkeleton"> - <summary> - Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that - buffers events in a fixed size buffer. - </summary> - <remarks> - <para> - This base class should be used by appenders that need to buffer a - number of events before logging them. For example the <see cref="T:log4net.Appender.AdoNetAppender"/> - buffers events and then submits the entire contents of the buffer to - the underlying database in one go. - </para> - <para> - Subclasses should override the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/> - method to deliver the buffered events. - </para> - <para>The BufferingAppenderSkeleton maintains a fixed size cyclic - buffer of events. The size of the buffer is set using - the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property. - </para> - <para>A <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> is used to inspect - each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> - triggers, then the current buffer is sent immediately - (see <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>). Otherwise the event - is stored in the buffer. For example, an evaluator can be used to - deliver the events immediately when an ERROR event arrives. - </para> - <para> - The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode. - By default the appender is NOT lossy. When the buffer is full all - the buffered events are sent with <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>. - If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the - buffer will not be sent when it is full, and new events arriving - in the appender will overwrite the oldest event in the buffer. - In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> - triggers. This can be useful behavior when you need to know about - ERROR events but not about events with a lower level, configure an - evaluator that will trigger when an ERROR event arrives, the whole - buffer will be sent which gives a history of events leading up to - the ERROR event. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="T:log4net.Appender.AppenderSkeleton"> - <summary> - Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>. - </summary> - <remarks> - <para> - This class provides the code for common functionality, such - as support for threshold filtering and support for general filters. - </para> - <para> - Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore - they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method - be called after the appenders properties have been configured. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="T:log4net.Appender.IAppender"> - <summary> - Implement this interface for your own strategies for printing log statements. - </summary> - <remarks> - <para> - Implementors should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/> - class which provides a default implementation of this interface. - </para> - <para> - Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore - they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method - be called after the appenders properties have been configured. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Appender.IAppender.Close"> - <summary> - Closes the appender and releases resources. - </summary> - <remarks> - <para> - Releases any resources allocated within the appender such as file handles, - network connections, etc. - </para> - <para> - It is a programming error to append to a closed appender. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"> - <summary> - Log the logging event in Appender specific way. - </summary> - <param name="loggingEvent">The event to log</param> - <remarks> - <para> - This method is called to log a message into this appender. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.IAppender.Name"> - <summary> - Gets or sets the name of this appender. - </summary> - <value>The name of the appender.</value> - <remarks> - <para>The name uniquely identifies the appender.</para> - </remarks> - </member> - <member name="T:log4net.Appender.IBulkAppender"> - <summary> - Interface for appenders that support bulk logging. - </summary> - <remarks> - <para> - This interface extends the <see cref="T:log4net.Appender.IAppender"/> interface to - support bulk logging of <see cref="T:log4net.Core.LoggingEvent"/> objects. Appenders - should only implement this interface if they can bulk log efficiently. - </para> - </remarks> - <author>Nicko Cadell</author> - </member> - <member name="M:log4net.Appender.IBulkAppender.DoAppend(log4net.Core.LoggingEvent[])"> - <summary> - Log the array of logging events in Appender specific way. - </summary> - <param name="loggingEvents">The events to log</param> - <remarks> - <para> - This method is called to log an array of events into this appender. - </para> - </remarks> - </member> - <member name="T:log4net.Core.IOptionHandler"> - <summary> - Interface used to delay activate a configured object. - </summary> - <remarks> - <para> - This allows an object to defer activation of its options until all - options have been set. This is required for components which have - related options that remain ambiguous until all are set. - </para> - <para> - If a component implements this interface then the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method - must be called by the container after its all the configured properties have been set - and before the component can be used. - </para> - </remarks> - <author>Nicko Cadell</author> - </member> - <member name="M:log4net.Core.IOptionHandler.ActivateOptions"> - <summary> - Activate the options that were previously set with calls to properties. - </summary> - <remarks> - <para> - This allows an object to defer activation of its options until all - options have been set. This is required for components which have - related options that remain ambiguous until all are set. - </para> - <para> - If a component implements this interface then this method must be called - after its properties have been set before the component can be used. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize"> - <summary> - Initial buffer size - </summary> - </member> - <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity"> - <summary> - Maximum buffer size before it is recycled - </summary> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.#ctor"> - <summary> - Default constructor - </summary> - <remarks> - <para>Empty default constructor</para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.Finalize"> - <summary> - Finalizes this appender by calling the implementation's - <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method. - </summary> - <remarks> - <para> - If this appender has not been closed then the <c>Finalize</c> method - will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions"> - <summary> - Initialize the appender based on the options set - </summary> - <remarks> - <para> - This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object - activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must - be called on this object after the configuration properties have - been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this - object is in an undefined state and must not be used. - </para> - <para> - If any of the configuration properties are modified then - <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.Close"> - <summary> - Closes the appender and release resources. - </summary> - <remarks> - <para> - Release any resources allocated within the appender such as file handles, - network connections, etc. - </para> - <para> - It is a programming error to append to a closed appender. - </para> - <para> - This method cannot be overridden by subclasses. This method - delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/> - method which must be overridden in the subclass. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"> - <summary> - Performs threshold checks and invokes filters before - delegating actual logging to the subclasses specific - <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> method. - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - This method cannot be overridden by derived classes. A - derived class should override the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> method - which is called by this method. - </para> - <para> - The implementation of this method is as follows: - </para> - <para> - <list type="bullet"> - <item> - <description> - Checks that the severity of the <paramref name="loggingEvent"/> - is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this - appender.</description> - </item> - <item> - <description> - Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the - <paramref name="loggingEvent"/>. - </description> - </item> - <item> - <description> - Calls <see cref="M:log4net.Appender.AppenderSkeleton.PreAppendCheck"/> and checks that - it returns <c>true</c>.</description> - </item> - </list> - </para> - <para> - If all of the above steps succeed then the <paramref name="loggingEvent"/> - will be passed to the abstract <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> method. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])"> - <summary> - Performs threshold checks and invokes filters before - delegating actual logging to the subclasses specific - <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])"/> method. - </summary> - <param name="loggingEvents">The array of events to log.</param> - <remarks> - <para> - This method cannot be overridden by derived classes. A - derived class should override the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])"/> method - which is called by this method. - </para> - <para> - The implementation of this method is as follows: - </para> - <para> - <list type="bullet"> - <item> - <description> - Checks that the severity of the <paramref name="loggingEvent"/> - is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this - appender.</description> - </item> - <item> - <description> - Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the - <paramref name="loggingEvent"/>. - </description> - </item> - <item> - <description> - Calls <see cref="M:log4net.Appender.AppenderSkeleton.PreAppendCheck"/> and checks that - it returns <c>true</c>.</description> - </item> - </list> - </para> - <para> - If all of the above steps succeed then the <paramref name="loggingEvents"/> - will be passed to the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])"/> method. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)"> - <summary> - Test if the logging event should we output by this appender - </summary> - <param name="loggingEvent">the event to test</param> - <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns> - <remarks> - <para> - This method checks the logging event against the threshold level set - on this appender and also against the filters specified on this - appender. - </para> - <para> - The implementation of this method is as follows: - </para> - <para> - <list type="bullet"> - <item> - <description> - Checks that the severity of the <paramref name="loggingEvent"/> - is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this - appender.</description> - </item> - <item> - <description> - Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the - <paramref name="loggingEvent"/>. - </description> - </item> - </list> - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)"> - <summary> - Adds a filter to the end of the filter chain. - </summary> - <param name="filter">the filter to add to this appender</param> - <remarks> - <para> - The Filters are organized in a linked list. - </para> - <para> - Setting this property causes the new filter to be pushed onto the - back of the filter chain. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.ClearFilters"> - <summary> - Clears the filter list for this appender. - </summary> - <remarks> - <para> - Clears the filter list for this appender. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)"> - <summary> - Checks if the message level is below this appender's threshold. - </summary> - <param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param> - <remarks> - <para> - If there is no threshold set, then the return value is always <c>true</c>. - </para> - </remarks> - <returns> - <c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> - requirements of this appender. - </returns> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.OnClose"> - <summary> - Is called when the appender is closed. Derived classes should override - this method if resources need to be released. - </summary> - <remarks> - <para> - Releases any resources allocated within the appender such as file handles, - network connections, etc. - </para> - <para> - It is a programming error to append to a closed appender. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"> - <summary> - Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method - to perform actual logging. - </summary> - <param name="loggingEvent">The event to append.</param> - <remarks> - <para> - A subclass must implement this method to perform - logging of the <paramref name="loggingEvent"/>. - </para> - <para>This method will be called by <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> - if all the conditions listed for that method are met. - </para> - <para> - To restrict the logging of events in the appender - override the <see cref="M:log4net.Appender.AppenderSkeleton.PreAppendCheck"/> method. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])"> - <summary> - Append a bulk array of logging events. - </summary> - <param name="loggingEvents">the array of logging events</param> - <remarks> - <para> - This base class implementation calls the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> - method for each element in the bulk array. - </para> - <para> - A sub class that can better process a bulk array of events should - override this method in addition to <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck"> - <summary> - Called before <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> as a precondition. - </summary> - <remarks> - <para> - This method is called by <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> - before the call to the abstract <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> method. - </para> - <para> - This method can be overridden in a subclass to extend the checks - made before the event is passed to the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> method. - </para> - <para> - A subclass should ensure that they delegate this call to - this base class if it is overridden. - </para> - </remarks> - <returns><c>true</c> if the call to <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> should proceed.</returns> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)"> - <summary> - Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string. - </summary> - <param name="loggingEvent">The event to render.</param> - <returns>The event rendered as a string.</returns> - <remarks> - <para> - Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to - a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> - set to render the <paramref name="loggingEvent"/> to - a string. - </para> - <para>If there is exception data in the logging event and - the layout does not process the exception, this method - will append the exception text to the rendered string. - </para> - <para> - Where possible use the alternative version of this method - <see cref="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)"/>. - That method streams the rendering onto an existing Writer - which can give better performance if the caller already has - a <see cref="T:System.IO.TextWriter"/> open and ready for writing. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)"> - <summary> - Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string. - </summary> - <param name="loggingEvent">The event to render.</param> - <param name="writer">The TextWriter to write the formatted event to</param> - <remarks> - <para> - Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to - a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> - set to render the <paramref name="loggingEvent"/> to - a string. - </para> - <para>If there is exception data in the logging event and - the layout does not process the exception, this method - will append the exception text to the rendered string. - </para> - <para> - Use this method in preference to <see cref="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)"/> - where possible. If, however, the caller needs to render the event - to a string then <see cref="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)"/> does - provide an efficient mechanism for doing so. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.AppenderSkeleton.m_layout"> - <summary> - The layout of this appender. - </summary> - <remarks> - See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information. - </remarks> - </member> - <member name="F:log4net.Appender.AppenderSkeleton.m_name"> - <summary> - The name of this appender. - </summary> - <remarks> - See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information. - </remarks> - </member> - <member name="F:log4net.Appender.AppenderSkeleton.m_threshold"> - <summary> - The level threshold of this appender. - </summary> - <remarks> - <para> - There is no level threshold filtering by default. - </para> - <para> - See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler"> - <summary> - It is assumed and enforced that errorHandler is never null. - </summary> - <remarks> - <para> - It is assumed and enforced that errorHandler is never null. - </para> - <para> - See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.AppenderSkeleton.m_headFilter"> - <summary> - The first filter in the filter chain. - </summary> - <remarks> - <para> - Set to <c>null</c> initially. - </para> - <para> - See <see cref="T:log4net.Filter.IFilter"/> for more information. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter"> - <summary> - The last filter in the filter chain. - </summary> - <remarks> - See <see cref="T:log4net.Filter.IFilter"/> for more information. - </remarks> - </member> - <member name="F:log4net.Appender.AppenderSkeleton.m_closed"> - <summary> - Flag indicating if this appender is closed. - </summary> - <remarks> - See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information. - </remarks> - </member> - <member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard"> - <summary> - The guard prevents an appender from repeatedly calling its own DoAppend method - </summary> - </member> - <member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter"> - <summary> - StringWriter used to render events - </summary> - </member> - <member name="P:log4net.Appender.AppenderSkeleton.Threshold"> - <summary> - Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender. - </summary> - <value> - The threshold <see cref="T:log4net.Core.Level"/> of the appender. - </value> - <remarks> - <para> - All log events with lower level than the threshold level are ignored - by the appender. - </para> - <para> - In configuration files this option is specified by setting the - value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level - string, such as "DEBUG", "INFO" and so on. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler"> - <summary> - Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender. - </summary> - <value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value> - <remarks> - <para> - The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default - implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AppenderSkeleton.FilterHead"> - <summary> - The filter chain. - </summary> - <value>The head of the filter chain filter chain.</value> - <remarks> - <para> - Returns the head Filter. The Filters are organized in a linked list - and so all Filters on this Appender are available through the result. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AppenderSkeleton.Layout"> - <summary> - Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender. - </summary> - <value>The layout of the appender.</value> - <remarks> - <para> - See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information. - </para> - </remarks> - <seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> - </member> - <member name="P:log4net.Appender.AppenderSkeleton.Name"> - <summary> - Gets or sets the name of this appender. - </summary> - <value>The name of the appender.</value> - <remarks> - <para> - The name uniquely identifies the appender. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout"> - <summary> - Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set. - </summary> - <remarks> - <para> - In the rather exceptional case, where the appender - implementation admits a layout but can also work without it, - then the appender should return <c>true</c>. - </para> - <para> - This default implementation always returns <c>true</c>. - </para> - </remarks> - <returns> - <c>true</c> if the appender requires a layout object, otherwise <c>false</c>. - </returns> - </member> - <member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"> - <summary> - The default buffer size. - </summary> - <remarks> - The default size of the cyclic buffer used to store events. - This is set to 512 by default. - </remarks> - </member> - <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class. - </summary> - <remarks> - <para> - Protected default constructor to allow subclassing. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class. - </summary> - <param name="eventMustBeFixed">the events passed through this appender must be - fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param> - <remarks> - <para> - Protected constructor to allow subclassing. - </para> - <para> - The <paramref name="eventMustBeFixed"/> should be set if the subclass - expects the events delivered to be fixed even if the - <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush"> - <summary> - Flush the currently buffered events - </summary> - <remarks> - <para> - Flushes any events that have been buffered. - </para> - <para> - If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents - of the buffer will NOT be flushed to the appender. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)"> - <summary> - Flush the currently buffered events - </summary> - <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param> - <remarks> - <para> - Flushes events that have been buffered. If <paramref name="flushLossyBuffer"/> is - <c>false</c> then events will only be flushed if this buffer is non-lossy mode. - </para> - <para> - If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents - of the buffer will only be flushed if <paramref name="flushLossyBuffer"/> is <c>true</c>. - In this case the contents of the buffer will be tested against the - <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered - events will be discarded. - </para> - <para> - If <paramref name="flushLossyBuffer"/> is <c>true</c> then the buffer will always - be emptied by calling this method. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"> - <summary> - Initialize the appender based on the options set - </summary> - <remarks> - <para> - This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object - activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must - be called on this object after the configuration properties have - been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this - object is in an undefined state and must not be used. - </para> - <para> - If any of the configuration properties are modified then - <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose"> - <summary> - Close this appender instance. - </summary> - <remarks> - <para> - Close this appender instance. If this appender is marked - as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in - the buffer must be sent when the appender is closed. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method. - </summary> - <param name="loggingEvent">the event to log</param> - <remarks> - <para> - Stores the <paramref name="loggingEvent"/> in the cyclic buffer. - </para> - <para> - The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/> - method) if one of the following conditions is met: - </para> - <list type="bullet"> - <item> - <description>The cyclic buffer is full and this appender is - marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description> - </item> - <item> - <description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and - it is triggered for the <paramref name="loggingEvent"/> - specified.</description> - </item> - </list> - <para> - Before the event is stored in the buffer it is fixed - (see <see cref="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)"/>) to ensure that - any data referenced by the event will be valid when the buffer - is processed. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)"> - <summary> - Sends the contents of the buffer. - </summary> - <param name="firstLoggingEvent">The first logging event.</param> - <param name="buffer">The buffer containing the events that need to be send.</param> - <remarks> - <para> - The subclass must override <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"> - <summary> - Sends the events. - </summary> - <param name="events">The events that need to be send.</param> - <remarks> - <para> - The subclass must override this method to process the buffered events. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize"> - <summary> - The size of the cyclic buffer used to hold the logging events. - </summary> - <remarks> - Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default. - </remarks> - </member> - <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb"> - <summary> - The cyclic buffer used to store the logging events. - </summary> - </member> - <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator"> - <summary> - The triggering event evaluator that causes the buffer to be sent immediately. - </summary> - <remarks> - The object that is used to determine if an event causes the entire - buffer to be sent immediately. This field can be <c>null</c>, which - indicates that event triggering is not to be done. The evaluator - can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender - has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to - <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set. - </remarks> - </member> - <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"> - <summary> - Indicates if the appender should overwrite events in the cyclic buffer - when it becomes full, or if the buffer should be flushed when the - buffer is full. - </summary> - <remarks> - If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must - be set. - </remarks> - </member> - <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator"> - <summary> - The triggering event evaluator filters discarded events. - </summary> - <remarks> - The object that is used to determine if an event that is discarded should - really be discarded or if it should be sent to the appenders. - This field can be <c>null</c>, which indicates that all discarded events will - be discarded. - </remarks> - </member> - <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags"> - <summary> - Value indicating which fields in the event should be fixed - </summary> - <remarks> - By default all fields are fixed - </remarks> - </member> - <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed"> - <summary> - The events delivered to the subclass must be fixed. - </summary> - </member> - <member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"> - <summary> - Gets or sets a value that indicates whether the appender is lossy. - </summary> - <value> - <c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>. - </value> - <remarks> - <para> - This appender uses a buffer to store logging events before - delivering them. A triggering event causes the whole buffer - to be send to the remote sink. If the buffer overruns before - a triggering event then logging events could be lost. Set - <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events - from being lost. - </para> - <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an - <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para> - </remarks> - </member> - <member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"> - <summary> - Gets or sets the size of the cyclic buffer used to hold the - logging events. - </summary> - <value> - The size of the cyclic buffer used to hold the logging events. - </value> - <remarks> - <para> - The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer - representing the maximum number of logging events to collect in - a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached, - oldest events are deleted as new events are added to the - buffer. By default the size of the cyclic buffer is 512 events. - </para> - <para> - If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than - or equal to 1 then no buffering will occur. The logging event - will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> - and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will - be buffered. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"> - <summary> - Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the - buffer to be sent immediately. - </summary> - <value> - The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be - sent immediately. - </value> - <remarks> - <para> - The evaluator will be called for each event that is appended to this - appender. If the evaluator triggers then the current buffer will - immediately be sent (see <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>). - </para> - <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an - <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para> - </remarks> - </member> - <member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"> - <summary> - Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use. - </summary> - <value> - The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use. - </value> - <remarks> - <para> - The evaluator will be called for each event that is discarded from this - appender. If the evaluator triggers then the current buffer will immediately - be sent (see <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>). - </para> - </remarks> - </member> - <member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData"> - <summary> - Gets or sets a value indicating if only part of the logging event data - should be fixed. - </summary> - <value> - <c>true</c> if the appender should only fix part of the logging event - data, otherwise <c>false</c>. The default is <c>false</c>. - </value> - <remarks> - <para> - Setting this property to <c>true</c> will cause only part of the - event data to be fixed and serialized. This will improve performance. - </para> - <para> - See <see cref="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)"/> for more information. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix"> - <summary> - Gets or sets a the fields that will be fixed in the event - </summary> - <value> - The event fields that will be fixed before the event is buffered - </value> - <remarks> - <para> - The logging event needs to have certain thread specific values - captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/> - for details. - </para> - </remarks> - <seealso cref="P:log4net.Core.LoggingEvent.Fix"/> - </member> - <member name="M:log4net.Appender.AdoNetAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppender"/> class. - </summary> - <remarks> - Public default constructor to initialize a new instance of this class. - </remarks> - </member> - <member name="M:log4net.Appender.AdoNetAppender.ActivateOptions"> - <summary> - Initialize the appender based on the options set - </summary> - <remarks> - <para> - This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object - activation scheme. The <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> method must - be called on this object after the configuration properties have - been set. Until <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> is called this - object is in an undefined state and must not be used. - </para> - <para> - If any of the configuration properties are modified then - <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> must be called again. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AdoNetAppender.OnClose"> - <summary> - Override the parent method to close the database - </summary> - <remarks> - <para> - Closes the database command and database connection. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(log4net.Core.LoggingEvent[])"> - <summary> - Inserts the events into the database. - </summary> - <param name="events">The events to insert into the database.</param> - <remarks> - <para> - Insert all the events specified in the <paramref name="events"/> - array into the database. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)"> - <summary> - Adds a parameter to the command. - </summary> - <param name="parameter">The parameter to add to the command.</param> - <remarks> - <para> - Adds a parameter to the ordered list of command parameters. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(System.Data.IDbTransaction,log4net.Core.LoggingEvent[])"> - <summary> - Writes the events to the database using the transaction specified. - </summary> - <param name="dbTran">The transaction that the events will be executed under.</param> - <param name="events">The array of events to insert into the database.</param> - <remarks> - <para> - The transaction argument can be <c>null</c> if the appender has been - configured not to use transactions. See <see cref="P:log4net.Appender.AdoNetAppender.UseTransactions"/> - property for more information. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)"> - <summary> - Formats the log message into database statement text. - </summary> - <param name="logEvent">The event being logged.</param> - <remarks> - This method can be overridden by subclasses to provide - more control over the format of the database statement. - </remarks> - <returns> - Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>. - </returns> - </member> - <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection"> - <summary> - Connects to the database. - </summary> - </member> - <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType"> - <summary> - Retrieves the class type of the ADO.NET provider. - </summary> - <remarks> - <para> - Gets the Type of the ADO.NET provider to use to connect to the - database. This method resolves the type specified in the - <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property. - </para> - <para> - Subclasses can override this method to return a different type - if necessary. - </para> - </remarks> - <returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns> - </member> - <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseCommand"> - <summary> - Prepares the database command and initialize the parameters. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppender.m_usePreparedCommand"> - <summary> - Flag to indicate if we are using a command object - </summary> - <remarks> - <para> - Set to <c>true</c> when the appender is to use a prepared - statement or stored procedure to insert into the database. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.AdoNetAppender.m_parameters"> - <summary> - The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects. - </summary> - <remarks> - <para> - The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.AdoNetAppender.m_securityContext"> - <summary> - The security context to use for privileged calls - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppender.m_dbConnection"> - <summary> - The <see cref="T:System.Data.IDbConnection"/> that will be used - to insert logging events into a database. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppender.m_dbCommand"> - <summary> - The database command. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppender.m_connectionString"> - <summary> - Database connection string. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppender.m_connectionType"> - <summary> - String type name of the <see cref="T:System.Data.IDbConnection"/> type name. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppender.m_commandText"> - <summary> - The text of the command. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppender.m_commandType"> - <summary> - The command type. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppender.m_useTransactions"> - <summary> - Indicates whether to use transactions when writing to the database. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError"> - <summary> - Indicates whether to use transactions when writing to the database. - </summary> - </member> - <member name="P:log4net.Appender.AdoNetAppender.ConnectionString"> - <summary> - Gets or sets the database connection string that is used to connect to - the database. - </summary> - <value> - The database connection string used to connect to the database. - </value> - <remarks> - <para> - The connections string is specific to the connection type. - See <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> for more information. - </para> - </remarks> - <example>Connection string for MS Access via ODBC: - <code>"DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb"</code> - </example> - <example>Another connection string for MS Access via ODBC: - <code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"</code> - </example> - <example>Connection string for MS Access via OLE DB: - <code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"</code> - </example> - </member> - <member name="P:log4net.Appender.AdoNetAppender.ConnectionType"> - <summary> - Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection - that should be created. - </summary> - <value> - The type name of the <see cref="T:System.Data.IDbConnection"/> connection. - </value> - <remarks> - <para> - The type name of the ADO.NET provider to use. - </para> - <para> - The default is to use the OLE DB provider. - </para> - </remarks> - <example>Use the OLE DB Provider. This is the default value. - <code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code> - </example> - <example>Use the MS SQL Server Provider. - <code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code> - </example> - <example>Use the ODBC Provider. - <code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code> - This is an optional package that you can download from - <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a> - search for <b>ODBC .NET Data Provider</b>. - </example> - <example>Use the Oracle Provider. - <code>System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code> - This is an optional package that you can download from - <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a> - search for <b>.NET Managed Provider for Oracle</b>. - </example> - </member> - <member name="P:log4net.Appender.AdoNetAppender.CommandText"> - <summary> - Gets or sets the command text that is used to insert logging events - into the database. - </summary> - <value> - The command text used to insert logging events into the database. - </value> - <remarks> - <para> - Either the text of the prepared statement or the - name of the stored procedure to execute to write into - the database. - </para> - <para> - The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property determines if - this text is a prepared statement or a stored procedure. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AdoNetAppender.CommandType"> - <summary> - Gets or sets the command type to execute. - </summary> - <value> - The command type to execute. - </value> - <remarks> - <para> - This value may be either <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify - that the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> is a prepared statement to execute, - or <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify that the - <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property is the name of a stored procedure - to execute. - </para> - <para> - The default value is <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>). - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AdoNetAppender.UseTransactions"> - <summary> - Should transactions be used to insert logging events in the database. - </summary> - <value> - <c>true</c> if transactions should be used to insert logging events in - the database, otherwise <c>false</c>. The default value is <c>true</c>. - </value> - <remarks> - <para> - Gets or sets a value that indicates whether transactions should be used - to insert logging events in the database. - </para> - <para> - When set a single transaction will be used to insert the buffered events - into the database. Otherwise each event will be inserted without using - an explicit transaction. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AdoNetAppender.SecurityContext"> - <summary> - Gets or sets the <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method. - </summary> - <value> - The <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method. - </value> - <remarks> - <para> - Unless a <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> specified here for this appender - the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the - security context to use. The default behavior is to use the security context - of the current thread. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AdoNetAppender.ReconnectOnError"> - <summary> - Should this appender try to reconnect to the database on error. - </summary> - <value> - <c>true</c> if the appender should try to reconnect to the database after an - error has occurred, otherwise <c>false</c>. The default value is <c>false</c>, - i.e. not to try to reconnect. - </value> - <remarks> - <para> - The default behaviour is for the appender not to try to reconnect to the - database if an error occurs. Subsequent logging events are discarded. - </para> - <para> - To force the appender to attempt to reconnect to the database set this - property to <c>true</c>. - </para> - <note> - When the appender attempts to connect to the database there may be a - delay of up to the connection timeout specified in the connection string. - This delay will block the calling application's thread. - Until the connection can be reestablished this potential delay may occur multiple times. - </note> - </remarks> - </member> - <member name="P:log4net.Appender.AdoNetAppender.Connection"> - <summary> - Gets or sets the underlying <see cref="T:System.Data.IDbConnection"/>. - </summary> - <value> - The underlying <see cref="T:System.Data.IDbConnection"/>. - </value> - <remarks> - <see cref="T:log4net.Appender.AdoNetAppender"/> creates a <see cref="T:System.Data.IDbConnection"/> to insert - logging events into a database. Classes deriving from <see cref="T:log4net.Appender.AdoNetAppender"/> - can use this property to get or set this <see cref="T:System.Data.IDbConnection"/>. Use the - underlying <see cref="T:System.Data.IDbConnection"/> returned from <see cref="P:log4net.Appender.AdoNetAppender.Connection"/> if - you require access beyond that which <see cref="T:log4net.Appender.AdoNetAppender"/> provides. - </remarks> - </member> - <member name="T:log4net.Appender.AdoNetAppenderParameter"> - <summary> - Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>. - </summary> - <remarks> - <para> - This class provides the basic database parameter properties - as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface. - </para> - <para>This type can be subclassed to provide database specific - functionality. The two methods that are called externally are - <see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> class. - </summary> - <remarks> - Default constructor for the AdoNetAppenderParameter class. - </remarks> - </member> - <member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"> - <summary> - Prepare the specified database command object. - </summary> - <param name="command">The command to prepare.</param> - <remarks> - <para> - Prepares the database command object by adding - this parameter to its collection of parameters. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"> - <summary> - Renders the logging event and set the parameter value in the command. - </summary> - <param name="command">The command containing the parameter.</param> - <param name="loggingEvent">The event to be rendered.</param> - <remarks> - <para> - Renders the logging event using this parameters layout - object. Sets the value of the parameter on the command object. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName"> - <summary> - The name of this parameter. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType"> - <summary> - The database type for this parameter. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType"> - <summary> - Flag to infer type rather than use the DbType - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision"> - <summary> - The precision for this parameter. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale"> - <summary> - The scale for this parameter. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppenderParameter.m_size"> - <summary> - The size for this parameter. - </summary> - </member> - <member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout"> - <summary> - The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the - logging event into an object for this parameter. - </summary> - </member> - <member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName"> - <summary> - Gets or sets the name of this parameter. - </summary> - <value> - The name of this parameter. - </value> - <remarks> - <para> - The name of this parameter. The parameter name - must match up to a named parameter to the SQL stored procedure - or prepared statement. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AdoNetAppenderParameter.DbType"> - <summary> - Gets or sets the database type for this parameter. - </summary> - <value> - The database type for this parameter. - </value> - <remarks> - <para> - The database type for this parameter. This property should - be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/> - enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>. - </para> - <para> - This property is optional. If not specified the ADO.NET provider - will attempt to infer the type from the value. - </para> - </remarks> - <seealso cref="P:System.Data.IDataParameter.DbType"/> - </member> - <member name="P:log4net.Appender.AdoNetAppenderParameter.Precision"> - <summary> - Gets or sets the precision for this parameter. - </summary> - <value> - The precision for this parameter. - </value> - <remarks> - <para> - The maximum number of digits used to represent the Value. - </para> - <para> - This property is optional. If not specified the ADO.NET provider - will attempt to infer the precision from the value. - </para> - </remarks> - <seealso cref="P:System.Data.IDbDataParameter.Precision"/> - </member> - <member name="P:log4net.Appender.AdoNetAppenderParameter.Scale"> - <summary> - Gets or sets the scale for this parameter. - </summary> - <value> - The scale for this parameter. - </value> - <remarks> - <para> - The number of decimal places to which Value is resolved. - </para> - <para> - This property is optional. If not specified the ADO.NET provider - will attempt to infer the scale from the value. - </para> - </remarks> - <seealso cref="P:System.Data.IDbDataParameter.Scale"/> - </member> - <member name="P:log4net.Appender.AdoNetAppenderParameter.Size"> - <summary> - Gets or sets the size for this parameter. - </summary> - <value> - The size for this parameter. - </value> - <remarks> - <para> - The maximum size, in bytes, of the data within the column. - </para> - <para> - This property is optional. If not specified the ADO.NET provider - will attempt to infer the size from the value. - </para> - </remarks> - <seealso cref="P:System.Data.IDbDataParameter.Size"/> - </member> - <member name="P:log4net.Appender.AdoNetAppenderParameter.Layout"> - <summary> - Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to - render the logging event into an object for this - parameter. - </summary> - <value> - The <see cref="T:log4net.Layout.IRawLayout"/> used to render the - logging event into an object for this parameter. - </value> - <remarks> - <para> - The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this - parameter. - </para> - <para> - The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt - any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/> - for use in the property. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.AnsiColorTerminalAppender"> - <summary> - Appends logging events to the terminal using ANSI color escape sequences. - </summary> - <remarks> - <para> - AnsiColorTerminalAppender appends log events to the standard output stream - or the error output stream using a layout specified by the - user. It also allows the color of a specific level of message to be set. - </para> - <note> - This appender expects the terminal to understand the VT100 control set - in order to interpret the color codes. If the terminal or console does not - understand the control codes the behavior is not defined. - </note> - <para> - By default, all output is written to the console's standard output stream. - The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the - error stream. - </para> - <para> - NOTE: This appender writes each message to the <c>System.Console.Out</c> or - <c>System.Console.Error</c> that is set at the time the event is appended. - Therefore it is possible to programmatically redirect the output of this appender - (for example NUnit does this to capture program output). While this is the desired - behavior of this appender it may have security implications in your application. - </para> - <para> - When configuring the ANSI colored terminal appender, a mapping should be - specified to map a logging level to a color. For example: - </para> - <code lang="XML" escaped="true"> - <mapping> - <level value="ERROR"/> - <foreColor value="White"/> - <backColor value="Red"/> - <attributes value="Bright,Underscore"/> - </mapping> - <mapping> - <level value="DEBUG"/> - <backColor value="Green"/> - </mapping> - </code> - <para> - The Level is the standard log4net logging level and ForeColor and BackColor can be any - of the following values: - <list type="bullet"> - <item><term>Blue</term><description></description></item> - <item><term>Green</term><description></description></item> - <item><term>Red</term><description></description></item> - <item><term>White</term><description></description></item> - <item><term>Yellow</term><description></description></item> - <item><term>Purple</term><description></description></item> - <item><term>Cyan</term><description></description></item> - </list> - These color values cannot be combined together to make new colors. - </para> - <para> - The attributes can be any combination of the following: - <list type="bullet"> - <item><term>Bright</term><description>foreground is brighter</description></item> - <item><term>Dim</term><description>foreground is dimmer</description></item> - <item><term>Underscore</term><description>message is underlined</description></item> - <item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item> - <item><term>Reverse</term><description>foreground and background are reversed</description></item> - <item><term>Hidden</term><description>output is hidden</description></item> - <item><term>Strikethrough</term><description>message has a line through it</description></item> - </list> - While any of these attributes may be combined together not all combinations - work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes - no sense. - </para> - </remarks> - <author>Patrick Wagstrom</author> - <author>Nicko Cadell</author> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut"> - <summary> - The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console - standard output stream. - </summary> - <remarks> - <para> - The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console - standard output stream. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError"> - <summary> - The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console - standard error output stream. - </summary> - <remarks> - <para> - The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console - standard error output stream. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes"> - <summary> - Ansi code to reset terminal - </summary> - </member> - <member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class. - </summary> - <remarks> - The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class is set up to write - to the standard output stream. - </remarks> - </member> - <member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)"> - <summary> - Add a mapping of level to color - </summary> - <param name="mapping">The mapping to add</param> - <remarks> - <para> - Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender. - Each mapping defines the foreground and background colours - for a level. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method. - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - Writes the event to the console. - </para> - <para> - The format of the output will depend on the appender's layout. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions"> - <summary> - Initialize the options for this appender - </summary> - <remarks> - <para> - Initialize the level to color mappings set on this appender. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream"> - <summary> - Flag to write output to the error stream rather than the standard output stream - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping"> - <summary> - Mapping from level object to color value - </summary> - </member> - <member name="P:log4net.Appender.AnsiColorTerminalAppender.Target"> - <summary> - Target is the value of the console output stream. - </summary> - <value> - Target is the value of the console output stream. - This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. - </value> - <remarks> - <para> - Target is the value of the console output stream. - This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes"> - <summary> - The enum of possible display attributes - </summary> - <remarks> - <para> - The following flags can be combined together to - form the ANSI color attributes. - </para> - </remarks> - <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright"> - <summary> - text is bright - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim"> - <summary> - text is dim - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore"> - <summary> - text is underlined - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink"> - <summary> - text is blinking - </summary> - <remarks> - Not all terminals support this attribute - </remarks> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse"> - <summary> - text and background colors are reversed - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden"> - <summary> - text is hidden - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough"> - <summary> - text is displayed with a strikethrough - </summary> - </member> - <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor"> - <summary> - The enum of possible foreground or background color values for - use with the color mapping method - </summary> - <remarks> - <para> - The output can be in one for the following ANSI colors. - </para> - </remarks> - <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black"> - <summary> - color is black - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red"> - <summary> - color is red - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green"> - <summary> - color is green - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow"> - <summary> - color is yellow - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue"> - <summary> - color is blue - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta"> - <summary> - color is magenta - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan"> - <summary> - color is cyan - </summary> - </member> - <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White"> - <summary> - color is white - </summary> - </member> - <member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"> - <summary> - A class to act as a mapping between the level that a logging call is made at and - the color it should be displayed as. - </summary> - <remarks> - <para> - Defines the mapping between a level and the color it should be displayed in. - </para> - </remarks> - </member> - <member name="T:log4net.Util.LevelMappingEntry"> - <summary> - An entry in the <see cref="T:log4net.Util.LevelMapping"/> - </summary> - <remarks> - <para> - This is an abstract base class for types that are stored in the - <see cref="T:log4net.Util.LevelMapping"/> object. - </para> - </remarks> - <author>Nicko Cadell</author> - </member> - <member name="M:log4net.Util.LevelMappingEntry.#ctor"> - <summary> - Default protected constructor - </summary> - <remarks> - <para> - Default protected constructor - </para> - </remarks> - </member> - <member name="M:log4net.Util.LevelMappingEntry.ActivateOptions"> - <summary> - Initialize any options defined on this entry - </summary> - <remarks> - <para> - Should be overridden by any classes that need to initialise based on their options - </para> - </remarks> - </member> - <member name="P:log4net.Util.LevelMappingEntry.Level"> - <summary> - The level that is the key for this mapping - </summary> - <value> - The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping - </value> - <remarks> - <para> - Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this - mapping subclass. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions"> - <summary> - Initialize the options for the object - </summary> - <remarks> - <para> - Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together - and append the attributes. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"> - <summary> - The mapped foreground color for the specified level - </summary> - <remarks> - <para> - Required property. - The mapped foreground color for the specified level - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"> - <summary> - The mapped background color for the specified level - </summary> - <remarks> - <para> - Required property. - The mapped background color for the specified level - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"> - <summary> - The color attributes for the specified level - </summary> - <remarks> - <para> - Required property. - The color attributes for the specified level - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor"> - <summary> - The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and - <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color. - </summary> - </member> - <member name="T:log4net.Appender.AppenderCollection"> - <summary> - A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects. - </summary> - <author>Nicko Cadell</author> - </member> - <member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)"> - <summary> - Creates a read-only wrapper for a <c>AppenderCollection</c> instance. - </summary> - <param name="list">list to create a readonly wrapper arround</param> - <returns> - An <c>AppenderCollection</c> wrapper that is read-only. - </returns> - </member> - <member name="F:log4net.Appender.AppenderCollection.EmptyCollection"> - <summary> - An empty readonly static AppenderCollection - </summary> - </member> - <member name="M:log4net.Appender.AppenderCollection.#ctor"> - <summary> - Initializes a new instance of the <c>AppenderCollection</c> class - that is empty and has the default initial capacity. - </summary> - </member> - <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)"> - <summary> - Initializes a new instance of the <c>AppenderCollection</c> class - that has the specified initial capacity. - </summary> - <param name="capacity"> - The number of elements that the new <c>AppenderCollection</c> is initially capable of storing. - </param> - </member> - <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)"> - <summary> - Initializes a new instance of the <c>AppenderCollection</c> class - that contains elements copied from the specified <c>AppenderCollection</c>. - </summary> - <param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param> - </member> - <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])"> - <summary> - Initializes a new instance of the <c>AppenderCollection</c> class - that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array. - </summary> - <param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param> - </member> - <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)"> - <summary> - Initializes a new instance of the <c>AppenderCollection</c> class - that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection. - </summary> - <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param> - </member> - <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)"> - <summary> - Allow subclasses to avoid our default constructors - </summary> - <param name="tag"></param> - <exclude/> - </member> - <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])"> - <summary> - Copies the entire <c>AppenderCollection</c> to a one-dimensional - <see cref="T:log4net.Appender.IAppender"/> array. - </summary> - <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param> - </member> - <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)"> - <summary> - Copies the entire <c>AppenderCollection</c> to a one-dimensional - <see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array. - </summary> - <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param> - <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param> - </member> - <member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)"> - <summary> - Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>. - </summary> - <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param> - <returns>The index at which the value has been added.</returns> - </member> - <member name="M:log4net.Appender.AppenderCollection.Clear"> - <summary> - Removes all elements from the <c>AppenderCollection</c>. - </summary> - </member> - <member name="M:log4net.Appender.AppenderCollection.Clone"> - <summary> - Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>. - </summary> - <returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns> - </member> - <member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)"> - <summary> - Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>. - </summary> - <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param> - <returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns> - </member> - <member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)"> - <summary> - Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/> - in the <c>AppenderCollection</c>. - </summary> - <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param> - <returns> - The zero-based index of the first occurrence of <paramref name="item"/> - in the entire <c>AppenderCollection</c>, if found; otherwise, -1. - </returns> - </member> - <member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)"> - <summary> - Inserts an element into the <c>AppenderCollection</c> at the specified index. - </summary> - <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param> - <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param> - <exception cref="T:System.ArgumentOutOfRangeException"> - <para><paramref name="index"/> is less than zero</para> - <para>-or-</para> - <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para> - </exception> - </member> - <member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)"> - <summary> - Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>. - </summary> - <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param> - <exception cref="T:System.ArgumentException"> - The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>. - </exception> - </member> - <member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)"> - <summary> - Removes the element at the specified index of the <c>AppenderCollection</c>. - </summary> - <param name="index">The zero-based index of the element to remove.</param> - <exception cref="T:System.ArgumentOutOfRangeException"> - <para><paramref name="index"/> is less than zero</para> - <para>-or-</para> - <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para> - </exception> - </member> - <member name="M:log4net.Appender.AppenderCollection.GetEnumerator"> - <summary> - Returns an enumerator that can iterate through the <c>AppenderCollection</c>. - </summary> - <returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns> - </member> - <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)"> - <summary> - Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>. - </summary> - <param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param> - <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns> - </member> - <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])"> - <summary> - Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>. - </summary> - <param name="x">The <see cref="T:log4net.Appender.IAppender"/> array whose elements should be added to the end of the <c>AppenderCollection</c>.</param> - <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns> - </member> - <member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)"> - <summary> - Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>. - </summary> - <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements should be added to the end of the <c>AppenderCollection</c>.</param> - <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns> - </member> - <member name="M:log4net.Appender.AppenderCollection.TrimToSize"> - <summary> - Sets the capacity to the actual number of elements. - </summary> - </member> - <member name="M:log4net.Appender.AppenderCollection.ToArray"> - <summary> - Return the collection elements as an array - </summary> - <returns>the array</returns> - </member> - <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)"> - <exception cref="T:System.ArgumentOutOfRangeException"> - <para><paramref name="index"/> is less than zero</para> - <para>-or-</para> - <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para> - </exception> - </member> - <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)"> - <exception cref="T:System.ArgumentOutOfRangeException"> - <para><paramref name="index"/> is less than zero</para> - <para>-or-</para> - <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para> - </exception> - </member> - <member name="P:log4net.Appender.AppenderCollection.Count"> - <summary> - Gets the number of elements actually contained in the <c>AppenderCollection</c>. - </summary> - </member> - <member name="P:log4net.Appender.AppenderCollection.IsSynchronized"> - <summary> - Gets a value indicating whether access to the collection is synchronized (thread-safe). - </summary> - <returns>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</returns> - </member> - <member name="P:log4net.Appender.AppenderCollection.SyncRoot"> - <summary> - Gets an object that can be used to synchronize access to the collection. - </summary> - </member> - <member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)"> - <summary> - Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index. - </summary> - <param name="index">The zero-based index of the element to get or set.</param> - <exception cref="T:System.ArgumentOutOfRangeException"> - <para><paramref name="index"/> is less than zero</para> - <para>-or-</para> - <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para> - </exception> - </member> - <member name="P:log4net.Appender.AppenderCollection.IsFixedSize"> - <summary> - Gets a value indicating whether the collection has a fixed size. - </summary> - <value>true if the collection has a fixed size; otherwise, false. The default is false</value> - </member> - <member name="P:log4net.Appender.AppenderCollection.IsReadOnly"> - <summary> - Gets a value indicating whether the IList is read-only. - </summary> - <value>true if the collection is read-only; otherwise, false. The default is false</value> - </member> - <member name="P:log4net.Appender.AppenderCollection.Capacity"> - <summary> - Gets or sets the number of elements the <c>AppenderCollection</c> can contain. - </summary> - </member> - <member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator"> - <summary> - Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>. - </summary> - <exclude/> - </member> - <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext"> - <summary> - Advances the enumerator to the next element in the collection. - </summary> - <returns> - <c>true</c> if the enumerator was successfully advanced to the next element; - <c>false</c> if the enumerator has passed the end of the collection. - </returns> - <exception cref="T:System.InvalidOperationException"> - The collection was modified after the enumerator was created. - </exception> - </member> - <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset"> - <summary> - Sets the enumerator to its initial position, before the first element in the collection. - </summary> - </member> - <member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current"> - <summary> - Gets the current element in the collection. - </summary> - </member> - <member name="T:log4net.Appender.AppenderCollection.Tag"> - <summary> - Type visible only to our subclasses - Used to access protected constructor - </summary> - <exclude/> - </member> - <member name="F:log4net.Appender.AppenderCollection.Tag.Default"> - <summary> - A value - </summary> - </member> - <member name="T:log4net.Appender.AppenderCollection.Enumerator"> - <summary> - Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>. - </summary> - <exclude/> - </member> - <member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)"> - <summary> - Initializes a new instance of the <c>Enumerator</c> class. - </summary> - <param name="tc"></param> - </member> - <member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext"> - <summary> - Advances the enumerator to the next element in the collection. - </summary> - <returns> - <c>true</c> if the enumerator was successfully advanced to the next element; - <c>false</c> if the enumerator has passed the end of the collection. - </returns> - <exception cref="T:System.InvalidOperationException"> - The collection was modified after the enumerator was created. - </exception> - </member> - <member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset"> - <summary> - Sets the enumerator to its initial position, before the first element in the collection. - </summary> - </member> - <member name="P:log4net.Appender.AppenderCollection.Enumerator.Current"> - <summary> - Gets the current element in the collection. - </summary> - </member> - <member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection"> - <exclude/> - </member> - <member name="T:log4net.Appender.AspNetTraceAppender"> - <summary> - <para> - Appends log events to the ASP.NET <see cref="T:System.Web.TraceContext"/> system. - </para> - </summary> - <remarks> - <para> - Diagnostic information and tracing messages that you specify are appended to the output - of the page that is sent to the requesting browser. Optionally, you can view this information - from a separate trace viewer (Trace.axd) that displays trace information for every page in a - given application. - </para> - <para> - Trace statements are processed and displayed only when tracing is enabled. You can control - whether tracing is displayed to a page, to the trace viewer, or both. - </para> - <para> - The logging event is passed to the <see cref="M:System.Web.TraceContext.Write(System.String)"/> or - <see cref="M:System.Web.TraceContext.Warn(System.String)"/> method depending on the level of the logging event. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Appender.AspNetTraceAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.AspNetTraceAppender"/> class. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.AspNetTraceAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - Write the logging event to the ASP.NET trace - </summary> - <param name="loggingEvent">the event to log</param> - <remarks> - <para> - Write the logging event to the ASP.NET trace - <c>HttpContext.Current.Trace</c> - (<see cref="T:System.Web.TraceContext"/>). - </para> - </remarks> - </member> - <member name="P:log4net.Appender.AspNetTraceAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.BufferingForwardingAppender"> - <summary> - Buffers events and then forwards them to attached appenders. - </summary> - <remarks> - <para> - The events are buffered in this appender until conditions are - met to allow the appender to deliver the events to the attached - appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the - conditions that cause the buffer to be sent. - </para> - <para>The forwarding appender can be used to specify different - thresholds and filters for the same appender at different locations - within the hierarchy. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="T:log4net.Core.IAppenderAttachable"> - <summary> - Interface for attaching appenders to objects. - </summary> - <remarks> - <para> - Interface for attaching, removing and retrieving appenders. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)"> - <summary> - Attaches an appender. - </summary> - <param name="appender">The appender to add.</param> - <remarks> - <para> - Add the specified appender. The implementation may - choose to allow or deny duplicate appenders. - </para> - </remarks> - </member> - <member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)"> - <summary> - Gets an attached appender with the specified name. - </summary> - <param name="name">The name of the appender to get.</param> - <returns> - The appender with the name specified, or <c>null</c> if no appender with the - specified name is found. - </returns> - <remarks> - <para> - Returns an attached appender with the <paramref name="name"/> specified. - If no appender with the specified name is found <c>null</c> will be - returned. - </para> - </remarks> - </member> - <member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders"> - <summary> - Removes all attached appenders. - </summary> - <remarks> - <para> - Removes and closes all attached appenders - </para> - </remarks> - </member> - <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)"> - <summary> - Removes the specified appender from the list of attached appenders. - </summary> - <param name="appender">The appender to remove.</param> - <returns>The appender removed from the list</returns> - <remarks> - <para> - The appender removed is not closed. - If you are discarding the appender you must call - <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. - </para> - </remarks> - </member> - <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)"> - <summary> - Removes the appender with the specified name from the list of appenders. - </summary> - <param name="name">The name of the appender to remove.</param> - <returns>The appender removed from the list</returns> - <remarks> - <para> - The appender removed is not closed. - If you are discarding the appender you must call - <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. - </para> - </remarks> - </member> - <member name="P:log4net.Core.IAppenderAttachable.Appenders"> - <summary> - Gets all attached appenders. - </summary> - <value> - A collection of attached appenders. - </value> - <remarks> - <para> - Gets a collection of attached appenders. - If there are no attached appenders the - implementation should return an empty - collection rather than <c>null</c>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingForwardingAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender"/> class. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingForwardingAppender.OnClose"> - <summary> - Closes the appender and releases resources. - </summary> - <remarks> - <para> - Releases any resources allocated within the appender such as file handles, - network connections, etc. - </para> - <para> - It is a programming error to append to a closed appender. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])"> - <summary> - Send the events. - </summary> - <param name="events">The events that need to be send.</param> - <remarks> - <para> - Forwards the events to the attached appenders. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)"> - <summary> - Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this - instance. - </summary> - <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param> - <remarks> - <para> - If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of - appenders, then it won't be added again. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)"> - <summary> - Looks for the appender with the specified name. - </summary> - <param name="name">The name of the appender to lookup.</param> - <returns> - The appender with the specified name, or <c>null</c>. - </returns> - <remarks> - <para> - Get the named appender attached to this buffering appender. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders"> - <summary> - Removes all previously added appenders from this appender. - </summary> - <remarks> - <para> - This is useful when re-reading configuration information. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)"> - <summary> - Removes the specified appender from the list of appenders. - </summary> - <param name="appender">The appender to remove.</param> - <returns>The appender removed from the list</returns> - <remarks> - The appender removed is not closed. - If you are discarding the appender you must call - <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. - </remarks> - </member> - <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)"> - <summary> - Removes the appender with the specified name from the list of appenders. - </summary> - <param name="name">The name of the appender to remove.</param> - <returns>The appender removed from the list</returns> - <remarks> - The appender removed is not closed. - If you are discarding the appender you must call - <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. - </remarks> - </member> - <member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl"> - <summary> - Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface - </summary> - </member> - <member name="P:log4net.Appender.BufferingForwardingAppender.Appenders"> - <summary> - Gets the appenders contained in this appender as an - <see cref="T:System.Collections.ICollection"/>. - </summary> - <remarks> - If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/> - is returned. - </remarks> - <returns> - A collection of the appenders in this appender. - </returns> - </member> - <member name="T:log4net.Appender.ConsoleAppender"> - <summary> - Appends logging events to the console. - </summary> - <remarks> - <para> - ConsoleAppender appends log events to the standard output stream - or the error output stream using a layout specified by the - user. - </para> - <para> - By default, all output is written to the console's standard output stream. - The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the - error stream. - </para> - <para> - NOTE: This appender writes each message to the <c>System.Console.Out</c> or - <c>System.Console.Error</c> that is set at the time the event is appended. - Therefore it is possible to programmatically redirect the output of this appender - (for example NUnit does this to capture program output). While this is the desired - behavior of this appender it may have security implications in your application. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut"> - <summary> - The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console - standard output stream. - </summary> - <remarks> - <para> - The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console - standard output stream. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.ConsoleAppender.ConsoleError"> - <summary> - The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console - standard error output stream. - </summary> - <remarks> - <para> - The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console - standard error output stream. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.ConsoleAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class. - </summary> - <remarks> - The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write - to the standard output stream. - </remarks> - </member> - <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class - with the specified layout. - </summary> - <param name="layout">the layout to use for this appender</param> - <remarks> - The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write - to the standard output stream. - </remarks> - </member> - <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class - with the specified layout. - </summary> - <param name="layout">the layout to use for this appender</param> - <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param> - <remarks> - When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to - the standard error output stream. Otherwise, output is written to the standard - output stream. - </remarks> - </member> - <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method. - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - Writes the event to the console. - </para> - <para> - The format of the output will depend on the appender's layout. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.ConsoleAppender.Target"> - <summary> - Target is the value of the console output stream. - This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. - </summary> - <value> - Target is the value of the console output stream. - This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. - </value> - <remarks> - <para> - Target is the value of the console output stream. - This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.DebugAppender"> - <summary> - Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system. - </summary> - <remarks> - <para> - The application configuration file can be used to control what listeners - are actually used. See the MSDN documentation for the - <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the - debug system. - </para> - <para> - Events are written using the <see cref="M:System.Diagnostics.Debug.Write(System.String,System.String)"/> - method. The event's logger name is passed as the value for the category name to the Write method. - </para> - </remarks> - <author>Nicko Cadell</author> - </member> - <member name="M:log4net.Appender.DebugAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/> - with a specified layout. - </summary> - <param name="layout">The layout to use with this appender.</param> - <remarks> - <para> - Obsolete constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system. - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system. - If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/> - is called. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.DebugAppender.m_immediateFlush"> - <summary> - Immediate flush means that the underlying writer or output stream - will be flushed at the end of each append operation. - </summary> - <remarks> - <para> - Immediate flush is slower but ensures that each append request is - actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to - <c>false</c>, then there is a good chance that the last few - logs events are not actually written to persistent media if and - when the application crashes. - </para> - <para> - The default value is <c>true</c>.</para> - </remarks> - </member> - <member name="P:log4net.Appender.DebugAppender.ImmediateFlush"> - <summary> - Gets or sets a value that indicates whether the appender will - flush at the end of each write. - </summary> - <remarks> - <para>The default behavior is to flush at the end of each - write. If the option is set to<c>false</c>, then the underlying - stream can defer writing to physical medium to a later time. - </para> - <para> - Avoiding the flush operation at the end of each append results - in a performance gain of 10 to 20 percent. However, there is safety - trade-off involved in skipping flushing. Indeed, when flushing is - skipped, then it is likely that the last few log events will not - be recorded on disk when the application exits. This is a high - price to pay even for a 20% performance gain. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.DebugAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.EventLogAppender"> - <summary> - Writes events to the system event log. - </summary> - <remarks> - <para> - The <c>EventID</c> of the event log entry can be - set using the <c>EventLogEventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>) - on the <see cref="T:log4net.Core.LoggingEvent"/>. - </para> - <para> - There is a limit of 32K characters for an event log message - </para> - <para> - When configuring the EventLogAppender a mapping can be - specified to map a logging level to an event log entry type. For example: - </para> - <code lang="XML"> - <mapping> - <level value="ERROR" /> - <eventLogEntryType value="Error" /> - </mapping> - <mapping> - <level value="DEBUG" /> - <eventLogEntryType value="Information" /> - </mapping> - </code> - <para> - The Level is the standard log4net logging level and eventLogEntryType can be any value - from the <see cref="T:System.Diagnostics.EventLogEntryType"/> enum, i.e.: - <list type="bullet"> - <item><term>Error</term><description>an error event</description></item> - <item><term>Warning</term><description>a warning event</description></item> - <item><term>Information</term><description>an informational event</description></item> - </list> - </para> - </remarks> - <author>Aspi Havewala</author> - <author>Douglas de la Torre</author> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - <author>Thomas Voss</author> - </member> - <member name="M:log4net.Appender.EventLogAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.EventLogAppender.#ctor(log4net.Layout.ILayout)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class - with the specified <see cref="T:log4net.Layout.ILayout"/>. - </summary> - <param name="layout">The <see cref="T:log4net.Layout.ILayout"/> to use with this appender.</param> - <remarks> - <para> - Obsolete constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.EventLogAppender.AddMapping(log4net.Appender.EventLogAppender.Level2EventLogEntryType)"> - <summary> - Add a mapping of level to <see cref="T:System.Diagnostics.EventLogEntryType"/> - done by the config file - </summary> - <param name="mapping">The mapping to add</param> - <remarks> - <para> - Add a <see cref="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"/> mapping to this appender. - Each mapping defines the event log entry type for a level. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.EventLogAppender.ActivateOptions"> - <summary> - Initialize the appender based on the options set - </summary> - <remarks> - <para> - This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object - activation scheme. The <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> method must - be called on this object after the configuration properties have - been set. Until <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> is called this - object is in an undefined state and must not be used. - </para> - <para> - If any of the configuration properties are modified then - <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> must be called again. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.EventLogAppender.CreateEventSource(System.String,System.String,System.String)"> - <summary> - Create an event log source - </summary> - <remarks> - Uses different API calls under NET_2_0 - </remarks> - </member> - <member name="M:log4net.Appender.EventLogAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> - method. - </summary> - <param name="loggingEvent">the event to log</param> - <remarks> - <para>Writes the event to the system event log using the - <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>.</para> - - <para>If the event has an <c>EventID</c> property (see <see cref="P:log4net.Core.LoggingEvent.Properties"/>) - set then this integer will be used as the event log event id.</para> - - <para> - There is a limit of 32K characters for an event log message - </para> - </remarks> - </member> - <member name="M:log4net.Appender.EventLogAppender.GetEntryType(log4net.Core.Level)"> - <summary> - Get the equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="p"/> - </summary> - <param name="level">the Level to convert to an EventLogEntryType</param> - <returns>The equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="p"/></returns> - <remarks> - Because there are fewer applicable <see cref="T:System.Diagnostics.EventLogEntryType"/> - values to use in logging levels than there are in the - <see cref="T:log4net.Core.Level"/> this is a one way mapping. There is - a loss of information during the conversion. - </remarks> - </member> - <member name="F:log4net.Appender.EventLogAppender.m_logName"> - <summary> - The log name is the section in the event logs where the messages - are stored. - </summary> - </member> - <member name="F:log4net.Appender.EventLogAppender.m_applicationName"> - <summary> - Name of the application to use when logging. This appears in the - application column of the event log named by <see cref="F:log4net.Appender.EventLogAppender.m_logName"/>. - </summary> - </member> - <member name="F:log4net.Appender.EventLogAppender.m_machineName"> - <summary> - The name of the machine which holds the event log. This is - currently only allowed to be '.' i.e. the current machine. - </summary> - </member> - <member name="F:log4net.Appender.EventLogAppender.m_levelMapping"> - <summary> - Mapping from level object to EventLogEntryType - </summary> - </member> - <member name="F:log4net.Appender.EventLogAppender.m_securityContext"> - <summary> - The security context to use for privileged calls - </summary> - </member> - <member name="P:log4net.Appender.EventLogAppender.LogName"> - <summary> - The name of the log where messages will be stored. - </summary> - <value> - The string name of the log where messages will be stored. - </value> - <remarks> - <para>This is the name of the log as it appears in the Event Viewer - tree. The default value is to log into the <c>Application</c> - log, this is where most applications write their events. However - if you need a separate log for your application (or applications) - then you should set the <see cref="P:log4net.Appender.EventLogAppender.LogName"/> appropriately.</para> - <para>This should not be used to distinguish your event log messages - from those of other applications, the <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/> - property should be used to distinguish events. This property should be - used to group together events into a single log. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.EventLogAppender.ApplicationName"> - <summary> - Property used to set the Application name. This appears in the - event logs when logging. - </summary> - <value> - The string used to distinguish events from different sources. - </value> - <remarks> - Sets the event log source property. - </remarks> - </member> - <member name="P:log4net.Appender.EventLogAppender.MachineName"> - <summary> - This property is used to return the name of the computer to use - when accessing the event logs. Currently, this is the current - computer, denoted by a dot "." - </summary> - <value> - The string name of the machine holding the event log that - will be logged into. - </value> - <remarks> - This property cannot be changed. It is currently set to '.' - i.e. the local machine. This may be changed in future. - </remarks> - </member> - <member name="P:log4net.Appender.EventLogAppender.SecurityContext"> - <summary> - Gets or sets the <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog. - </summary> - <value> - The <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog. - </value> - <remarks> - <para> - The system security context used to write to the EventLog. - </para> - <para> - Unless a <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> specified here for this appender - the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the - security context to use. The default behavior is to use the security context - of the current thread. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.EventLogAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"> - <summary> - A class to act as a mapping between the level that a logging call is made at and - the color it should be displayed as. - </summary> - <remarks> - <para> - Defines the mapping between a level and its event log entry type. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"> - <summary> - The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry - </summary> - <remarks> - <para> - Required property. - The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry - </para> - </remarks> - </member> - <member name="T:log4net.Appender.FileAppender"> - <summary> - Appends logging events to a file. - </summary> - <remarks> - <para> - Logging events are sent to the file specified by - the <see cref="P:log4net.Appender.FileAppender.File"/> property. - </para> - <para> - The file can be opened in either append or overwrite mode - by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property. - If the file path is relative it is taken as relative from - the application base directory. The file encoding can be - specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property. - </para> - <para> - The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/> - values will be written each time the file is opened and closed - respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/> - then the file may contain multiple copies of the header and footer. - </para> - <para> - This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> - is called. This will typically be during configuration. - If the file cannot be opened for writing the appender will attempt - to open the file again each time a message is logged to the appender. - If the file cannot be opened for writing when a message is logged then - the message will be discarded by this appender. - </para> - <para> - The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via - the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property. - The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> - is to obtain an exclusive write lock on the file until this appender is closed. - The alternative model, <see cref="T:log4net.Appender.FileAppender.MinimalLock"/>, only holds a - write lock while the appender is writing a logging event. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - <author>Rodrigo B. de Oliveira</author> - <author>Douglas de la Torre</author> - <author>Niall Daley</author> - </member> - <member name="T:log4net.Appender.TextWriterAppender"> - <summary> - Sends logging events to a <see cref="T:System.IO.TextWriter"/>. - </summary> - <remarks> - <para> - An Appender that writes to a <see cref="T:System.IO.TextWriter"/>. - </para> - <para> - This appender may be used stand alone if initialized with an appropriate - writer, however it is typically used as a base class for an appender that - can open a <see cref="T:System.IO.TextWriter"/> to write to. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - <author>Douglas de la Torre</author> - </member> - <member name="M:log4net.Appender.TextWriterAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and - sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized - with the specified <see cref="T:System.IO.Stream"/>. - </summary> - <param name="layout">The layout to use with this appender.</param> - <param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param> - <remarks> - <para> - Obsolete constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and sets - the output destination to the specified <see cref="T:System.IO.StreamWriter"/>. - </summary> - <param name="layout">The layout to use with this appender</param> - <param name="writer">The <see cref="T:System.IO.TextWriter"/> to output to</param> - <remarks> - The <see cref="T:System.IO.TextWriter"/> must have been previously opened. - </remarks> - <remarks> - <para> - Obsolete constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck"> - <summary> - This method determines if there is a sense in attempting to append. - </summary> - <remarks> - <para> - This method checked if an output target has been set and if a - layout has been set. - </para> - </remarks> - <returns><c>false</c> if any of the preconditions fail.</returns> - </member> - <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> - method. - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - Writes a log statement to the output stream if the output stream exists - and is writable. - </para> - <para> - The format of the output will depend on the appender's layout. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])"/> - method. - </summary> - <param name="loggingEvents">The array of events to log.</param> - <remarks> - <para> - This method writes all the bulk logged events to the output writer - before flushing the stream. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TextWriterAppender.OnClose"> - <summary> - Close this appender instance. The underlying stream or writer is also closed. - </summary> - <remarks> - Closed appenders cannot be reused. - </remarks> - </member> - <member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter"> - <summary> - Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>. - </summary> - <remarks> - <para> - Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TextWriterAppender.CloseWriter"> - <summary> - Closes the underlying <see cref="T:System.IO.TextWriter"/>. - </summary> - <remarks> - <para> - Closes the underlying <see cref="T:System.IO.TextWriter"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TextWriterAppender.Reset"> - <summary> - Clears internal references to the underlying <see cref="T:System.IO.TextWriter"/> - and other variables. - </summary> - <remarks> - <para> - Subclasses can override this method for an alternate closing behavior. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TextWriterAppender.WriteFooter"> - <summary> - Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property. - </summary> - <remarks> - <para> - Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TextWriterAppender.WriteHeader"> - <summary> - Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property. - </summary> - <remarks> - <para> - Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TextWriterAppender.PrepareWriter"> - <summary> - Called to allow a subclass to lazily initialize the writer - </summary> - <remarks> - <para> - This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or - <see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to - attempt to initialize the writer multiple times. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.TextWriterAppender.m_qtw"> - <summary> - This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events - will be written to. - </summary> - </member> - <member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush"> - <summary> - Immediate flush means that the underlying <see cref="T:System.IO.TextWriter"/> - or output stream will be flushed at the end of each append operation. - </summary> - <remarks> - <para> - Immediate flush is slower but ensures that each append request is - actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to - <c>false</c>, then there is a good chance that the last few - logging events are not actually persisted if and when the application - crashes. - </para> - <para> - The default value is <c>true</c>. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush"> - <summary> - Gets or set whether the appender will flush at the end - of each append operation. - </summary> - <value> - <para> - The default behavior is to flush at the end of each - append operation. - </para> - <para> - If this option is set to <c>false</c>, then the underlying - stream can defer persisting the logging event to a later - time. - </para> - </value> - <remarks> - Avoiding the flush operation at the end of each append results in - a performance gain of 10 to 20 percent. However, there is safety - trade-off involved in skipping flushing. Indeed, when flushing is - skipped, then it is likely that the last few log events will not - be recorded on disk when the application exits. This is a high - price to pay even for a 20% performance gain. - </remarks> - </member> - <member name="P:log4net.Appender.TextWriterAppender.Writer"> - <summary> - Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go. - </summary> - <remarks> - <para> - The specified <see cref="T:System.IO.TextWriter"/> must be open and writable. - </para> - <para> - The <see cref="T:System.IO.TextWriter"/> will be closed when the appender - instance is closed. - </para> - <para> - <b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.TextWriterAppender.ErrorHandler"> - <summary> - Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying - <see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender. - </summary> - <value> - The <see cref="T:log4net.Core.IErrorHandler"/> for this appender. - </value> - </member> - <member name="P:log4net.Appender.TextWriterAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.TextWriterAppender.QuietWriter"> - <summary> - Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events - will be written to. - </summary> - <value> - The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written. - </value> - <remarks> - <para> - This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events - will be written to. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.#ctor"> - <summary> - Default constructor - </summary> - <remarks> - <para> - Default constructor - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)"> - <summary> - Construct a new appender using the layout, file and append mode. - </summary> - <param name="layout">the layout to use with this appender</param> - <param name="filename">the full path to the file to write to</param> - <param name="append">flag to indicate if the file should be appended to</param> - <remarks> - <para> - Obsolete constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)"> - <summary> - Construct a new appender using the layout and file specified. - The file will be appended to. - </summary> - <param name="layout">the layout to use with this appender</param> - <param name="filename">the full path to the file to write to</param> - <remarks> - <para> - Obsolete constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.ActivateOptions"> - <summary> - Activate the options on the file appender. - </summary> - <remarks> - <para> - This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object - activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must - be called on this object after the configuration properties have - been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this - object is in an undefined state and must not be used. - </para> - <para> - If any of the configuration properties are modified then - <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again. - </para> - <para> - This will cause the file to be opened. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.Reset"> - <summary> - Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>. - </summary> - <remarks> - <para> - Resets the filename and the file stream. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.PrepareWriter"> - <summary> - Called to initialize the file writer - </summary> - <remarks> - <para> - Will be called for each logged message until the file is - successfully opened. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> - method. - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - Writes a log statement to the output stream if the output stream exists - and is writable. - </para> - <para> - The format of the output will depend on the appender's layout. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])"/> - method. - </summary> - <param name="loggingEvents">The array of events to log.</param> - <remarks> - <para> - Acquires the output file locks once before writing all the events to - the stream. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.WriteFooter"> - <summary> - Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property. - </summary> - <remarks> - <para> - Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.WriteHeader"> - <summary> - Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property. - </summary> - <remarks> - <para> - Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.CloseWriter"> - <summary> - Closes the underlying <see cref="T:System.IO.TextWriter"/>. - </summary> - <remarks> - <para> - Closes the underlying <see cref="T:System.IO.TextWriter"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.CloseFile"> - <summary> - Closes the previously opened file. - </summary> - <remarks> - <para> - Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then - closes the file. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)"> - <summary> - Sets and <i>opens</i> the file where the log output will go. The specified file must be writable. - </summary> - <param name="fileName">The path to the log file. Must be a fully qualified path.</param> - <param name="append">If true will append to fileName. Otherwise will truncate fileName</param> - <remarks> - <para> - Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception. - Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"> - <summary> - Sets and <i>opens</i> the file where the log output will go. The specified file must be writable. - </summary> - <param name="fileName">The path to the log file. Must be a fully qualified path.</param> - <param name="append">If true will append to fileName. Otherwise will truncate fileName</param> - <remarks> - <para> - If there was already an opened file, then the previous file - is closed first. - </para> - <para> - This method will ensure that the directory structure - for the <paramref name="fileName"/> specified exists. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)"> - <summary> - Sets the quiet writer used for file output - </summary> - <param name="fileStream">the file stream that has been opened for writing</param> - <remarks> - <para> - This implementation of <see cref="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/> - over the <paramref name="fileStream"/> and passes it to the - <see cref="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)"/> method. - </para> - <para> - This method can be overridden by sub classes that want to wrap the - <see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output - data using a <c>System.Security.Cryptography.CryptoStream</c>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)"> - <summary> - Sets the quiet writer being used. - </summary> - <param name="writer">the writer over the file stream that has been opened for writing</param> - <remarks> - <para> - This method can be overridden by sub classes that want to - wrap the <see cref="T:System.IO.TextWriter"/> in some way. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)"> - <summary> - Convert a path into a fully qualified path. - </summary> - <param name="path">The path to convert.</param> - <returns>The fully qualified path.</returns> - <remarks> - <para> - Converts the path specified to a fully - qualified path. If the path is relative it is - taken as relative from the application base - directory. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.FileAppender.m_appendToFile"> - <summary> - Flag to indicate if we should append to the file - or overwrite the file. The default is to append. - </summary> - </member> - <member name="F:log4net.Appender.FileAppender.m_fileName"> - <summary> - The name of the log file. - </summary> - </member> - <member name="F:log4net.Appender.FileAppender.m_encoding"> - <summary> - The encoding to use for the file stream. - </summary> - </member> - <member name="F:log4net.Appender.FileAppender.m_securityContext"> - <summary> - The security context to use for privileged calls - </summary> - </member> - <member name="F:log4net.Appender.FileAppender.m_stream"> - <summary> - The stream to log to. Has added locking semantics - </summary> - </member> - <member name="F:log4net.Appender.FileAppender.m_lockingModel"> - <summary> - The locking model to use - </summary> - </member> - <member name="P:log4net.Appender.FileAppender.File"> - <summary> - Gets or sets the path to the file that logging will be written to. - </summary> - <value> - The path to the file that logging will be written to. - </value> - <remarks> - <para> - If the path is relative it is taken as relative from - the application base directory. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.FileAppender.AppendToFile"> - <summary> - Gets or sets a flag that indicates whether the file should be - appended to or overwritten. - </summary> - <value> - Indicates whether the file should be appended to or overwritten. - </value> - <remarks> - <para> - If the value is set to false then the file will be overwritten, if - it is set to true then the file will be appended to. - </para> - The default value is true. - </remarks> - </member> - <member name="P:log4net.Appender.FileAppender.Encoding"> - <summary> - Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file. - </summary> - <value> - The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file. - </value> - <remarks> - <para> - The default encoding set is <see cref="P:System.Text.Encoding.Default"/> - which is the encoding for the system's current ANSI code page. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.FileAppender.SecurityContext"> - <summary> - Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file. - </summary> - <value> - The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file. - </value> - <remarks> - <para> - Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender - the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the - security context to use. The default behavior is to use the security context - of the current thread. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.FileAppender.LockingModel"> - <summary> - Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file. - </summary> - <value> - The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file. - </value> - <remarks> - <para> - Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file. - </para> - <para> - There are two built in locking models, <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> and <see cref="T:log4net.Appender.FileAppender.MinimalLock"/>. - The former locks the file from the start of logging to the end and the - later lock only for the minimal amount of time when logging each message. - </para> - <para> - The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.FileAppender.LockingStream"> - <summary> - Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/> - to manage access to an underlying resource. - </summary> - </member> - <member name="M:log4net.Appender.FileAppender.LockingStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"> - <summary> - True asynchronous writes are not supported, the implementation forces a synchronous write. - </summary> - </member> - <member name="T:log4net.Core.LogException"> - <summary> - Exception base type for log4net. - </summary> - <remarks> - <para> - This type extends <see cref="T:System.ApplicationException"/>. It - does not add any new functionality but does differentiate the - type of exception being thrown. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Core.LogException.#ctor"> - <summary> - Constructor - </summary> - <remarks> - <para> - Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class. - </para> - </remarks> - </member> - <member name="M:log4net.Core.LogException.#ctor(System.String)"> - <summary> - Constructor - </summary> - <param name="message">A message to include with the exception.</param> - <remarks> - <para> - Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class with - the specified message. - </para> - </remarks> - </member> - <member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)"> - <summary> - Constructor - </summary> - <param name="message">A message to include with the exception.</param> - <param name="innerException">A nested exception to include.</param> - <remarks> - <para> - Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class - with the specified message and inner exception. - </para> - </remarks> - </member> - <member name="M:log4net.Core.LogException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> - <summary> - Serialization constructor - </summary> - <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> - <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> - <remarks> - <para> - Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class - with serialized data. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.FileAppender.LockingModelBase"> - <summary> - Locking model base class - </summary> - <remarks> - <para> - Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)"> - <summary> - Open the output file - </summary> - <param name="filename">The filename to use</param> - <param name="append">Whether to append to the file, or overwrite</param> - <param name="encoding">The encoding to use</param> - <remarks> - <para> - Open the file specified and prepare for logging. - No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called. - Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>, - <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"> - <summary> - Close the file - </summary> - <remarks> - <para> - Close the file. No further writes will be made. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"> - <summary> - Acquire the lock on the file - </summary> - <returns>A stream that is ready to be written to.</returns> - <remarks> - <para> - Acquire the lock on the file in preparation for writing to it. - Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> - must be called to release the lock on the output file. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"> - <summary> - Release the lock on the file - </summary> - <remarks> - <para> - Release the lock on the file. No further writes will be made to the - stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender"> - <summary> - Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel - </summary> - <value> - The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel - </value> - <remarks> - <para> - The file appender this locking model is attached to and working on - behalf of. - </para> - <para> - The file appender is used to locate the security context and the error handler to use. - </para> - <para> - The value of this property will be set before <see cref="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)"/> is - called. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.FileAppender.ExclusiveLock"> - <summary> - Hold an exclusive lock on the output file - </summary> - <remarks> - <para> - Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called. - Maintains an exclusive lock on the file during this time. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)"> - <summary> - Open the file specified and prepare for logging. - </summary> - <param name="filename">The filename to use</param> - <param name="append">Whether to append to the file, or overwrite</param> - <param name="encoding">The encoding to use</param> - <remarks> - <para> - Open the file specified and prepare for logging. - No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called. - Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>, - <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"> - <summary> - Close the file - </summary> - <remarks> - <para> - Close the file. No further writes will be made. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"> - <summary> - Acquire the lock on the file - </summary> - <returns>A stream that is ready to be written to.</returns> - <remarks> - <para> - Does nothing. The lock is already taken - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"> - <summary> - Release the lock on the file - </summary> - <remarks> - <para> - Does nothing. The lock will be released when the file is closed. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.FileAppender.MinimalLock"> - <summary> - Acquires the file lock for each write - </summary> - <remarks> - <para> - Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle, - thus holding the lock for the minimal amount of time. This method of locking - is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows - other processes to move/delete the log file whilst logging continues. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)"> - <summary> - Prepares to open the file when the first message is logged. - </summary> - <param name="filename">The filename to use</param> - <param name="append">Whether to append to the file, or overwrite</param> - <param name="encoding">The encoding to use</param> - <remarks> - <para> - Open the file specified and prepare for logging. - No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called. - Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>, - <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"> - <summary> - Close the file - </summary> - <remarks> - <para> - Close the file. No further writes will be made. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"> - <summary> - Acquire the lock on the file - </summary> - <returns>A stream that is ready to be written to.</returns> - <remarks> - <para> - Acquire the lock on the file in preparation for writing to it. - Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> - must be called to release the lock on the output file. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"> - <summary> - Release the lock on the file - </summary> - <remarks> - <para> - Release the lock on the file. No further writes will be made to the - stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.ForwardingAppender"> - <summary> - This appender forwards logging events to attached appenders. - </summary> - <remarks> - <para> - The forwarding appender can be used to specify different thresholds - and filters for the same appender at different locations within the hierarchy. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Appender.ForwardingAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender"/> class. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.ForwardingAppender.OnClose"> - <summary> - Closes the appender and releases resources. - </summary> - <remarks> - <para> - Releases any resources allocated within the appender such as file handles, - network connections, etc. - </para> - <para> - It is a programming error to append to a closed appender. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - Forward the logging event to the attached appenders - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - Delivers the logging event to all the attached appenders. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])"> - <summary> - Forward the logging events to the attached appenders - </summary> - <param name="loggingEvents">The array of events to log.</param> - <remarks> - <para> - Delivers the logging events to all the attached appenders. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)"> - <summary> - Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this - instance. - </summary> - <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param> - <remarks> - <para> - If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of - appenders, then it won't be added again. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)"> - <summary> - Looks for the appender with the specified name. - </summary> - <param name="name">The name of the appender to lookup.</param> - <returns> - The appender with the specified name, or <c>null</c>. - </returns> - <remarks> - <para> - Get the named appender attached to this appender. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders"> - <summary> - Removes all previously added appenders from this appender. - </summary> - <remarks> - <para> - This is useful when re-reading configuration information. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)"> - <summary> - Removes the specified appender from the list of appenders. - </summary> - <param name="appender">The appender to remove.</param> - <returns>The appender removed from the list</returns> - <remarks> - The appender removed is not closed. - If you are discarding the appender you must call - <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. - </remarks> - </member> - <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)"> - <summary> - Removes the appender with the specified name from the list of appenders. - </summary> - <param name="name">The name of the appender to remove.</param> - <returns>The appender removed from the list</returns> - <remarks> - The appender removed is not closed. - If you are discarding the appender you must call - <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. - </remarks> - </member> - <member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl"> - <summary> - Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface - </summary> - </member> - <member name="P:log4net.Appender.ForwardingAppender.Appenders"> - <summary> - Gets the appenders contained in this appender as an - <see cref="T:System.Collections.ICollection"/>. - </summary> - <remarks> - If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/> - is returned. - </remarks> - <returns> - A collection of the appenders in this appender. - </returns> - </member> - <member name="T:log4net.Appender.LocalSyslogAppender"> - <summary> - Logs events to a local syslog service. - </summary> - <remarks> - <note> - This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>. - If these functions are not available on the local system then this appender will not work! - </note> - <para> - The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and - POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service. - </para> - <para> - This appender talks to a local syslog service. If you need to log to a remote syslog - daemon and you cannot configure your local syslog service to do this you may be - able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP. - </para> - <para> - Syslog messages must have a facility and and a severity. The severity - is derived from the Level of the logging event. - The facility must be chosen from the set of defined syslog - <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined - and cannot be extended. - </para> - <para> - An identifier is specified with each log message. This can be specified - by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know - as the tag) must not contain white space. The default value for the - identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>). - </para> - </remarks> - <author>Rob Lyon</author> - <author>Nicko Cadell</author> - </member> - <member name="M:log4net.Appender.LocalSyslogAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class. - </summary> - <remarks> - This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class is set up to write - to a local syslog service. - </remarks> - </member> - <member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"> - <summary> - Add a mapping of level to severity - </summary> - <param name="mapping">The mapping to add</param> - <remarks> - <para> - Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"> - <summary> - Initialize the appender based on the options set. - </summary> - <remarks> - <para> - This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object - activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must - be called on this object after the configuration properties have - been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this - object is in an undefined state and must not be used. - </para> - <para> - If any of the configuration properties are modified then - <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method. - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - Writes the event to a remote syslog daemon. - </para> - <para> - The format of the output will depend on the appender's layout. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.LocalSyslogAppender.OnClose"> - <summary> - Close the syslog when the appender is closed - </summary> - <remarks> - <para> - Close the syslog when the appender is closed - </para> - </remarks> - </member> - <member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)"> - <summary> - Translates a log4net level to a syslog severity. - </summary> - <param name="level">A log4net level.</param> - <returns>A syslog severity.</returns> - <remarks> - <para> - Translates a log4net level to a syslog severity. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)"> - <summary> - Generate a syslog priority. - </summary> - <param name="facility">The syslog facility.</param> - <param name="severity">The syslog severity.</param> - <returns>A syslog priority.</returns> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.m_facility"> - <summary> - The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>. - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.m_identity"> - <summary> - The message identity - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity"> - <summary> - Marshaled handle to the identity string. We have to hold on to the - string as the <c>openlog</c> and <c>syslog</c> APIs just hold the - pointer to the ident and dereference it for each log message. - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping"> - <summary> - Mapping from level object to syslog severity - </summary> - </member> - <member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)"> - <summary> - Open connection to system logger. - </summary> - </member> - <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)"> - <summary> - Generate a log message. - </summary> - <remarks> - <para> - The libc syslog method takes a format string and a variable argument list similar - to the classic printf function. As this type of vararg list is not supported - by C# we need to specify the arguments explicitly. Here we have specified the - format string with a single message argument. The caller must set the format - string to <c>"%s"</c>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.LocalSyslogAppender.closelog"> - <summary> - Close descriptor used to write to system logger. - </summary> - </member> - <member name="P:log4net.Appender.LocalSyslogAppender.Identity"> - <summary> - Message identity - </summary> - <remarks> - <para> - An identifier is specified with each log message. This can be specified - by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know - as the tag) must not contain white space. The default value for the - identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>). - </para> - </remarks> - </member> - <member name="P:log4net.Appender.LocalSyslogAppender.Facility"> - <summary> - Syslog facility - </summary> - <remarks> - Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of - facilities is predefined and cannot be extended. The default value - is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>. - </remarks> - </member> - <member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity"> - <summary> - syslog severities - </summary> - <remarks> - <para> - The log4net Level maps to a syslog severity using the - <see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> - class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency"> - <summary> - system is unusable - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert"> - <summary> - action must be taken immediately - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical"> - <summary> - critical conditions - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error"> - <summary> - error conditions - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning"> - <summary> - warning conditions - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice"> - <summary> - normal but significant condition - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational"> - <summary> - informational - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug"> - <summary> - debug-level messages - </summary> - </member> - <member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"> - <summary> - syslog facilities - </summary> - <remarks> - <para> - The syslog facility defines which subsystem the logging comes from. - This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel"> - <summary> - kernel messages - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"> - <summary> - random user-level messages - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail"> - <summary> - mail system - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons"> - <summary> - system daemons - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization"> - <summary> - security/authorization messages - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog"> - <summary> - messages generated internally by syslogd - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer"> - <summary> - line printer subsystem - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News"> - <summary> - network news subsystem - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp"> - <summary> - UUCP subsystem - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock"> - <summary> - clock (cron/at) daemon - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2"> - <summary> - security/authorization messages (private) - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp"> - <summary> - ftp daemon - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp"> - <summary> - NTP subsystem - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit"> - <summary> - log audit - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert"> - <summary> - log alert - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2"> - <summary> - clock daemon - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7"> - <summary> - reserved for local use - </summary> - </member> - <member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"> - <summary> - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - </summary> - <remarks> - <para> - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"> - <summary> - The mapped syslog severity for the specified level - </summary> - <remarks> - <para> - Required property. - The mapped syslog severity for the specified level - </para> - </remarks> - </member> - <member name="T:log4net.Appender.MemoryAppender"> - <summary> - Stores logging events in an array. - </summary> - <remarks> - <para> - The memory appender stores all the logging events - that are appended in an in-memory array. - </para> - <para> - Use the <see cref="M:log4net.Appender.MemoryAppender.GetEvents"/> method to get - the current list of events that have been appended. - </para> - <para> - Use the <see cref="M:log4net.Appender.MemoryAppender.Clear"/> method to clear the - current list of events. - </para> - </remarks> - <author>Julian Biddle</author> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Appender.MemoryAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender"/> class. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.MemoryAppender.GetEvents"> - <summary> - Gets the events that have been logged. - </summary> - <returns>The events that have been logged</returns> - <remarks> - <para> - Gets the events that have been logged. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method. - </summary> - <param name="loggingEvent">the event to log</param> - <remarks> - <para>Stores the <paramref name="loggingEvent"/> in the events list.</para> - </remarks> - </member> - <member name="M:log4net.Appender.MemoryAppender.Clear"> - <summary> - Clear the list of events - </summary> - <remarks> - Clear the list of events - </remarks> - </member> - <member name="F:log4net.Appender.MemoryAppender.m_eventsList"> - <summary> - The list of events that have been appended. - </summary> - </member> - <member name="F:log4net.Appender.MemoryAppender.m_fixFlags"> - <summary> - Value indicating which fields in the event should be fixed - </summary> - <remarks> - By default all fields are fixed - </remarks> - </member> - <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData"> - <summary> - Gets or sets a value indicating whether only part of the logging event - data should be fixed. - </summary> - <value> - <c>true</c> if the appender should only fix part of the logging event - data, otherwise <c>false</c>. The default is <c>false</c>. - </value> - <remarks> - <para> - Setting this property to <c>true</c> will cause only part of the event - data to be fixed and stored in the appender, hereby improving performance. - </para> - <para> - See <see cref="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)"/> for more information. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.MemoryAppender.Fix"> - <summary> - Gets or sets the fields that will be fixed in the event - </summary> - <remarks> - <para> - The logging event needs to have certain thread specific values - captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/> - for details. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.RemoteSyslogAppender"> - <summary> - Logs events to a remote syslog daemon. - </summary> - <remarks> - <para> - The BSD syslog protocol is used to remotely log to - a syslog daemon. The syslogd listens for for messages - on UDP port 514. - </para> - <para> - The syslog UDP protocol is not authenticated. Most syslog daemons - do not accept remote log messages because of the security implications. - You may be able to use the LocalSyslogAppender to talk to a local - syslog service. - </para> - <para> - There is an RFC 3164 that claims to document the BSD Syslog Protocol. - This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html. - This appender generates what the RFC calls an "Original Device Message", - i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation - this format of message will be accepted by all current syslog daemon - implementations. The daemon will attach the current time and the source - hostname or IP address to any messages received. - </para> - <para> - Syslog messages must have a facility and and a severity. The severity - is derived from the Level of the logging event. - The facility must be chosen from the set of defined syslog - <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined - and cannot be extended. - </para> - <para> - An identifier is specified with each log message. This can be specified - by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know - as the tag) must not contain white space. The default value for the - identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>). - </para> - </remarks> - <author>Rob Lyon</author> - <author>Nicko Cadell</author> - </member> - <member name="T:log4net.Appender.UdpAppender"> - <summary> - Sends logging events as connectionless UDP datagrams to a remote host or a - multicast group using an <see cref="T:System.Net.Sockets.UdpClient"/>. - </summary> - <remarks> - <para> - UDP guarantees neither that messages arrive, nor that they arrive in the correct order. - </para> - <para> - To view the logging results, a custom application can be developed that listens for logging - events. - </para> - <para> - When decoding events send via this appender remember to use the same encoding - to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/> - property to specify the encoding to use. - </para> - </remarks> - <example> - This example shows how to log receive logging events that are sent - on IP address 244.0.0.1 and port 8080 to the console. The event is - encoded in the packet as a unicode string and it is decoded as such. - <code lang="C#"> - IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0); - UdpClient udpClient; - byte[] buffer; - string loggingEvent; - - try - { - udpClient = new UdpClient(8080); - - while(true) - { - buffer = udpClient.Receive(ref remoteEndPoint); - loggingEvent = System.Text.Encoding.Unicode.GetString(buffer); - Console.WriteLine(loggingEvent); - } - } - catch(Exception e) - { - Console.WriteLine(e.ToString()); - } - </code> - <code lang="Visual Basic"> - Dim remoteEndPoint as IPEndPoint - Dim udpClient as UdpClient - Dim buffer as Byte() - Dim loggingEvent as String - - Try - remoteEndPoint = new IPEndPoint(IPAddress.Any, 0) - udpClient = new UdpClient(8080) - - While True - buffer = udpClient.Receive(ByRef remoteEndPoint) - loggingEvent = System.Text.Encoding.Unicode.GetString(buffer) - Console.WriteLine(loggingEvent) - Wend - Catch e As Exception - Console.WriteLine(e.ToString()) - End Try - </code> - <para> - An example configuration section to log information using this appender to the - IP 224.0.0.1 on port 8080: - </para> - <code lang="XML" escaped="true"> - <appender name="UdpAppender" type="log4net.Appender.UdpAppender"> - <remoteAddress value="224.0.0.1"/> - <remotePort value="8080"/> - <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline"/> - </appender> - </code> - </example> - <author>Gert Driesen</author> - <author>Nicko Cadell</author> - </member> - <member name="M:log4net.Appender.UdpAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender"/> class. - </summary> - <remarks> - The default constructor initializes all fields to their default values. - </remarks> - </member> - <member name="M:log4net.Appender.UdpAppender.ActivateOptions"> - <summary> - Initialize the appender based on the options set. - </summary> - <remarks> - <para> - This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object - activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must - be called on this object after the configuration properties have - been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this - object is in an undefined state and must not be used. - </para> - <para> - If any of the configuration properties are modified then - <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again. - </para> - <para> - The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was specified or - an invalid remote or local TCP port number was specified. - </para> - </remarks> - <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was not specified.</exception> - <exception cref="T:System.ArgumentOutOfRangeException">The TCP port number assigned to <see cref="P:log4net.Appender.UdpAppender.LocalPort"/> or <see cref="P:log4net.Appender.UdpAppender.RemotePort"/> is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception> - </member> - <member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method. - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - Sends the event using an UDP datagram. - </para> - <para> - Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.UdpAppender.OnClose"> - <summary> - Closes the UDP connection and releases all resources associated with - this <see cref="T:log4net.Appender.UdpAppender"/> instance. - </summary> - <remarks> - <para> - Disables the underlying <see cref="T:System.Net.Sockets.UdpClient"/> and releases all managed - and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.UdpAppender.InitializeClientConnection"> - <summary> - Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient"/> connection. - </summary> - <remarks> - <para> - The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the - port number from which you intend to communicate. - </para> - <para> - Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.UdpAppender.m_remoteAddress"> - <summary> - The IP address of the remote host or multicast group to which - the logging event will be sent. - </summary> - </member> - <member name="F:log4net.Appender.UdpAppender.m_remotePort"> - <summary> - The TCP port number of the remote host or multicast group to - which the logging event will be sent. - </summary> - </member> - <member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint"> - <summary> - The cached remote endpoint to which the logging events will be sent. - </summary> - </member> - <member name="F:log4net.Appender.UdpAppender.m_localPort"> - <summary> - The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient"/> will communicate. - </summary> - </member> - <member name="F:log4net.Appender.UdpAppender.m_client"> - <summary> - The <see cref="T:System.Net.Sockets.UdpClient"/> instance that will be used for sending the - logging events. - </summary> - </member> - <member name="F:log4net.Appender.UdpAppender.m_encoding"> - <summary> - The encoding to use for the packet. - </summary> - </member> - <member name="P:log4net.Appender.UdpAppender.RemoteAddress"> - <summary> - Gets or sets the IP address of the remote host or multicast group to which - the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event. - </summary> - <value> - The IP address of the remote host or multicast group to which the logging event - will be sent. - </value> - <remarks> - <para> - Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to - 239.255.255.255). Multicast packets can pass across different networks through routers, so - it is possible to use multicasts in an Internet scenario as long as your network provider - supports multicasting. - </para> - <para> - Hosts that want to receive particular multicast messages must register their interest by joining - the multicast group. Multicast messages are not sent to networks where no host has joined - the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate - them from normal host addresses, allowing nodes to easily detect if a message is of interest. - </para> - <para> - Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below: - </para> - <para> - <list type="table"> - <listheader> - <term>IP Address</term> - <description>Description</description> - </listheader> - <item> - <term>224.0.0.1</term> - <description> - <para> - Sends a message to all system on the subnet. - </para> - </description> - </item> - <item> - <term>224.0.0.2</term> - <description> - <para> - Sends a message to all routers on the subnet. - </para> - </description> - </item> - <item> - <term>224.0.0.12</term> - <description> - <para> - The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet. - </para> - </description> - </item> - </list> - </para> - <para> - A complete list of actually reserved multicast addresses and their owners in the ranges - defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>. - </para> - <para> - The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative - addresses. These addresses can be reused with other local groups. Routers are typically - configured with filters to prevent multicast traffic in this range from flowing outside - of the local network. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.UdpAppender.RemotePort"> - <summary> - Gets or sets the TCP port number of the remote host or multicast group to which - the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event. - </summary> - <value> - An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/> - indicating the TCP port number of the remote host or multicast group to which the logging event - will be sent. - </value> - <remarks> - The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will send messages to this TCP port number - on the remote host or multicast group. - </remarks> - <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception> - </member> - <member name="P:log4net.Appender.UdpAppender.LocalPort"> - <summary> - Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate. - </summary> - <value> - An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/> - indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate. - </value> - <remarks> - <para> - The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will bind to this port for sending messages. - </para> - <para> - Setting the value to 0 (the default) will cause the udp client not to bind to - a local port. - </para> - </remarks> - <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception> - </member> - <member name="P:log4net.Appender.UdpAppender.Encoding"> - <summary> - Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets. - </summary> - <value> - The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets. - </value> - <remarks> - <para> - The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.UdpAppender.Client"> - <summary> - Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient"/>. - </summary> - <value> - The underlying <see cref="T:System.Net.Sockets.UdpClient"/>. - </value> - <remarks> - <see cref="T:log4net.Appender.UdpAppender"/> creates a <see cref="T:System.Net.Sockets.UdpClient"/> to send logging events - over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender"/> can use this - property to get or set this <see cref="T:System.Net.Sockets.UdpClient"/>. Use the underlying <see cref="T:System.Net.Sockets.UdpClient"/> - returned from <see cref="P:log4net.Appender.UdpAppender.Client"/> if you require access beyond that which - <see cref="T:log4net.Appender.UdpAppender"/> provides. - </remarks> - </member> - <member name="P:log4net.Appender.UdpAppender.RemoteEndPoint"> - <summary> - Gets or sets the cached remote endpoint to which the logging events should be sent. - </summary> - <value> - The cached remote endpoint to which the logging events will be sent. - </value> - <remarks> - The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method will initialize the remote endpoint - with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/> - properties. - </remarks> - </member> - <member name="P:log4net.Appender.UdpAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort"> - <summary> - Syslog port 514 - </summary> - </member> - <member name="M:log4net.Appender.RemoteSyslogAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class. - </summary> - <remarks> - This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class is set up to write - to a remote syslog daemon. - </remarks> - </member> - <member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)"> - <summary> - Add a mapping of level to severity - </summary> - <param name="mapping">The mapping to add</param> - <remarks> - <para> - Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method. - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - Writes the event to a remote syslog daemon. - </para> - <para> - The format of the output will depend on the appender's layout. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions"> - <summary> - Initialize the options for this appender - </summary> - <remarks> - <para> - Initialize the level to syslog severity mappings set on this appender. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)"> - <summary> - Translates a log4net level to a syslog severity. - </summary> - <param name="level">A log4net level.</param> - <returns>A syslog severity.</returns> - <remarks> - <para> - Translates a log4net level to a syslog severity. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)"> - <summary> - Generate a syslog priority. - </summary> - <param name="facility">The syslog facility.</param> - <param name="severity">The syslog severity.</param> - <returns>A syslog priority.</returns> - <remarks> - <para> - Generate a syslog priority. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.m_facility"> - <summary> - The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>. - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.m_identity"> - <summary> - The message identity - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping"> - <summary> - Mapping from level object to syslog severity - </summary> - </member> - <member name="P:log4net.Appender.RemoteSyslogAppender.Identity"> - <summary> - Message identity - </summary> - <remarks> - <para> - An identifier is specified with each log message. This can be specified - by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know - as the tag) must not contain white space. The default value for the - identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>). - </para> - </remarks> - </member> - <member name="P:log4net.Appender.RemoteSyslogAppender.Facility"> - <summary> - Syslog facility - </summary> - <remarks> - Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of - facilities is predefined and cannot be extended. The default value - is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>. - </remarks> - </member> - <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity"> - <summary> - syslog severities - </summary> - <remarks> - <para> - The syslog severities. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency"> - <summary> - system is unusable - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert"> - <summary> - action must be taken immediately - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical"> - <summary> - critical conditions - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error"> - <summary> - error conditions - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning"> - <summary> - warning conditions - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice"> - <summary> - normal but significant condition - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational"> - <summary> - informational - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug"> - <summary> - debug-level messages - </summary> - </member> - <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"> - <summary> - syslog facilities - </summary> - <remarks> - <para> - The syslog facilities - </para> - </remarks> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel"> - <summary> - kernel messages - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"> - <summary> - random user-level messages - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail"> - <summary> - mail system - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons"> - <summary> - system daemons - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization"> - <summary> - security/authorization messages - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog"> - <summary> - messages generated internally by syslogd - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer"> - <summary> - line printer subsystem - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News"> - <summary> - network news subsystem - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp"> - <summary> - UUCP subsystem - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock"> - <summary> - clock (cron/at) daemon - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2"> - <summary> - security/authorization messages (private) - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp"> - <summary> - ftp daemon - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp"> - <summary> - NTP subsystem - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit"> - <summary> - log audit - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert"> - <summary> - log alert - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2"> - <summary> - clock daemon - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6"> - <summary> - reserved for local use - </summary> - </member> - <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7"> - <summary> - reserved for local use - </summary> - </member> - <member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"> - <summary> - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - </summary> - <remarks> - <para> - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity"> - <summary> - The mapped syslog severity for the specified level - </summary> - <remarks> - <para> - Required property. - The mapped syslog severity for the specified level - </para> - </remarks> - </member> - <member name="T:log4net.Appender.RemotingAppender"> - <summary> - Delivers logging events to a remote logging sink. - </summary> - <remarks> - <para> - This Appender is designed to deliver events to a remote sink. - That is any object that implements the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/> - interface. It delivers the events using .NET remoting. The - object to deliver events to is specified by setting the - appenders <see cref="P:log4net.Appender.RemotingAppender.Sink"/> property.</para> - <para> - The RemotingAppender buffers events before sending them. This allows it to - make more efficient use of the remoting infrastructure.</para> - <para> - Once the buffer is full the events are still not sent immediately. - They are scheduled to be sent using a pool thread. The effect is that - the send occurs asynchronously. This is very important for a - number of non obvious reasons. The remoting infrastructure will - flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>), - if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the - remoting boundary. If the server is not contactable then - the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/> - objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from - having side effects on the calling application the remoting call must be made - from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/> - thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then - the events will block in the thread pool manager until a thread is available.</para> - <para> - Because the events are sent asynchronously using pool threads it is possible to close - this appender before all the queued events have been sent. - When closing the appender attempts to wait until all the queued events have been sent, but - this will timeout after 30 seconds regardless.</para> - <para> - If this appender is being closed because the <see cref="F:System.AppDomain.ProcessExit"/> - event has fired it may not be possible to send all the queued events. During process - exit the runtime limits the time that a <see cref="F:System.AppDomain.ProcessExit"/> - event handler is allowed to run for. If the runtime terminates the threads before - the queued events have been sent then they will be lost. To ensure that all events - are sent the appender must be closed before the application exits. See - <see cref="M:log4net.Core.LoggerManager.Shutdown"/> for details on how to shutdown - log4net programmatically.</para> - </remarks> - <seealso cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - <author>Daniel Cazzulino</author> - </member> - <member name="M:log4net.Appender.RemotingAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.RemotingAppender"/> class. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RemotingAppender.ActivateOptions"> - <summary> - Initialize the appender based on the options set - </summary> - <remarks> - <para> - This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object - activation scheme. The <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> method must - be called on this object after the configuration properties have - been set. Until <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> is called this - object is in an undefined state and must not be used. - </para> - <para> - If any of the configuration properties are modified then - <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> must be called again. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RemotingAppender.SendBuffer(log4net.Core.LoggingEvent[])"> - <summary> - Send the contents of the buffer to the remote sink. - </summary> - <remarks> - The events are not sent immediately. They are scheduled to be sent - using a pool thread. The effect is that the send occurs asynchronously. - This is very important for a number of non obvious reasons. The remoting - infrastructure will flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>), - if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the - remoting boundary. If the server is not contactable then - the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/> - objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from - having side effects on the calling application the remoting call must be made - from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/> - thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then - the events will block in the thread pool manager until a thread is available. - </remarks> - <param name="events">The events to send.</param> - </member> - <member name="M:log4net.Appender.RemotingAppender.OnClose"> - <summary> - Override base class close. - </summary> - <remarks> - <para> - This method waits while there are queued work items. The events are - sent asynchronously using <see cref="T:System.Threading.ThreadPool"/> work items. These items - will be sent once a thread pool thread is available to send them, therefore - it is possible to close the appender before all the queued events have been - sent.</para> - <para> - This method attempts to wait until all the queued events have been sent, but this - method will timeout after 30 seconds regardless.</para> - <para> - If the appender is being closed because the <see cref="F:System.AppDomain.ProcessExit"/> - event has fired it may not be possible to send all the queued events. During process - exit the runtime limits the time that a <see cref="F:System.AppDomain.ProcessExit"/> - event handler is allowed to run for.</para> - </remarks> - </member> - <member name="M:log4net.Appender.RemotingAppender.BeginAsyncSend"> - <summary> - A work item is being queued into the thread pool - </summary> - </member> - <member name="M:log4net.Appender.RemotingAppender.EndAsyncSend"> - <summary> - A work item from the thread pool has completed - </summary> - </member> - <member name="M:log4net.Appender.RemotingAppender.SendBufferCallback(System.Object)"> - <summary> - Send the contents of the buffer to the remote sink. - </summary> - <remarks> - This method is designed to be used with the <see cref="T:System.Threading.ThreadPool"/>. - This method expects to be passed an array of <see cref="T:log4net.Core.LoggingEvent"/> - objects in the state param. - </remarks> - <param name="state">the logging events to send</param> - </member> - <member name="F:log4net.Appender.RemotingAppender.m_sinkUrl"> - <summary> - The URL of the remote sink. - </summary> - </member> - <member name="F:log4net.Appender.RemotingAppender.m_sinkObj"> - <summary> - The local proxy (.NET remoting) for the remote logging sink. - </summary> - </member> - <member name="F:log4net.Appender.RemotingAppender.m_queuedCallbackCount"> - <summary> - The number of queued callbacks currently waiting or executing - </summary> - </member> - <member name="F:log4net.Appender.RemotingAppender.m_workQueueEmptyEvent"> - <summary> - Event used to signal when there are no queued work items - </summary> - <remarks> - This event is set when there are no queued work items. In this - state it is safe to close the appender. - </remarks> - </member> - <member name="P:log4net.Appender.RemotingAppender.Sink"> - <summary> - Gets or sets the URL of the well-known object that will accept - the logging events. - </summary> - <value> - The well-known URL of the remote sink. - </value> - <remarks> - <para> - The URL of the remoting sink that will accept logging events. - The sink must implement the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/> - interface. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"> - <summary> - Interface used to deliver <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink. - </summary> - <remarks> - This interface must be implemented by a remoting sink - if the <see cref="T:log4net.Appender.RemotingAppender"/> is to be used - to deliver logging events to the sink. - </remarks> - </member> - <member name="M:log4net.Appender.RemotingAppender.IRemoteLoggingSink.LogEvents(log4net.Core.LoggingEvent[])"> - <summary> - Delivers logging events to the remote sink - </summary> - <param name="events">Array of events to log.</param> - <remarks> - <para> - Delivers logging events to the remote sink - </para> - </remarks> - </member> - <member name="T:log4net.Appender.RollingFileAppender"> - <summary> - Appender that rolls log files based on size or date or both. - </summary> - <remarks> - <para> - RollingFileAppender can roll log files based on size or date or both - depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property. - When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled - once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>. - When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled - once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property - is crossed. - When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be - rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property - is crossed, but within a date boundary the file will also be rolled - once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>. - When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when - the appender is configured. This effectively means that the log file can be - rolled once per program execution. - </para> - <para> - A of few additional optional features have been added: - <list type="bullet"> - <item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item> - <item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item> - <item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item> - </list> - </para> - - <note> - <para> - For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> - greater than zero is highly recommended, otherwise all the backup files need - to be renamed each time a new backup is created. - </para> - <para> - When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> - to <see langword="true"/> will reduce the number of file renamings to few or none. - </para> - </note> - - <note type="caution"> - <para> - Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing - the log file directory of backup files will cause unexpected and unwanted side effects. - </para> - </note> - - <para> - If Date/Time based rolling is enabled this appender will attempt to roll existing files - in the directory without a Date/Time tag based on the last write date of the base log file. - The appender only rolls the log file when a message is logged. If Date/Time based rolling - is enabled then the appender will not roll the log file at the Date/Time boundary but - at the point when the next message is logged after the boundary has been crossed. - </para> - - <para> - The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and - has the same behavior when opening the log file. - The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> - is called. This will typically be during configuration. - If the file cannot be opened for writing the appender will attempt - to open the file again each time a message is logged to the appender. - If the file cannot be opened for writing when a message is logged then - the message will be discarded by this appender. - </para> - <para> - When rolling a backup file necessitates deleting an older backup file the - file to be deleted is moved to a temporary name before being deleted. - </para> - - <note type="caution"> - <para> - A maximum number of backup files when rolling on date/time boundaries is not supported. - </para> - </note> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - <author>Aspi Havewala</author> - <author>Douglas de la Torre</author> - <author>Edward Smit</author> - </member> - <member name="M:log4net.Appender.RollingFileAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender"/> class. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)"> - <summary> - Sets the quiet writer being used. - </summary> - <remarks> - This method can be overridden by sub classes. - </remarks> - <param name="writer">the writer to set</param> - </member> - <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - Write out a logging event. - </summary> - <param name="loggingEvent">the event to write to file.</param> - <remarks> - <para> - Handles append time behavior for RollingFileAppender. This checks - if a roll over either by date (checked first) or time (checked second) - is need and then appends to the file last. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])"> - <summary> - Write out an array of logging events. - </summary> - <param name="loggingEvents">the events to write to file.</param> - <remarks> - <para> - Handles append time behavior for RollingFileAppender. This checks - if a roll over either by date (checked first) or time (checked second) - is need and then appends to the file last. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend"> - <summary> - Performs any required rolling before outputting the next event - </summary> - <remarks> - <para> - Handles append time behavior for RollingFileAppender. This checks - if a roll over either by date (checked first) or time (checked second) - is need and then appends to the file last. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)"> - <summary> - Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> - is false then the fully qualified name is determined and used. - </summary> - <param name="fileName">the name of the file to open</param> - <param name="append">true to append to existing file</param> - <remarks> - <para>This method will ensure that the directory structure - for the <paramref name="fileName"/> specified exists.</para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)"> - <summary> - Get the current output file name - </summary> - <param name="fileName">the base file name</param> - <returns>the output file name</returns> - <remarks> - The output file name is based on the base fileName specified. - If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output - file name is the same as the base file passed in. Otherwise - the output file depends on the date pattern, on the count - direction or both. - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups"> - <summary> - Determines curSizeRollBackups (only within the current roll point) - </summary> - </member> - <member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)"> - <summary> - Generates a wildcard pattern that can be used to find all files - that are similar to the base file name. - </summary> - <param name="baseFileName"></param> - <returns></returns> - </member> - <member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)"> - <summary> - Builds a list of filenames for all files matching the base filename plus a file - pattern. - </summary> - <param name="baseFilePath"></param> - <returns></returns> - </member> - <member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing"> - <summary> - Initiates a roll over if needed for crossing a date boundary since the last run. - </summary> - </member> - <member name="M:log4net.Appender.RollingFileAppender.ExistingInit"> - <summary> - Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>. - </summary> - <remarks> - <para> - Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>. - The following is done - <list type="bullet"> - <item>determine curSizeRollBackups (only within the current roll point)</item> - <item>initiates a roll over if needed for crossing a date boundary since the last run.</item> - </list> - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)"> - <summary> - Does the work of bumping the 'current' file counter higher - to the highest count when an incremental file name is seen. - The highest count is either the first file (when count direction - is greater than 0) or the last file (when count direction less than 0). - In either case, we want to know the highest count that is present. - </summary> - <param name="baseFile"></param> - <param name="curFileName"></param> - </member> - <member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)"> - <summary> - Takes a list of files and a base file name, and looks for - 'incremented' versions of the base file. Bumps the max - count up to the highest count seen. - </summary> - <param name="baseFile"></param> - <param name="arrayFiles"></param> - </member> - <member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)"> - <summary> - Calculates the RollPoint for the datePattern supplied. - </summary> - <param name="datePattern">the date pattern to calculate the check period for</param> - <returns>The RollPoint that is most accurate for the date pattern supplied</returns> - <remarks> - Essentially the date pattern is examined to determine what the - most suitable roll point is. The roll point chosen is the roll point - with the smallest period that can be detected using the date pattern - supplied. i.e. if the date pattern only outputs the year, month, day - and hour then the smallest roll point that can be detected would be - and hourly roll point as minutes could not be detected. - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.ActivateOptions"> - <summary> - Initialize the appender based on the options set - </summary> - <remarks> - <para> - This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object - activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must - be called on this object after the configuration properties have - been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this - object is in an undefined state and must not be used. - </para> - <para> - If any of the configuration properties are modified then - <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again. - </para> - <para> - Sets initial conditions including date/time roll over information, first check, - scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize - the current number of backups. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)"> - <summary> - Rollover the file(s) to date/time tagged file(s). - </summary> - <param name="fileIsOpen">set to true if the file to be rolled is currently open</param> - <remarks> - <para> - Rollover the file(s) to date/time tagged file(s). - Resets curSizeRollBackups. - If fileIsOpen is set then the new file is opened (through SafeOpenFile). - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)"> - <summary> - Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. - </summary> - <param name="fromFile">Name of existing file to roll.</param> - <param name="toFile">New name for file.</param> - <remarks> - <para> - Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It - also checks for existence of target file and deletes if it does. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)"> - <summary> - Test if a file exists at a specified path - </summary> - <param name="path">the path to the file</param> - <returns>true if the file exists</returns> - <remarks> - <para> - Test if a file exists at a specified path - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)"> - <summary> - Deletes the specified file if it exists. - </summary> - <param name="fileName">The file to delete.</param> - <remarks> - <para> - Delete a file if is exists. - The file is first moved to a new filename then deleted. - This allows the file to be removed even when it cannot - be deleted, but it still can be moved. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.RollOverSize"> - <summary> - Implements file roll base on file size. - </summary> - <remarks> - <para> - If the maximum number of size based backups is reached - (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest - file is deleted -- its index determined by the sign of countDirection. - If <c>countDirection</c> < 0, then files - {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>} - are renamed to {<c>File.2</c>, ..., - <c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is - renamed <c>File.1</c> and closed. - </para> - <para> - A new file is created to receive further log output. - </para> - <para> - If <c>maxSizeRollBackups</c> is equal to zero, then the - <c>File</c> is truncated with no backup files created. - </para> - <para> - If <c>maxSizeRollBackups</c> < 0, then <c>File</c> is - renamed if needed and no files are deleted. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)"> - <summary> - Implements file roll. - </summary> - <param name="baseFileName">the base name to rename</param> - <remarks> - <para> - If the maximum number of size based backups is reached - (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest - file is deleted -- its index determined by the sign of countDirection. - If <c>countDirection</c> < 0, then files - {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>} - are renamed to {<c>File.2</c>, ..., - <c>File.curSizeRollBackups</c>}. - </para> - <para> - If <c>maxSizeRollBackups</c> is equal to zero, then the - <c>File</c> is truncated with no backup files created. - </para> - <para> - If <c>maxSizeRollBackups</c> < 0, then <c>File</c> is - renamed if needed and no files are deleted. - </para> - <para> - This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)"> - <summary> - Get the start time of the next window for the current rollpoint - </summary> - <param name="currentDateTime">the current date</param> - <param name="rollPoint">the type of roll point we are working with</param> - <returns>the start time for the next roll point an interval after the currentDateTime date</returns> - <remarks> - <para> - Returns the date of the next roll point after the currentDateTime date passed to the method. - </para> - <para> - The basic strategy is to subtract the time parts that are less significant - than the rollpoint from the current time. This should roll the time back to - the start of the time window for the current rollpoint. Then we add 1 window - worth of time and get the start time of the next window for the rollpoint. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_dateTime"> - <summary> - This object supplies the current date/time. Allows test code to plug in - a method to control this class when testing date/time based rolling. - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_datePattern"> - <summary> - The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c> - meaning daily rollover. - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename"> - <summary> - The actual formatted filename that is currently being written to - or will be the file transferred to on roll over - (based on staticLogFileName). - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_nextCheck"> - <summary> - The timestamp when we shall next recompute the filename. - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_now"> - <summary> - Holds date of last roll over - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_rollPoint"> - <summary> - The type of rolling done - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize"> - <summary> - The default maximum file size is 10MB - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups"> - <summary> - There is zero backup files by default - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups"> - <summary> - How many sized based backups have been made so far - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_countDirection"> - <summary> - The rolling file count direction. - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle"> - <summary> - The rolling mode used in this appender. - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_rollDate"> - <summary> - Cache flag set if we are rolling by date. - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_rollSize"> - <summary> - Cache flag set if we are rolling by size. - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName"> - <summary> - Value indicating whether to always log to the same file. - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.m_baseFileName"> - <summary> - FileName provided in configuration. Used for rolling properly - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.s_date1970"> - <summary> - The 1st of January 1970 in UTC - </summary> - </member> - <member name="P:log4net.Appender.RollingFileAppender.DatePattern"> - <summary> - Gets or sets the date pattern to be used for generating file names - when rolling over on date. - </summary> - <value> - The date pattern to be used for generating file names when rolling - over on date. - </value> - <remarks> - <para> - Takes a string in the same format as expected by - <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/>. - </para> - <para> - This property determines the rollover schedule when rolling over - on date. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"> - <summary> - Gets or sets the maximum number of backup files that are kept before - the oldest is erased. - </summary> - <value> - The maximum number of backup files that are kept before the oldest is - erased. - </value> - <remarks> - <para> - If set to zero, then there will be no backup files and the log file - will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>. - </para> - <para> - If a negative number is supplied then no deletions will be made. Note - that this could result in very slow performance as a large number of - files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used. - </para> - <para> - The maximum applies to <b>each</b> time based group of files and - <b>not</b> the total. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.RollingFileAppender.MaxFileSize"> - <summary> - Gets or sets the maximum size that the output file is allowed to reach - before being rolled over to backup files. - </summary> - <value> - The maximum size in bytes that the output file is allowed to reach before being - rolled over to backup files. - </value> - <remarks> - <para> - This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except - that it is required for differentiating the setter taking a - <see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/> - argument. - </para> - <para> - The default maximum file size is 10MB (10*1024*1024). - </para> - </remarks> - </member> - <member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize"> - <summary> - Gets or sets the maximum size that the output file is allowed to reach - before being rolled over to backup files. - </summary> - <value> - The maximum size that the output file is allowed to reach before being - rolled over to backup files. - </value> - <remarks> - <para> - This property allows you to specify the maximum size with the - suffixes "KB", "MB" or "GB" so that the size is interpreted being - expressed respectively in kilobytes, megabytes or gigabytes. - </para> - <para> - For example, the value "10KB" will be interpreted as 10240 bytes. - </para> - <para> - The default maximum file size is 10MB. - </para> - <para> - If you have the option to set the maximum file size programmatically - consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this - allows you to set the size in bytes as a <see cref="T:System.Int64"/>. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.RollingFileAppender.CountDirection"> - <summary> - Gets or sets the rolling file count direction. - </summary> - <value> - The rolling file count direction. - </value> - <remarks> - <para> - Indicates if the current file is the lowest numbered file or the - highest numbered file. - </para> - <para> - By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> < 0), - i.e. log.1 is most recent, log.5 is the 5th backup, etc... - </para> - <para> - <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> >= 0 does the opposite i.e. - log.1 is the first backup made, log.5 is the 5th backup made, etc. - For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> >= 0 to reduce - rollover costs. - </para> - <para>The default file count direction is -1.</para> - </remarks> - </member> - <member name="P:log4net.Appender.RollingFileAppender.RollingStyle"> - <summary> - Gets or sets the rolling style. - </summary> - <value>The rolling style.</value> - <remarks> - <para> - The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/>. - </para> - <para> - When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's - <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise - the appender would append to a single file rather than rolling - the file each time it is opened. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName"> - <summary> - Gets or sets a value indicating whether to always log to - the same file. - </summary> - <value> - <c>true</c> if always should be logged to the same file, otherwise <c>false</c>. - </value> - <remarks> - <para> - By default file.log is always the current file. Optionally - file.log.yyyy-mm-dd for current formatted datePattern can by the currently - logging file (or file.log.curSizeRollBackup or even - file.log.yyyy-mm-dd.curSizeRollBackup). - </para> - <para> - This will make time based rollovers with a large number of backups - much faster as the appender it won't have to rename all the backups! - </para> - </remarks> - </member> - <member name="T:log4net.Appender.RollingFileAppender.RollingMode"> - <summary> - Style of rolling to use - </summary> - <remarks> - <para> - Style of rolling to use - </para> - </remarks> - </member> - <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once"> - <summary> - Roll files once per program execution - </summary> - <remarks> - <para> - Roll files once per program execution. - Well really once each time this appender is - configured. - </para> - <para> - Setting this option also sets <c>AppendToFile</c> to - <c>false</c> on the <c>RollingFileAppender</c>, otherwise - this appender would just be a normal file appender. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size"> - <summary> - Roll files based only on the size of the file - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date"> - <summary> - Roll files based only on the date - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"> - <summary> - Roll files based on both the size and date of the file - </summary> - </member> - <member name="T:log4net.Appender.RollingFileAppender.RollPoint"> - <summary> - The code assumes that the following 'time' constants are in a increasing sequence. - </summary> - <remarks> - <para> - The code assumes that the following 'time' constants are in a increasing sequence. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint"> - <summary> - Roll the log not based on the date - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute"> - <summary> - Roll the log for each minute - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour"> - <summary> - Roll the log for each hour - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay"> - <summary> - Roll the log twice a day (midday and midnight) - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay"> - <summary> - Roll the log each day (midnight) - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek"> - <summary> - Roll the log each week - </summary> - </member> - <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth"> - <summary> - Roll the log each month - </summary> - </member> - <member name="T:log4net.Appender.RollingFileAppender.IDateTime"> - <summary> - This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>. - </summary> - <remarks> - This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>. - Used primarily to allow test classes to plug themselves in so they can - supply test date/times. - </remarks> - </member> - <member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now"> - <summary> - Gets the <i>current</i> time. - </summary> - <value>The <i>current</i> time.</value> - <remarks> - <para> - Gets the <i>current</i> time. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.RollingFileAppender.DefaultDateTime"> - <summary> - Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time. - </summary> - </member> - <member name="P:log4net.Appender.RollingFileAppender.DefaultDateTime.Now"> - <summary> - Gets the <b>current</b> time. - </summary> - <value>The <b>current</b> time.</value> - <remarks> - <para> - Gets the <b>current</b> time. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.SmtpAppender"> - <summary> - Send an e-mail when a specific logging event occurs, typically on errors - or fatal errors. - </summary> - <remarks> - <para> - The number of logging events delivered in this e-mail depend on - the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The - <see cref="T:log4net.Appender.SmtpAppender"/> keeps only the last - <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its - cyclic buffer. This keeps memory requirements at a reasonable level while - still delivering useful application context. - </para> - <note type="caution"> - Authentication and setting the server Port are only available on the MS .NET 1.1 runtime. - For these features to be enabled you need to ensure that you are using a version of - the log4net assembly that is built against the MS .NET 1.1 framework and that you are - running the your application on the MS .NET 1.1 runtime. On all other platforms only sending - unauthenticated messages to a server listening on port 25 (the default) is supported. - </note> - <para> - Authentication is supported by setting the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property to - either <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> or <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>. - If using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> authentication then the <see cref="P:log4net.Appender.SmtpAppender.Username"/> - and <see cref="P:log4net.Appender.SmtpAppender.Password"/> properties must also be set. - </para> - <para> - To set the SMTP server port use the <see cref="P:log4net.Appender.SmtpAppender.Port"/> property. The default port is 25. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Appender.SmtpAppender.#ctor"> - <summary> - Default constructor - </summary> - <remarks> - <para> - Default constructor - </para> - </remarks> - </member> - <member name="M:log4net.Appender.SmtpAppender.SendBuffer(log4net.Core.LoggingEvent[])"> - <summary> - Sends the contents of the cyclic buffer as an e-mail message. - </summary> - <param name="events">The logging events to send.</param> - </member> - <member name="M:log4net.Appender.SmtpAppender.SendEmail(System.String)"> - <summary> - Send the email message - </summary> - <param name="messageBody">the body text to include in the mail</param> - </member> - <member name="P:log4net.Appender.SmtpAppender.To"> - <summary> - Gets or sets a semicolon-delimited list of recipient e-mail addresses. - </summary> - <value> - A semicolon-delimited list of e-mail addresses. - </value> - <remarks> - <para> - A semicolon-delimited list of recipient e-mail addresses. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpAppender.From"> - <summary> - Gets or sets the e-mail address of the sender. - </summary> - <value> - The e-mail address of the sender. - </value> - <remarks> - <para> - The e-mail address of the sender. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpAppender.Subject"> - <summary> - Gets or sets the subject line of the e-mail message. - </summary> - <value> - The subject line of the e-mail message. - </value> - <remarks> - <para> - The subject line of the e-mail message. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpAppender.SmtpHost"> - <summary> - Gets or sets the name of the SMTP relay mail server to use to send - the e-mail messages. - </summary> - <value> - The name of the e-mail relay server. If SmtpServer is not set, the - name of the local SMTP server is used. - </value> - <remarks> - <para> - The name of the e-mail relay server. If SmtpServer is not set, the - name of the local SMTP server is used. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpAppender.LocationInfo"> - <summary> - Obsolete - </summary> - <remarks> - Use the BufferingAppenderSkeleton Fix methods instead - </remarks> - <remarks> - <para> - Obsolete property. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpAppender.Authentication"> - <summary> - The mode to use to authentication with the SMTP server - </summary> - <remarks> - <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note> - <para> - Valid Authentication mode values are: <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>, - <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, and <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>. - The default value is <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>. When using - <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> you must specify the <see cref="P:log4net.Appender.SmtpAppender.Username"/> - and <see cref="P:log4net.Appender.SmtpAppender.Password"/> to use to authenticate. - When using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/> the Windows credentials for the current - thread, if impersonating, or the process will be used to authenticate. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpAppender.Username"> - <summary> - The username to use to authenticate with the SMTP server - </summary> - <remarks> - <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note> - <para> - A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when - <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, - otherwise the username will be ignored. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpAppender.Password"> - <summary> - The password to use to authenticate with the SMTP server - </summary> - <remarks> - <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note> - <para> - A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when - <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, - otherwise the password will be ignored. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpAppender.Port"> - <summary> - The port on which the SMTP server is listening - </summary> - <remarks> - <note type="caution">Server Port is only available on the MS .NET 1.1 runtime.</note> - <para> - The port on which the SMTP server is listening. The default - port is <c>25</c>. The Port can only be changed when running on - the MS .NET 1.1 runtime. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpAppender.Priority"> - <summary> - Gets or sets the priority of the e-mail message - </summary> - <value> - One of the <see cref="T:System.Web.Mail.MailPriority"/> values. - </value> - <remarks> - <para> - Sets the priority of the e-mails generated by this - appender. The default priority is <see cref="F:System.Web.Mail.MailPriority.Normal"/>. - </para> - <para> - If you are using this appender to report errors then - you may want to set the priority to <see cref="F:System.Web.Mail.MailPriority.High"/>. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.SmtpAppender.SmtpAuthentication"> - <summary> - Values for the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property. - </summary> - <remarks> - <para> - SMTP authentication modes. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"> - <summary> - No authentication - </summary> - </member> - <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"> - <summary> - Basic authentication. - </summary> - <remarks> - Requires a username and password to be supplied - </remarks> - </member> - <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"> - <summary> - Integrated authentication - </summary> - <remarks> - Uses the Windows credentials from the current thread or process to authenticate. - </remarks> - </member> - <member name="T:log4net.Appender.SmtpPickupDirAppender"> - <summary> - Send an email when a specific logging event occurs, typically on errors - or fatal errors. Rather than sending via smtp it writes a file into the - directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such - as the IIS SMTP agent to manage sending the messages. - </summary> - <remarks> - <para> - The configuration for this appender is identical to that of the <c>SMTPAppender</c>, - except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify - <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. - </para> - <para> - The number of logging events delivered in this e-mail depend on - the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The - <see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last - <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its - cyclic buffer. This keeps memory requirements at a reasonable level while - still delivering useful application context. - </para> - </remarks> - <author>Niall Daley</author> - <author>Nicko Cadell</author> - </member> - <member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor"> - <summary> - Default constructor - </summary> - <remarks> - <para> - Default constructor - </para> - </remarks> - </member> - <member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])"> - <summary> - Sends the contents of the cyclic buffer as an e-mail message. - </summary> - <param name="events">The logging events to send.</param> - <remarks> - <para> - Sends the contents of the cyclic buffer as an e-mail message. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"> - <summary> - Activate the options on this appender. - </summary> - <remarks> - <para> - This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object - activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must - be called on this object after the configuration properties have - been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this - object is in an undefined state and must not be used. - </para> - <para> - If any of the configuration properties are modified then - <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)"> - <summary> - Convert a path into a fully qualified path. - </summary> - <param name="path">The path to convert.</param> - <returns>The fully qualified path.</returns> - <remarks> - <para> - Converts the path specified to a fully - qualified path. If the path is relative it is - taken as relative from the application base - directory. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext"> - <summary> - The security context to use for privileged calls - </summary> - </member> - <member name="P:log4net.Appender.SmtpPickupDirAppender.To"> - <summary> - Gets or sets a semicolon-delimited list of recipient e-mail addresses. - </summary> - <value> - A semicolon-delimited list of e-mail addresses. - </value> - <remarks> - <para> - A semicolon-delimited list of e-mail addresses. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpPickupDirAppender.From"> - <summary> - Gets or sets the e-mail address of the sender. - </summary> - <value> - The e-mail address of the sender. - </value> - <remarks> - <para> - The e-mail address of the sender. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpPickupDirAppender.Subject"> - <summary> - Gets or sets the subject line of the e-mail message. - </summary> - <value> - The subject line of the e-mail message. - </value> - <remarks> - <para> - The subject line of the e-mail message. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"> - <summary> - Gets or sets the path to write the messages to. - </summary> - <remarks> - <para> - Gets or sets the path to write the messages to. This should be the same - as that used by the agent sending the messages. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"> - <summary> - Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory. - </summary> - <value> - The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory. - </value> - <remarks> - <para> - Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender - the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the - security context to use. The default behavior is to use the security context - of the current thread. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.TelnetAppender"> - <summary> - Appender that allows clients to connect via Telnet to receive log messages - </summary> - <remarks> - <para> - The TelnetAppender accepts socket connections and streams logging messages - back to the client. - The output is provided in a telnet-friendly way so that a log can be monitored - over a TCP/IP socket. - This allows simple remote monitoring of application logging. - </para> - <para> - The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port). - </para> - </remarks> - <author>Keith Long</author> - <author>Nicko Cadell</author> - </member> - <member name="M:log4net.Appender.TelnetAppender.#ctor"> - <summary> - Default constructor - </summary> - <remarks> - <para> - Default constructor - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TelnetAppender.OnClose"> - <summary> - Overrides the parent method to close the socket handler - </summary> - <remarks> - <para> - Closes all the outstanding connections. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TelnetAppender.ActivateOptions"> - <summary> - Initialize the appender based on the options set. - </summary> - <remarks> - <para> - This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object - activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must - be called on this object after the configuration properties have - been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this - object is in an undefined state and must not be used. - </para> - <para> - If any of the configuration properties are modified then - <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again. - </para> - <para> - Create the socket handler and wait for connections - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - Writes the logging event to each connected client. - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - Writes the logging event to each connected client. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.TelnetAppender.Port"> - <summary> - Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections. - </summary> - <value> - An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/> - indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections. - </value> - <remarks> - <para> - The default value is 23 (the telnet port). - </para> - </remarks> - <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> - or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception> - </member> - <member name="P:log4net.Appender.TelnetAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.TelnetAppender.SocketHandler"> - <summary> - Helper class to manage connected clients - </summary> - <remarks> - <para> - The SocketHandler class is used to accept connections from - clients. It is threaded so that clients can connect/disconnect - asynchronously. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)"> - <summary> - Opens a new server port on <paramref ref="port"/> - </summary> - <param name="port">the local port to listen on for connections</param> - <remarks> - <para> - Creates a socket handler on the specified local server port. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)"> - <summary> - Sends a string message to each of the connected clients - </summary> - <param name="message">the text to send</param> - <remarks> - <para> - Sends a string message to each of the connected clients - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)"> - <summary> - Add a client to the internal clients list - </summary> - <param name="client">client to add</param> - </member> - <member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)"> - <summary> - Remove a client from the internal clients list - </summary> - <param name="client">client to remove</param> - </member> - <member name="M:log4net.Appender.TelnetAppender.SocketHandler.OnConnect(System.IAsyncResult)"> - <summary> - Callback used to accept a connection on the server socket - </summary> - <param name="asyncResult">The result of the asynchronous operation</param> - <remarks> - <para> - On connection adds to the list of connections - if there are two many open connections you will be disconnected - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose"> - <summary> - Close all network connections - </summary> - <remarks> - <para> - Make sure we close all network connections - </para> - </remarks> - </member> - <member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections"> - <summary> - Test if this handler has active connections - </summary> - <value> - <c>true</c> if this handler has active connections - </value> - <remarks> - <para> - This property will be <c>true</c> while this handler has - active connections, that is at least one connection that - the handler will attempt to send a message to. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"> - <summary> - Class that represents a client connected to this handler - </summary> - <remarks> - <para> - Class that represents a client connected to this handler - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)"> - <summary> - Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/> - </summary> - <param name="socket">the client's socket</param> - <remarks> - <para> - Opens a stream writer on the socket. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)"> - <summary> - Write a string to the client - </summary> - <param name="message">string to send</param> - <remarks> - <para> - Write a string to the client - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose"> - <summary> - Cleanup the clients connection - </summary> - <remarks> - <para> - Close the socket connection. - </para> - </remarks> - </member> - <member name="T:log4net.Appender.TraceAppender"> - <summary> - Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system. - </summary> - <remarks> - <para> - The application configuration file can be used to control what listeners - are actually used. See the MSDN documentation for the - <see cref="T:System.Diagnostics.Trace"/> class for details on configuring the - trace system. - </para> - <para> - Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c> - method. The event's logger name is passed as the value for the category name to the Write method. - </para> - <para> - <b>Compact Framework</b><br/> - The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/> - class for any operation except <c>Assert</c>. When using the Compact Framework this - appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than - the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>. - </para> - </remarks> - <author>Douglas de la Torre</author> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Appender.TraceAppender.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/> - with a specified layout. - </summary> - <param name="layout">The layout to use with this appender.</param> - <remarks> - <para> - Obsolete constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)"> - <summary> - Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system. - </summary> - <param name="loggingEvent">The event to log.</param> - <remarks> - <para> - Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system. - </para> - </remarks> - </member> - <member name="F:log4net.Appender.TraceAppender.m_immediateFlush"> - <summary> - Immediate flush means that the underlying writer or output stream - will be flushed at the end of each append operation. - </summary> - <remarks> - <para> - Immediate flush is slower but ensures that each append request is - actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to - <c>false</c>, then there is a good chance that the last few - logs events are not actually written to persistent media if and - when the application crashes. - </para> - <para> - The default value is <c>true</c>.</para> - </remarks> - </member> - <member name="P:log4net.Appender.TraceAppender.ImmediateFlush"> - <summary> - Gets or sets a value that indicates whether the appender will - flush at the end of each write. - </summary> - <remarks> - <para>The default behavior is to flush at the end of each - write. If the option is set to<c>false</c>, then the underlying - stream can defer writing to physical medium to a later time. - </para> - <para> - Avoiding the flush operation at the end of each append results - in a performance gain of 10 to 20 percent. However, there is safety - trade-off involved in skipping flushing. Indeed, when flushing is - skipped, then it is likely that the last few log events will not - be recorded on disk when the application exits. This is a high - price to pay even for a 20% performance gain. - </para> - </remarks> - </member> - <member name="P:log4net.Appender.TraceAppender.RequiresLayout"> - <summary> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </summary> - <value><c>true</c></value> - <remarks> - <para> - This appender requires a <see cref="N:log4net.Layout"/> to be set. - </para> - </remarks> - </member> - <member name="T:log4net.Config.AliasDomainAttribute"> - <summary> - Assembly level attribute that specifies a domain to alias to this assembly's repository. - </summary> - <remarks> - <para> - <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b> - </para> - <para> - An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>, - however this can be overridden by an assembly loaded before the target assembly. - </para> - <para> - An assembly can alias another assembly's domain to its repository by - specifying this attribute with the name of the target domain. - </para> - <para> - This attribute can only be specified on the assembly and may be used - as many times as necessary to alias all the required domains. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="T:log4net.Config.AliasRepositoryAttribute"> - <summary> - Assembly level attribute that specifies a repository to alias to this assembly's repository. - </summary> - <remarks> - <para> - An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>, - however this can be overridden by an assembly loaded before the target assembly. - </para> - <para> - An assembly can alias another assembly's repository to its repository by - specifying this attribute with the name of the target repository. - </para> - <para> - This attribute can only be specified on the assembly and may be used - as many times as necessary to alias all the required repositories. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with - the specified repository to alias to this assembly's repository. - </summary> - <param name="name">The repository to alias to this assemby's repository.</param> - <remarks> - <para> - Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with - the specified repository to alias to this assembly's repository. - </para> - </remarks> - </member> - <member name="P:log4net.Config.AliasRepositoryAttribute.Name"> - <summary> - Gets or sets the repository to alias to this assemby's repository. - </summary> - <value> - The repository to alias to this assemby's repository. - </value> - <remarks> - <para> - The name of the repository to alias to this assemby's repository. - </para> - </remarks> - </member> - <member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute"/> class with - the specified domain to alias to this assembly's repository. - </summary> - <param name="name">The domain to alias to this assemby's repository.</param> - <remarks> - <para> - Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>. - </para> - </remarks> - </member> - <member name="T:log4net.Config.BasicConfigurator"> - <summary> - Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>. - </summary> - <remarks> - <para> - Allows very simple programmatic configuration of log4net. - </para> - <para> - Only one appender can be configured using this configurator. - The appender is set at the root of the hierarchy and all logging - events will be delivered to that appender. - </para> - <para> - Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore - they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method - be called after the appenders properties have been configured. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Config.BasicConfigurator.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator"/> class. - </summary> - <remarks> - <para> - Uses a private access modifier to prevent instantiation of this class. - </para> - </remarks> - </member> - <member name="M:log4net.Config.BasicConfigurator.Configure"> - <summary> - Initializes the log4net system with a default configuration. - </summary> - <remarks> - <para> - Initializes the log4net logging system using a <see cref="T:log4net.Appender.ConsoleAppender"/> - that will write to <c>Console.Out</c>. The log messages are - formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object - with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/> - layout style. - </para> - </remarks> - </member> - <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender)"> - <summary> - Initializes the log4net system using the specified appender. - </summary> - <param name="appender">The appender to use to log all logging events.</param> - <remarks> - <para> - Initializes the log4net system using the specified appender. - </para> - </remarks> - </member> - <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)"> - <summary> - Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration. - </summary> - <param name="repository">The repository to configure.</param> - <remarks> - <para> - Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/> - that will write to <c>Console.Out</c>. The log messages are - formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object - with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/> - layout style. - </para> - </remarks> - </member> - <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)"> - <summary> - Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender. - </summary> - <param name="repository">The repository to configure.</param> - <param name="appender">The appender to use to log all logging events.</param> - <remarks> - <para> - Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender. - </para> - </remarks> - </member> - <member name="T:log4net.Config.ConfiguratorAttribute"> - <summary> - Base class for all log4net configuration attributes. - </summary> - <remarks> - This is an abstract class that must be extended by - specific configurators. This attribute allows the - configurator to be parameterized by an assembly level - attribute. - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)"> - <summary> - Constructor used by subclasses. - </summary> - <param name="priority">the ordering priority for this configurator</param> - <remarks> - <para> - The <paramref name="priority"/> is used to order the configurator - attributes before they are invoked. Higher priority configurators are executed - before lower priority ones. - </para> - </remarks> - </member> - <member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> - <summary> - Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly. - </summary> - <param name="sourceAssembly">The assembly that this attribute was defined on.</param> - <param name="targetRepository">The repository to configure.</param> - <remarks> - <para> - Abstract method implemented by a subclass. When this method is called - the subclass should configure the <paramref name="targetRepository"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)"> - <summary> - Compare this instance to another ConfiguratorAttribute - </summary> - <param name="obj">the object to compare to</param> - <returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns> - <remarks> - <para> - Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances. - Sorts by priority in descending order. Objects with the same priority are - randomly ordered. - </para> - </remarks> - </member> - <member name="T:log4net.Config.DomainAttribute"> - <summary> - Assembly level attribute that specifies the logging domain for the assembly. - </summary> - <remarks> - <para> - <b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b> - </para> - <para> - Assemblies are mapped to logging domains. Each domain has its own - logging repository. This attribute specified on the assembly controls - the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name - of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> - specifies the type of the repository objects to create for the domain. If - this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified - then the assembly will be part of the default shared logging domain. - </para> - <para> - This attribute can only be specified on the assembly and may only be used - once per assembly. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="T:log4net.Config.RepositoryAttribute"> - <summary> - Assembly level attribute that specifies the logging repository for the assembly. - </summary> - <remarks> - <para> - Assemblies are mapped to logging repository. This attribute specified - on the assembly controls - the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name - of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> - specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object - to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> - is not specified then the assembly will be part of the default shared logging repository. - </para> - <para> - This attribute can only be specified on the assembly and may only be used - once per assembly. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Config.RepositoryAttribute.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)"> - <summary> - Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class - with the name of the repository. - </summary> - <param name="name">The name of the repository.</param> - <remarks> - <para> - Initialize the attribute with the name for the assembly's repository. - </para> - </remarks> - </member> - <member name="P:log4net.Config.RepositoryAttribute.Name"> - <summary> - Gets or sets the name of the logging repository. - </summary> - <value> - The string name to use as the name of the repository associated with this - assembly. - </value> - <remarks> - <para> - This value does not have to be unique. Several assemblies can share the - same repository. They will share the logging configuration of the repository. - </para> - </remarks> - </member> - <member name="P:log4net.Config.RepositoryAttribute.RepositoryType"> - <summary> - Gets or sets the type of repository to create for this assembly. - </summary> - <value> - The type of repository to create for this assembly. - </value> - <remarks> - <para> - The type of the repository to create for the assembly. - The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/> - interface. - </para> - <para> - This will be the type of repository created when - the repository is created. If multiple assemblies reference the - same repository then the repository is only created once using the - <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> of the first assembly to call into the - repository. - </para> - </remarks> - </member> - <member name="M:log4net.Config.DomainAttribute.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class. - </summary> - <remarks> - <para> - Obsolete. Use RepositoryAttribute instead of DomainAttribute. - </para> - </remarks> - </member> - <member name="M:log4net.Config.DomainAttribute.#ctor(System.String)"> - <summary> - Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class - with the name of the domain. - </summary> - <param name="name">The name of the domain.</param> - <remarks> - <para> - Obsolete. Use RepositoryAttribute instead of DomainAttribute. - </para> - </remarks> - </member> - <member name="T:log4net.Config.DOMConfigurator"> - <summary> - Use this class to initialize the log4net environment using an Xml tree. - </summary> - <remarks> - <para> - <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> - </para> - <para> - Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Config.DOMConfigurator.#ctor"> - <summary> - Private constructor - </summary> - </member> - <member name="M:log4net.Config.DOMConfigurator.Configure"> - <summary> - Automatically configures the log4net system based on the - application's configuration settings. - </summary> - <remarks> - <para> - <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> - </para> - Each application has a configuration file. This has the - same name as the application with '.config' appended. - This file is XML and calling this function prompts the - configurator to look in that file for a section called - <c>log4net</c> that contains the configuration data. - </remarks> - </member> - <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository)"> - <summary> - Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings - stored in the application's configuration file. - </summary> - <remarks> - <para> - <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> - </para> - Each application has a configuration file. This has the - same name as the application with '.config' appended. - This file is XML and calling this function prompts the - configurator to look in that file for a section called - <c>log4net</c> that contains the configuration data. - </remarks> - <param name="repository">The repository to configure.</param> - </member> - <member name="M:log4net.Config.DOMConfigurator.Configure(System.Xml.XmlElement)"> - <summary> - Configures log4net using a <c>log4net</c> element - </summary> - <remarks> - <para> - <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> - </para> - Loads the log4net configuration from the XML element - supplied as <paramref name="element"/>. - </remarks> - <param name="element">The element to parse.</param> - </member> - <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)"> - <summary> - Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML - element. - </summary> - <remarks> - <para> - <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> - </para> - Loads the log4net configuration from the XML element - supplied as <paramref name="element"/>. - </remarks> - <param name="repository">The repository to configure.</param> - <param name="element">The element to parse.</param> - </member> - <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)"> - <summary> - Configures log4net using the specified configuration file. - </summary> - <param name="configFile">The XML file to load the configuration from.</param> - <remarks> - <para> - <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> - </para> - <para> - The configuration file must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the log4net configuration data. - </para> - <para> - The log4net configuration file can possible be specified in the application's - configuration file (either <c>MyAppName.exe.config</c> for a - normal application on <c>Web.config</c> for an ASP.NET application). - </para> - <example> - The following example configures log4net using a configuration file, of which the - location is stored in the application's configuration file : - </example> - <code lang="C#"> - using log4net.Config; - using System.IO; - using System.Configuration; - - ... - - DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); - </code> - <para> - In the <c>.config</c> file, the path to the log4net can be specified like this : - </para> - <code lang="XML" escaped="true"> - <configuration> - <appSettings> - <add key="log4net-config-file" value="log.config"/> - </appSettings> - </configuration> - </code> - </remarks> - </member> - <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.Stream)"> - <summary> - Configures log4net using the specified configuration file. - </summary> - <param name="configStream">A stream to load the XML configuration from.</param> - <remarks> - <para> - <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> - </para> - <para> - The configuration data must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the log4net configuration data. - </para> - <para> - Note that this method will NOT close the stream parameter. - </para> - </remarks> - </member> - <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> - <summary> - Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration - file. - </summary> - <param name="repository">The repository to configure.</param> - <param name="configFile">The XML file to load the configuration from.</param> - <remarks> - <para> - <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> - </para> - <para> - The configuration file must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the configuration data. - </para> - <para> - The log4net configuration file can possible be specified in the application's - configuration file (either <c>MyAppName.exe.config</c> for a - normal application on <c>Web.config</c> for an ASP.NET application). - </para> - <example> - The following example configures log4net using a configuration file, of which the - location is stored in the application's configuration file : - </example> - <code lang="C#"> - using log4net.Config; - using System.IO; - using System.Configuration; - - ... - - DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); - </code> - <para> - In the <c>.config</c> file, the path to the log4net can be specified like this : - </para> - <code lang="XML" escaped="true"> - <configuration> - <appSettings> - <add key="log4net-config-file" value="log.config"/> - </appSettings> - </configuration> - </code> - </remarks> - </member> - <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)"> - <summary> - Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration - file. - </summary> - <param name="repository">The repository to configure.</param> - <param name="configStream">The stream to load the XML configuration from.</param> - <remarks> - <para> - <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> - </para> - <para> - The configuration data must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the configuration data. - </para> - <para> - Note that this method will NOT close the stream parameter. - </para> - </remarks> - </member> - <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(System.IO.FileInfo)"> - <summary> - Configures log4net using the file specified, monitors the file for changes - and reloads the configuration if a change is detected. - </summary> - <param name="configFile">The XML file to load the configuration from.</param> - <remarks> - <para> - <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> - </para> - <para> - The configuration file must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the configuration data. - </para> - <para> - The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/> - and depends on the behavior of that class. - </para> - <para> - For more information on how to configure log4net using - a separate configuration file, see <see cref="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)"/>. - </para> - </remarks> - <seealso cref="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)"/> - </member> - <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> - <summary> - Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified, - monitors the file for changes and reloads the configuration if a change - is detected. - </summary> - <param name="repository">The repository to configure.</param> - <param name="configFile">The XML file to load the configuration from.</param> - <remarks> - <para> - <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> - </para> - <para> - The configuration file must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the configuration data. - </para> - <para> - The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/> - and depends on the behavior of that class. - </para> - <para> - For more information on how to configure log4net using - a separate configuration file, see <see cref="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)"/>. - </para> - </remarks> - <seealso cref="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)"/> - </member> - <member name="T:log4net.Config.DOMConfiguratorAttribute"> - <summary> - Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>. - </summary> - <remarks> - <para> - <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b> - </para> - <para> - This attribute may only be used at the assembly scope and can only - be used once per assembly. - </para> - <para> - Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/> - without calling one of the <see cref="M:log4net.Config.XmlConfigurator.Configure"/> - methods. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="T:log4net.Config.XmlConfiguratorAttribute"> - <summary> - Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>. - </summary> - <remarks> - <para> - This attribute may only be used at the assembly scope and can only - be used once per assembly. - </para> - <para> - Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/> - without calling one of the <see cref="M:log4net.Config.XmlConfigurator.Configure"/> - methods. - </para> - <para> - If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> - properties are set the configuration is loaded from the application's .config file. - If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the - <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property - specifies a path to a file to load the config from. The path is relative to the - application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>. - The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name. - The config file must be located in the application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>. - For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to - <c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or - <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties. - </para> - <para> - The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/> - to watch the configuration file for changes. - </para> - <note> - <para> - Log4net will only look for assembly level configuration attributes once. - When using the log4net assembly level attributes to control the configuration - of log4net you must ensure that the first call to any of the - <see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration - attributes. - </para> - <para> - If you cannot guarantee the order in which log4net calls will be made from - different assemblies you must use programmatic configuration instead, i.e. - call the <see cref="M:log4net.Config.XmlConfigurator.Configure"/> method directly. - </para> - </note> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor"> - <summary> - Default constructor - </summary> - <remarks> - <para> - Default constructor - </para> - </remarks> - </member> - <member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> - <summary> - Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly. - </summary> - <param name="sourceAssembly">The assembly that this attribute was defined on.</param> - <param name="targetRepository">The repository to configure.</param> - <remarks> - <para> - Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>. - The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> - class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to - configure it. - </para> - </remarks> - <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="repository"/> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception> - </member> - <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> - <summary> - Attempt to load configuration from the local file system - </summary> - <param name="sourceAssembly">The assembly that this attribute was defined on.</param> - <param name="targetRepository">The repository to configure.</param> - </member> - <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> - <summary> - Configure the specified repository using a <see cref="T:System.IO.FileInfo"/> - </summary> - <param name="targetRepository">The repository to configure.</param> - <param name="configFile">the FileInfo pointing to the config file</param> - </member> - <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> - <summary> - Attempt to load configuration from a URI - </summary> - <param name="sourceAssembly">The assembly that this attribute was defined on.</param> - <param name="targetRepository">The repository to configure.</param> - </member> - <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"> - <summary> - Gets or sets the filename of the configuration file. - </summary> - <value> - The filename of the configuration file. - </value> - <remarks> - <para> - If specified, this is the name of the configuration file to use with - the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the - <b>application base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>). - </para> - <para> - The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>. - </para> - </remarks> - </member> - <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"> - <summary> - Gets or sets the extension of the configuration file. - </summary> - <value> - The extension of the configuration file. - </value> - <remarks> - <para> - If specified this is the extension for the configuration file. - The path to the config file is built by using the <b>application - base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>), - the <b>assembly file name</b> and the config file extension. - </para> - <para> - If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then - possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or - <c>MyClassLibrary.dll.MyExt</c>. - </para> - <para> - The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>. - </para> - </remarks> - </member> - <member name="P:log4net.Config.XmlConfiguratorAttribute.Watch"> - <summary> - Gets or sets a value indicating whether to watch the configuration file. - </summary> - <value> - <c>true</c> if the configuration should be watched, <c>false</c> otherwise. - </value> - <remarks> - <para> - If this flag is specified and set to <c>true</c> then the framework - will watch the configuration file and will reload the config each time - the file is modified. - </para> - <para> - The config file can only be watched if it is loaded from local disk. - In a No-Touch (Smart Client) deployment where the application is downloaded - from a web server the config file may not reside on the local disk - and therefore it may not be able to watch it. - </para> - <note> - Watching configuration is not supported on the SSCLI. - </note> - </remarks> - </member> - <member name="T:log4net.Config.Log4NetConfigurationSectionHandler"> - <summary> - Class to register for the log4net section of the configuration file - </summary> - <remarks> - The log4net section of the configuration file needs to have a section - handler registered. This is the section handler used. It simply returns - the XML element that is the root of the section. - </remarks> - <example> - Example of registering the log4net section handler : - <code lang="XML" escaped="true"> - <configuration> - <configSections> - <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" /> - </configSections> - <log4net> - log4net configuration XML goes here - </log4net> - </configuration> - </code> - </example> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.#ctor"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> class. - </summary> - <remarks> - <para> - Default constructor. - </para> - </remarks> - </member> - <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.Create(System.Object,System.Object,System.Xml.XmlNode)"> - <summary> - Parses the configuration section. - </summary> - <param name="parent">The configuration settings in a corresponding parent configuration section.</param> - <param name="configContext">The configuration context when called from the ASP.NET configuration system. Otherwise, this parameter is reserved and is a null reference.</param> - <param name="section">The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</param> - <returns>The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</returns> - <remarks> - <para> - Returns the <see cref="T:System.Xml.XmlNode"/> containing the configuration data, - </para> - </remarks> - </member> - <member name="T:log4net.Config.PluginAttribute"> - <summary> - Assembly level attribute that specifies a plugin to attach to - the repository. - </summary> - <remarks> - <para> - Specifies the type of a plugin to create and attach to the - assembly's repository. The plugin type must implement the - <see cref="T:log4net.Plugin.IPlugin"/> interface. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="T:log4net.Plugin.IPluginFactory"> - <summary> - Interface used to create plugins. - </summary> - <remarks> - <para> - Interface used to create a plugin. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Plugin.IPluginFactory.CreatePlugin"> - <summary> - Creates the plugin object. - </summary> - <returns>the new plugin instance</returns> - <remarks> - <para> - Create and return a new plugin instance. - </para> - </remarks> - </member> - <member name="M:log4net.Config.PluginAttribute.#ctor(System.String)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class - with the specified type. - </summary> - <param name="typeName">The type name of plugin to create.</param> - <remarks> - <para> - Create the attribute with the plugin type specified. - </para> - <para> - Where possible use the constructor that takes a <see cref="T:System.Type"/>. - </para> - </remarks> - </member> - <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class - with the specified type. - </summary> - <param name="type">The type of plugin to create.</param> - <remarks> - <para> - Create the attribute with the plugin type specified. - </para> - </remarks> - </member> - <member name="M:log4net.Config.PluginAttribute.CreatePlugin"> - <summary> - Creates the plugin object defined by this attribute. - </summary> - <remarks> - <para> - Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as - specified by this attribute. - </para> - </remarks> - <returns>The plugin object.</returns> - </member> - <member name="M:log4net.Config.PluginAttribute.ToString"> - <summary> - Returns a representation of the properties of this object. - </summary> - <remarks> - <para> - Overrides base class <see cref="M:System.Object.ToString"/> method to - return a representation of the properties of this object. - </para> - </remarks> - <returns>A representation of the properties of this object</returns> - </member> - <member name="P:log4net.Config.PluginAttribute.Type"> - <summary> - Gets or sets the type for the plugin. - </summary> - <value> - The type for the plugin. - </value> - <remarks> - <para> - The type for the plugin. - </para> - </remarks> - </member> - <member name="P:log4net.Config.PluginAttribute.TypeName"> - <summary> - Gets or sets the type name for the plugin. - </summary> - <value> - The type name for the plugin. - </value> - <remarks> - <para> - The type name for the plugin. - </para> - <para> - Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead. - </para> - </remarks> - </member> - <member name="T:log4net.Config.SecurityContextProviderAttribute"> - <summary> - Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>. - </summary> - <remarks> - <para> - This attribute may only be used at the assembly scope and can only - be used once per assembly. - </para> - <para> - Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/> - without calling one of the <see cref="M:log4net.Config.XmlConfigurator.Configure"/> - methods. - </para> - </remarks> - <author>Nicko Cadell</author> - </member> - <member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)"> - <summary> - Construct provider attribute with type specified - </summary> - <param name="providerType">the type of the provider to use</param> - <remarks> - <para> - The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/> - class. - </para> - </remarks> - </member> - <member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> - <summary> - Configures the SecurityContextProvider - </summary> - <param name="sourceAssembly">The assembly that this attribute was defined on.</param> - <param name="targetRepository">The repository to configure.</param> - <remarks> - <para> - Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified. - Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>. - </para> - </remarks> - </member> - <member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"> - <summary> - Gets or sets the type of the provider to use. - </summary> - <value> - the type of the provider to use. - </value> - <remarks> - <para> - The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/> - class. - </para> - </remarks> - </member> - <member name="T:log4net.Config.XmlConfigurator"> - <summary> - Use this class to initialize the log4net environment using an Xml tree. - </summary> - <remarks> - <para> - Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree. - </para> - </remarks> - <author>Nicko Cadell</author> - <author>Gert Driesen</author> - </member> - <member name="M:log4net.Config.XmlConfigurator.#ctor"> - <summary> - Private constructor - </summary> - </member> - <member name="M:log4net.Config.XmlConfigurator.Configure"> - <summary> - Automatically configures the log4net system based on the - application's configuration settings. - </summary> - <remarks> - <para> - Each application has a configuration file. This has the - same name as the application with '.config' appended. - This file is XML and calling this function prompts the - configurator to look in that file for a section called - <c>log4net</c> that contains the configuration data. - </para> - <para> - To use this method to configure log4net you must specify - the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section - handler for the <c>log4net</c> configuration section. See the - <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example. - </para> - </remarks> - <seealso cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> - </member> - <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)"> - <summary> - Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings - stored in the application's configuration file. - </summary> - <remarks> - <para> - Each application has a configuration file. This has the - same name as the application with '.config' appended. - This file is XML and calling this function prompts the - configurator to look in that file for a section called - <c>log4net</c> that contains the configuration data. - </para> - <para> - To use this method to configure log4net you must specify - the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section - handler for the <c>log4net</c> configuration section. See the - <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example. - </para> - </remarks> - <param name="repository">The repository to configure.</param> - </member> - <member name="M:log4net.Config.XmlConfigurator.Configure(System.Xml.XmlElement)"> - <summary> - Configures log4net using a <c>log4net</c> element - </summary> - <remarks> - <para> - Loads the log4net configuration from the XML element - supplied as <paramref name="element"/>. - </para> - </remarks> - <param name="element">The element to parse.</param> - </member> - <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)"> - <summary> - Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML - element. - </summary> - <remarks> - Loads the log4net configuration from the XML element - supplied as <paramref name="element"/>. - </remarks> - <param name="repository">The repository to configure.</param> - <param name="element">The element to parse.</param> - </member> - <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)"> - <summary> - Configures log4net using the specified configuration file. - </summary> - <param name="configFile">The XML file to load the configuration from.</param> - <remarks> - <para> - The configuration file must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the log4net configuration data. - </para> - <para> - The log4net configuration file can possible be specified in the application's - configuration file (either <c>MyAppName.exe.config</c> for a - normal application on <c>Web.config</c> for an ASP.NET application). - </para> - <para> - The first element matching <c><configuration></c> will be read as the - configuration. If this file is also a .NET .config file then you must specify - a configuration section for the <c>log4net</c> element otherwise .NET will - complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example: - <code lang="XML" escaped="true"> - <configSections> - <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/> - </configSections> - </code> - </para> - <example> - The following example configures log4net using a configuration file, of which the - location is stored in the application's configuration file : - </example> - <code lang="C#"> - using log4net.Config; - using System.IO; - using System.Configuration; - - ... - - XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); - </code> - <para> - In the <c>.config</c> file, the path to the log4net can be specified like this : - </para> - <code lang="XML" escaped="true"> - <configuration> - <appSettings> - <add key="log4net-config-file" value="log.config"/> - </appSettings> - </configuration> - </code> - </remarks> - </member> - <member name="M:log4net.Config.XmlConfigurator.Configure(System.Uri)"> - <summary> - Configures log4net using the specified configuration URI. - </summary> - <param name="configUri">A URI to load the XML configuration from.</param> - <remarks> - <para> - The configuration data must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the log4net configuration data. - </para> - <para> - The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified. - </para> - </remarks> - </member> - <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.Stream)"> - <summary> - Configures log4net using the specified configuration data stream. - </summary> - <param name="configStream">A stream to load the XML configuration from.</param> - <remarks> - <para> - The configuration data must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the log4net configuration data. - </para> - <para> - Note that this method will NOT close the stream parameter. - </para> - </remarks> - </member> - <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> - <summary> - Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration - file. - </summary> - <param name="repository">The repository to configure.</param> - <param name="configFile">The XML file to load the configuration from.</param> - <remarks> - <para> - The configuration file must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the configuration data. - </para> - <para> - The log4net configuration file can possible be specified in the application's - configuration file (either <c>MyAppName.exe.config</c> for a - normal application on <c>Web.config</c> for an ASP.NET application). - </para> - <para> - The first element matching <c><configuration></c> will be read as the - configuration. If this file is also a .NET .config file then you must specify - a configuration section for the <c>log4net</c> element otherwise .NET will - complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example: - <code lang="XML" escaped="true"> - <configSections> - <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/> - </configSections> - </code> - </para> - <example> - The following example configures log4net using a configuration file, of which the - location is stored in the application's configuration file : - </example> - <code lang="C#"> - using log4net.Config; - using System.IO; - using System.Configuration; - - ... - - XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); - </code> - <para> - In the <c>.config</c> file, the path to the log4net can be specified like this : - </para> - <code lang="XML" escaped="true"> - <configuration> - <appSettings> - <add key="log4net-config-file" value="log.config"/> - </appSettings> - </configuration> - </code> - </remarks> - </member> - <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)"> - <summary> - Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration - URI. - </summary> - <param name="repository">The repository to configure.</param> - <param name="configUri">A URI to load the XML configuration from.</param> - <remarks> - <para> - The configuration data must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the configuration data. - </para> - <para> - The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified. - </para> - </remarks> - </member> - <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)"> - <summary> - Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration - file. - </summary> - <param name="repository">The repository to configure.</param> - <param name="configStream">The stream to load the XML configuration from.</param> - <remarks> - <para> - The configuration data must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the configuration data. - </para> - <para> - Note that this method will NOT close the stream parameter. - </para> - </remarks> - </member> - <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)"> - <summary> - Configures log4net using the file specified, monitors the file for changes - and reloads the configuration if a change is detected. - </summary> - <param name="configFile">The XML file to load the configuration from.</param> - <remarks> - <para> - The configuration file must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the configuration data. - </para> - <para> - The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/> - and depends on the behavior of that class. - </para> - <para> - For more information on how to configure log4net using - a separate configuration file, see <see cref="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)"/>. - </para> - </remarks> - <seealso cref="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)"/> - </member> - <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> - <summary> - Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified, - monitors the file for changes and reloads the configuration if a change - is detected. - </summary> - <param name="repository">The repository to configure.</param> - <param name="configFile">The XML file to load the configuration from.</param> - <remarks> - <para> - The configuration file must be valid XML. It must contain - at least one element called <c>log4net</c> that holds - the configuration data. - </para> - <para> - The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/> - and depends on the behavior of that class. - </para> - <para> - For more information on how to configure log4net using - a separate configuration file, see <see cref="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)"/>. - </para> - </remarks> - <seealso cref="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)"/> - </member> - <member name="M:log4net.Config.XmlConfigurator.ConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)"> - <summary> - Configures the specified repository using a <c>log4net</c> element. - </summary> - <param name="repository">The hierarchy to configure.</param> - <param name="element">The element to parse.</param> - <remarks> - <para> - Loads the log4net configuration from the XML element - supplied as <paramref name="element"/>. - </para> - <para> - This method is ultimately called by one of the Configure methods - to load the configuration from an <see cref="T:System.Xml.XmlElement"/>. - </para> - </remarks> - </member> - <member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"> - <summary> - Class used to watch config files. - </summary> - <remarks> - <para> - Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor - changes to a specified file. Because multiple change notifications - may be raised when the file is modified, a timer is used to - compress the notifications into a single event. The timer - waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering - the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/> - change notifications arrive while the timer is waiting it - is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to - elapse. - </para> - </remarks> - </member> - <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"> - <summary> - The default amount of time to wait after receiving notification - before reloading the config file. - </summary> - </member> - <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.StartWatching(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> - <summary> - Watch a specified config file used to configure a repository - </summary> - <param name="repository">The repository to configure.</param> - <param name="configFile">The configuration file to watch.</param> - <remarks> - <para> - Watch a specified config file used to configure a repository - </para> - </remarks> - </member> - <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile"> - <summary> - Holds the FileInfo used to configure the XmlConfigurator - </summary> - </member> - <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository"> - <summary> - Holds the repository being configured. - </summary> - </member> - <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer"> - <summary> - The timer used to compress the notification events. - </summary> - </member> - <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> - <summary> - Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class. - </summary> - <param name="repository">The repository to configure.</param> - <param name="configFile">The configuration file to watch.</param> - <remarks> - <para> - Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class. - </para> - </remarks> - </member> - <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)"> - <summary> - Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>. - </summary> - <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param> - <param name="e">The argument indicates the file that caused the event to be fired.</param> - <remarks> - <para> - This handler reloads the configuration from the file when the event is fired. - </para> - </remarks> - </member> - <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)"> - <summary> - Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>. - </summary> - <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param> - <param name="e">The argument indicates the file that caused the event to be fired.</param> - <remarks> - <para> - This handler reloads the configuration from the file when the event is fired. - </para> - </remarks> - </member> - <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)"> - <summary> - Called by the timer when the configuration has been updated. - </summary> - <param name="state">null</param> - </member>