log4net 1.2.9 → 1.2.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. data/lib/log4net.dll +0 -0
  2. data/lib/log4net.xml +2873 -422
  3. metadata +3 -3
data/lib/log4net.dll CHANGED
Binary file
data/lib/log4net.xml CHANGED
@@ -211,6 +211,30 @@
211
211
  <para>The name uniquely identifies the appender.</para>
212
212
  </remarks>
213
213
  </member>
214
+ <member name="T:log4net.Appender.IBulkAppender">
215
+ <summary>
216
+ Interface for appenders that support bulk logging.
217
+ </summary>
218
+ <remarks>
219
+ <para>
220
+ This interface extends the <see cref="T:log4net.Appender.IAppender"/> interface to
221
+ support bulk logging of <see cref="T:log4net.Core.LoggingEvent"/> objects. Appenders
222
+ should only implement this interface if they can bulk log efficiently.
223
+ </para>
224
+ </remarks>
225
+ <author>Nicko Cadell</author>
226
+ </member>
227
+ <member name="M:log4net.Appender.IBulkAppender.DoAppend(log4net.Core.LoggingEvent[])">
228
+ <summary>
229
+ Log the array of logging events in Appender specific way.
230
+ </summary>
231
+ <param name="loggingEvents">The events to log</param>
232
+ <remarks>
233
+ <para>
234
+ This method is called to log an array of events into this appender.
235
+ </para>
236
+ </remarks>
237
+ </member>
214
238
  <member name="T:log4net.Core.IOptionHandler">
215
239
  <summary>
216
240
  Interface used to delay activate a configured object.
@@ -338,7 +362,7 @@
338
362
  </item>
339
363
  <item>
340
364
  <description>
341
- Checks that the <see cref="N:log4net.Filter"/> chain accepts the
365
+ Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
342
366
  <paramref name="loggingEvent"/>.
343
367
  </description>
344
368
  </item>
@@ -355,6 +379,82 @@
355
379
  </para>
356
380
  </remarks>
357
381
  </member>
382
+ <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])">
383
+ <summary>
384
+ Performs threshold checks and invokes filters before
385
+ delegating actual logging to the subclasses specific
386
+ <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])"/> method.
387
+ </summary>
388
+ <param name="loggingEvents">The array of events to log.</param>
389
+ <remarks>
390
+ <para>
391
+ This method cannot be overridden by derived classes. A
392
+ derived class should override the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])"/> method
393
+ which is called by this method.
394
+ </para>
395
+ <para>
396
+ The implementation of this method is as follows:
397
+ </para>
398
+ <para>
399
+ <list type="bullet">
400
+ <item>
401
+ <description>
402
+ Checks that the severity of the <paramref name="loggingEvent"/>
403
+ is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
404
+ appender.</description>
405
+ </item>
406
+ <item>
407
+ <description>
408
+ Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
409
+ <paramref name="loggingEvent"/>.
410
+ </description>
411
+ </item>
412
+ <item>
413
+ <description>
414
+ Calls <see cref="M:log4net.Appender.AppenderSkeleton.PreAppendCheck"/> and checks that
415
+ it returns <c>true</c>.</description>
416
+ </item>
417
+ </list>
418
+ </para>
419
+ <para>
420
+ If all of the above steps succeed then the <paramref name="loggingEvents"/>
421
+ will be passed to the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])"/> method.
422
+ </para>
423
+ </remarks>
424
+ </member>
425
+ <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)">
426
+ <summary>
427
+ Test if the logging event should we output by this appender
428
+ </summary>
429
+ <param name="loggingEvent">the event to test</param>
430
+ <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns>
431
+ <remarks>
432
+ <para>
433
+ This method checks the logging event against the threshold level set
434
+ on this appender and also against the filters specified on this
435
+ appender.
436
+ </para>
437
+ <para>
438
+ The implementation of this method is as follows:
439
+ </para>
440
+ <para>
441
+ <list type="bullet">
442
+ <item>
443
+ <description>
444
+ Checks that the severity of the <paramref name="loggingEvent"/>
445
+ is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
446
+ appender.</description>
447
+ </item>
448
+ <item>
449
+ <description>
450
+ Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
451
+ <paramref name="loggingEvent"/>.
452
+ </description>
453
+ </item>
454
+ </list>
455
+ </para>
456
+ </remarks>
457
+ </member>
358
458
  <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
359
459
  <summary>
360
460
  Adds a filter to the end of the filter chain.
@@ -430,6 +530,22 @@
430
530
  </para>
431
531
  </remarks>
432
532
  </member>
533
+ <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])">
534
+ <summary>
535
+ Append a bulk array of logging events.
536
+ </summary>
537
+ <param name="loggingEvents">the array of logging events</param>
538
+ <remarks>
539
+ <para>
540
+ This base class implementation calls the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/>
541
+ method for each element in the bulk array.
542
+ </para>
543
+ <para>
544
+ A sub class that can better process a bulk array of events should
545
+ override this method in addition to <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/>.
546
+ </para>
547
+ </remarks>
548
+ </member>
433
549
  <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
434
550
  <summary>
435
551
  Called before <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> as a precondition.
@@ -552,7 +668,7 @@
552
668
  Set to <c>null</c> initially.
553
669
  </para>
554
670
  <para>
555
- See <see cref="N:log4net.Filter"/> for more information.
671
+ See <see cref="T:log4net.Filter.IFilter"/> for more information.
556
672
  </para>
557
673
  </remarks>
558
674
  </member>
@@ -561,7 +677,7 @@
561
677
  The last filter in the filter chain.
562
678
  </summary>
563
679
  <remarks>
564
- See <see cref="N:log4net.Filter"/> for more information.
680
+ See <see cref="T:log4net.Filter.IFilter"/> for more information.
565
681
  </remarks>
566
682
  </member>
567
683
  <member name="F:log4net.Appender.AppenderSkeleton.m_closed">
@@ -702,6 +818,43 @@
702
818
  </para>
703
819
  </remarks>
704
820
  </member>
821
+ <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush">
822
+ <summary>
823
+ Flush the currently buffered events
824
+ </summary>
825
+ <remarks>
826
+ <para>
827
+ Flushes any events that have been buffered.
828
+ </para>
829
+ <para>
830
+ If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
831
+ of the buffer will NOT be flushed to the appender.
832
+ </para>
833
+ </remarks>
834
+ </member>
835
+ <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)">
836
+ <summary>
837
+ Flush the currently buffered events
838
+ </summary>
839
+ <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param>
840
+ <remarks>
841
+ <para>
842
+ Flushes events that have been buffered. If <paramref name="flushLossyBuffer"/> is
843
+ <c>false</c> then events will only be flushed if this buffer is non-lossy mode.
844
+ </para>
845
+ <para>
846
+ If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
847
+ of the buffer will only be flushed if <paramref name="flushLossyBuffer"/> is <c>true</c>.
848
+ In this case the contents of the buffer will be tested against the
849
+ <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered
850
+ events will be discarded.
851
+ </para>
852
+ <para>
853
+ If <paramref name="flushLossyBuffer"/> is <c>true</c> then the buffer will always
854
+ be emptied by calling this method.
855
+ </para>
856
+ </remarks>
857
+ </member>
705
858
  <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
706
859
  <summary>
707
860
  Initialize the appender based on the options set
@@ -725,9 +878,11 @@
725
878
  Close this appender instance.
726
879
  </summary>
727
880
  <remarks>
728
- <para>Close this appender instance. If this appender is marked
881
+ <para>
882
+ Close this appender instance. If this appender is marked
729
883
  as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
730
- the buffer must be sent when the appender is closed.</para>
884
+ the buffer must be sent when the appender is closed.
885
+ </para>
731
886
  </remarks>
732
887
  </member>
733
888
  <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)">
@@ -736,11 +891,13 @@
736
891
  </summary>
737
892
  <param name="loggingEvent">the event to log</param>
738
893
  <remarks>
739
- <para>Stores the <paramref name="loggingEvent"/> in the cyclic buffer.</para>
740
-
741
- <para>The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Util.CyclicBuffer)"/>
742
- method) if one of the following conditions is met:</para>
743
-
894
+ <para>
895
+ Stores the <paramref name="loggingEvent"/> in the cyclic buffer.
896
+ </para>
897
+ <para>
898
+ The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>
899
+ method) if one of the following conditions is met:
900
+ </para>
744
901
  <list type="bullet">
745
902
  <item>
746
903
  <description>The cyclic buffer is full and this appender is
@@ -752,21 +909,24 @@
752
909
  specified.</description>
753
910
  </item>
754
911
  </list>
755
-
756
- <para>Before the event is stored in the buffer it is fixed
757
- (see <see cref="M:log4net.Core.LoggingEvent.FixVolatileData"/>) to ensure that
912
+ <para>
913
+ Before the event is stored in the buffer it is fixed
914
+ (see <see cref="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)"/>) to ensure that
758
915
  any data referenced by the event will be valid when the buffer
759
- is processed.</para>
916
+ is processed.
917
+ </para>
760
918
  </remarks>
761
919
  </member>
762
- <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Util.CyclicBuffer)">
920
+ <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)">
763
921
  <summary>
764
922
  Sends the contents of the buffer.
765
923
  </summary>
924
+ <param name="firstLoggingEvent">The first logging event.</param>
766
925
  <param name="buffer">The buffer containing the events that need to be send.</param>
767
926
  <remarks>
768
- The subclass must override either <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Util.CyclicBuffer)"/>
769
- or <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>.
927
+ <para>
928
+ The subclass must override <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>.
929
+ </para>
770
930
  </remarks>
771
931
  </member>
772
932
  <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])">
@@ -775,8 +935,9 @@
775
935
  </summary>
776
936
  <param name="events">The events that need to be send.</param>
777
937
  <remarks>
778
- The subclass must override either <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Util.CyclicBuffer)"/>
779
- or <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>.
938
+ <para>
939
+ The subclass must override this method to process the buffered events.
940
+ </para>
780
941
  </remarks>
781
942
  </member>
782
943
  <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
@@ -934,7 +1095,7 @@
934
1095
  event data to be fixed and serialized. This will improve performance.
935
1096
  </para>
936
1097
  <para>
937
- See <see cref="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)"/> for more information.
1098
+ See <see cref="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)"/> for more information.
938
1099
  </para>
939
1100
  </remarks>
940
1101
  </member>
@@ -1290,10 +1451,8 @@
1290
1451
  <note>
1291
1452
  When the appender attempts to connect to the database there may be a
1292
1453
  delay of up to the connection timeout specified in the connection string.
1293
- If the appender is being used synchronously (the default behaviour for
1294
- this appender) then this delay will impact the calling application on
1295
- the current thread. Until the connection can be reestablished this
1296
- potential delay may occur multiple times.
1454
+ This delay will block the calling application's thread.
1455
+ Until the connection can be reestablished this potential delay may occur multiple times.
1297
1456
  </note>
1298
1457
  </remarks>
1299
1458
  </member>
@@ -2509,79 +2668,110 @@
2509
2668
  A collection of the appenders in this appender.
2510
2669
  </returns>
2511
2670
  </member>
2512
- <member name="T:log4net.Appender.ConsoleAppender">
2671
+ <member name="T:log4net.Appender.ColoredConsoleAppender">
2513
2672
  <summary>
2514
2673
  Appends logging events to the console.
2515
2674
  </summary>
2516
2675
  <remarks>
2517
2676
  <para>
2518
- ConsoleAppender appends log events to the standard output stream
2677
+ ColoredConsoleAppender appends log events to the standard output stream
2519
2678
  or the error output stream using a layout specified by the
2520
- user.
2679
+ user. It also allows the color of a specific type of message to be set.
2521
2680
  </para>
2522
2681
  <para>
2523
2682
  By default, all output is written to the console's standard output stream.
2524
- The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
2683
+ The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> property can be set to direct the output to the
2525
2684
  error stream.
2526
2685
  </para>
2527
2686
  <para>
2528
- NOTE: This appender writes each message to the <c>System.Console.Out</c> or
2529
- <c>System.Console.Error</c> that is set at the time the event is appended.
2530
- Therefore it is possible to programmatically redirect the output of this appender
2531
- (for example NUnit does this to capture program output). While this is the desired
2532
- behavior of this appender it may have security implications in your application.
2687
+ NOTE: This appender writes directly to the application's attached console
2688
+ not to the <c>System.Console.Out</c> or <c>System.Console.Error</c> <c>TextWriter</c>.
2689
+ The <c>System.Console.Out</c> and <c>System.Console.Error</c> streams can be
2690
+ programmatically redirected (for example NUnit does this to capture program output).
2691
+ This appender will ignore these redirections because it needs to use Win32
2692
+ API calls to colorize the output. To respect these redirections the <see cref="T:log4net.Appender.ConsoleAppender"/>
2693
+ must be used.
2694
+ </para>
2695
+ <para>
2696
+ When configuring the colored console appender, mapping should be
2697
+ specified to map a logging level to a color. For example:
2698
+ </para>
2699
+ <code lang="XML" escaped="true">
2700
+ <mapping>
2701
+ <level value="ERROR"/>
2702
+ <foreColor value="White"/>
2703
+ <backColor value="Red, HighIntensity"/>
2704
+ </mapping>
2705
+ <mapping>
2706
+ <level value="DEBUG"/>
2707
+ <backColor value="Green"/>
2708
+ </mapping>
2709
+ </code>
2710
+ <para>
2711
+ The Level is the standard log4net logging level and ForeColor and BackColor can be any
2712
+ combination of the following values:
2713
+ <list type="bullet">
2714
+ <item><term>Blue</term><description></description></item>
2715
+ <item><term>Green</term><description></description></item>
2716
+ <item><term>Red</term><description></description></item>
2717
+ <item><term>White</term><description></description></item>
2718
+ <item><term>Yellow</term><description></description></item>
2719
+ <item><term>Purple</term><description></description></item>
2720
+ <item><term>Cyan</term><description></description></item>
2721
+ <item><term>HighIntensity</term><description></description></item>
2722
+ </list>
2533
2723
  </para>
2534
2724
  </remarks>
2725
+ <author>Rick Hobbs</author>
2535
2726
  <author>Nicko Cadell</author>
2536
- <author>Gert Driesen</author>
2537
2727
  </member>
2538
- <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
2728
+ <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleOut">
2539
2729
  <summary>
2540
- The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
2730
+ The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
2541
2731
  standard output stream.
2542
2732
  </summary>
2543
2733
  <remarks>
2544
2734
  <para>
2545
- The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
2735
+ The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
2546
2736
  standard output stream.
2547
2737
  </para>
2548
2738
  </remarks>
2549
2739
  </member>
2550
- <member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
2740
+ <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleError">
2551
2741
  <summary>
2552
- The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
2742
+ The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
2553
2743
  standard error output stream.
2554
2744
  </summary>
2555
2745
  <remarks>
2556
2746
  <para>
2557
- The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
2747
+ The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
2558
2748
  standard error output stream.
2559
2749
  </para>
2560
2750
  </remarks>
2561
2751
  </member>
2562
- <member name="M:log4net.Appender.ConsoleAppender.#ctor">
2752
+ <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor">
2563
2753
  <summary>
2564
- Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class.
2754
+ Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class.
2565
2755
  </summary>
2566
2756
  <remarks>
2567
- The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
2757
+ The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
2568
2758
  to the standard output stream.
2569
2759
  </remarks>
2570
2760
  </member>
2571
- <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
2761
+ <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout)">
2572
2762
  <summary>
2573
- Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
2763
+ Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
2574
2764
  with the specified layout.
2575
2765
  </summary>
2576
2766
  <param name="layout">the layout to use for this appender</param>
2577
2767
  <remarks>
2578
- The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
2768
+ The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
2579
2769
  to the standard output stream.
2580
2770
  </remarks>
2581
2771
  </member>
2582
- <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
2772
+ <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
2583
2773
  <summary>
2584
- Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
2774
+ Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
2585
2775
  with the specified layout.
2586
2776
  </summary>
2587
2777
  <param name="layout">the layout to use for this appender</param>
@@ -2592,7 +2782,20 @@
2592
2782
  output stream.
2593
2783
  </remarks>
2594
2784
  </member>
2595
- <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
2785
+ <member name="M:log4net.Appender.ColoredConsoleAppender.AddMapping(log4net.Appender.ColoredConsoleAppender.LevelColors)">
2786
+ <summary>
2787
+ Add a mapping of level to color - done by the config file
2788
+ </summary>
2789
+ <param name="mapping">The mapping to add</param>
2790
+ <remarks>
2791
+ <para>
2792
+ Add a <see cref="T:log4net.Appender.ColoredConsoleAppender.LevelColors"/> mapping to this appender.
2793
+ Each mapping defines the foreground and background colors
2794
+ for a level.
2795
+ </para>
2796
+ </remarks>
2797
+ </member>
2798
+ <member name="M:log4net.Appender.ColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
2596
2799
  <summary>
2597
2800
  This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
2598
2801
  </summary>
@@ -2606,107 +2809,362 @@
2606
2809
  </para>
2607
2810
  </remarks>
2608
2811
  </member>
2609
- <member name="P:log4net.Appender.ConsoleAppender.Target">
2812
+ <member name="M:log4net.Appender.ColoredConsoleAppender.ActivateOptions">
2610
2813
  <summary>
2611
- Target is the value of the console output stream.
2612
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
2814
+ Initialize the options for this appender
2613
2815
  </summary>
2614
- <value>
2615
- Target is the value of the console output stream.
2616
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
2617
- </value>
2618
2816
  <remarks>
2619
2817
  <para>
2620
- Target is the value of the console output stream.
2621
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
2818
+ Initialize the level to color mappings set on this appender.
2622
2819
  </para>
2623
2820
  </remarks>
2624
2821
  </member>
2625
- <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
2822
+ <member name="F:log4net.Appender.ColoredConsoleAppender.m_writeToErrorStream">
2626
2823
  <summary>
2627
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
2824
+ Flag to write output to the error stream rather than the standard output stream
2628
2825
  </summary>
2629
- <value><c>true</c></value>
2630
- <remarks>
2631
- <para>
2632
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
2633
- </para>
2634
- </remarks>
2635
2826
  </member>
2636
- <member name="T:log4net.Appender.DebugAppender">
2827
+ <member name="F:log4net.Appender.ColoredConsoleAppender.m_levelMapping">
2637
2828
  <summary>
2638
- Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
2829
+ Mapping from level object to color value
2639
2830
  </summary>
2640
- <remarks>
2641
- <para>
2642
- The application configuration file can be used to control what listeners
2643
- are actually used. See the MSDN documentation for the
2644
- <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
2645
- debug system.
2646
- </para>
2647
- <para>
2648
- Events are written using the <see cref="M:System.Diagnostics.Debug.Write(System.String,System.String)"/>
2649
- method. The event's logger name is passed as the value for the category name to the Write method.
2650
- </para>
2651
- </remarks>
2652
- <author>Nicko Cadell</author>
2653
2831
  </member>
2654
- <member name="M:log4net.Appender.DebugAppender.#ctor">
2832
+ <member name="F:log4net.Appender.ColoredConsoleAppender.m_consoleOutputWriter">
2655
2833
  <summary>
2656
- Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>.
2834
+ The console output stream writer to write to
2657
2835
  </summary>
2658
2836
  <remarks>
2659
2837
  <para>
2660
- Default constructor.
2838
+ This writer is not thread safe.
2661
2839
  </para>
2662
2840
  </remarks>
2663
2841
  </member>
2664
- <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
2842
+ <member name="P:log4net.Appender.ColoredConsoleAppender.Target">
2665
2843
  <summary>
2666
- Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>
2667
- with a specified layout.
2844
+ Target is the value of the console output stream.
2845
+ This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
2668
2846
  </summary>
2669
- <param name="layout">The layout to use with this appender.</param>
2847
+ <value>
2848
+ Target is the value of the console output stream.
2849
+ This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
2850
+ </value>
2670
2851
  <remarks>
2671
2852
  <para>
2672
- Obsolete constructor.
2853
+ Target is the value of the console output stream.
2854
+ This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
2673
2855
  </para>
2674
2856
  </remarks>
2675
2857
  </member>
2676
- <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
2858
+ <member name="P:log4net.Appender.ColoredConsoleAppender.RequiresLayout">
2677
2859
  <summary>
2678
- Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
2860
+ This appender requires a <see cref="N:log4net.Layout"/> to be set.
2679
2861
  </summary>
2680
- <param name="loggingEvent">The event to log.</param>
2862
+ <value><c>true</c></value>
2681
2863
  <remarks>
2682
2864
  <para>
2683
- Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
2684
- If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/>
2685
- is called.
2865
+ This appender requires a <see cref="N:log4net.Layout"/> to be set.
2686
2866
  </para>
2687
2867
  </remarks>
2688
2868
  </member>
2689
- <member name="F:log4net.Appender.DebugAppender.m_immediateFlush">
2869
+ <member name="T:log4net.Appender.ColoredConsoleAppender.Colors">
2690
2870
  <summary>
2691
- Immediate flush means that the underlying writer or output stream
2692
- will be flushed at the end of each append operation.
2871
+ The enum of possible color values for use with the color mapping method
2693
2872
  </summary>
2694
2873
  <remarks>
2695
2874
  <para>
2696
- Immediate flush is slower but ensures that each append request is
2697
- actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to
2698
- <c>false</c>, then there is a good chance that the last few
2699
- logs events are not actually written to persistent media if and
2700
- when the application crashes.
2875
+ The following flags can be combined together to
2876
+ form the colors.
2701
2877
  </para>
2702
- <para>
2703
- The default value is <c>true</c>.</para>
2704
2878
  </remarks>
2879
+ <seealso cref="T:log4net.Appender.ColoredConsoleAppender"/>
2705
2880
  </member>
2706
- <member name="P:log4net.Appender.DebugAppender.ImmediateFlush">
2881
+ <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Blue">
2707
2882
  <summary>
2708
- Gets or sets a value that indicates whether the appender will
2709
- flush at the end of each write.
2883
+ color is blue
2884
+ </summary>
2885
+ </member>
2886
+ <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Green">
2887
+ <summary>
2888
+ color is green
2889
+ </summary>
2890
+ </member>
2891
+ <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Red">
2892
+ <summary>
2893
+ color is red
2894
+ </summary>
2895
+ </member>
2896
+ <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.White">
2897
+ <summary>
2898
+ color is white
2899
+ </summary>
2900
+ </member>
2901
+ <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Yellow">
2902
+ <summary>
2903
+ color is yellow
2904
+ </summary>
2905
+ </member>
2906
+ <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Purple">
2907
+ <summary>
2908
+ color is purple
2909
+ </summary>
2910
+ </member>
2911
+ <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Cyan">
2912
+ <summary>
2913
+ color is cyan
2914
+ </summary>
2915
+ </member>
2916
+ <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.HighIntensity">
2917
+ <summary>
2918
+ color is intensified
2919
+ </summary>
2920
+ </member>
2921
+ <member name="T:log4net.Appender.ColoredConsoleAppender.LevelColors">
2922
+ <summary>
2923
+ A class to act as a mapping between the level that a logging call is made at and
2924
+ the color it should be displayed as.
2925
+ </summary>
2926
+ <remarks>
2927
+ <para>
2928
+ Defines the mapping between a level and the color it should be displayed in.
2929
+ </para>
2930
+ </remarks>
2931
+ </member>
2932
+ <member name="M:log4net.Appender.ColoredConsoleAppender.LevelColors.ActivateOptions">
2933
+ <summary>
2934
+ Initialize the options for the object
2935
+ </summary>
2936
+ <remarks>
2937
+ <para>
2938
+ Combine the <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> together.
2939
+ </para>
2940
+ </remarks>
2941
+ </member>
2942
+ <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor">
2943
+ <summary>
2944
+ The mapped foreground color for the specified level
2945
+ </summary>
2946
+ <remarks>
2947
+ <para>
2948
+ Required property.
2949
+ The mapped foreground color for the specified level.
2950
+ </para>
2951
+ </remarks>
2952
+ </member>
2953
+ <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor">
2954
+ <summary>
2955
+ The mapped background color for the specified level
2956
+ </summary>
2957
+ <remarks>
2958
+ <para>
2959
+ Required property.
2960
+ The mapped background color for the specified level.
2961
+ </para>
2962
+ </remarks>
2963
+ </member>
2964
+ <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.CombinedColor">
2965
+ <summary>
2966
+ The combined <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> suitable for
2967
+ setting the console color.
2968
+ </summary>
2969
+ </member>
2970
+ <member name="T:log4net.Appender.ConsoleAppender">
2971
+ <summary>
2972
+ Appends logging events to the console.
2973
+ </summary>
2974
+ <remarks>
2975
+ <para>
2976
+ ConsoleAppender appends log events to the standard output stream
2977
+ or the error output stream using a layout specified by the
2978
+ user.
2979
+ </para>
2980
+ <para>
2981
+ By default, all output is written to the console's standard output stream.
2982
+ The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
2983
+ error stream.
2984
+ </para>
2985
+ <para>
2986
+ NOTE: This appender writes each message to the <c>System.Console.Out</c> or
2987
+ <c>System.Console.Error</c> that is set at the time the event is appended.
2988
+ Therefore it is possible to programmatically redirect the output of this appender
2989
+ (for example NUnit does this to capture program output). While this is the desired
2990
+ behavior of this appender it may have security implications in your application.
2991
+ </para>
2992
+ </remarks>
2993
+ <author>Nicko Cadell</author>
2994
+ <author>Gert Driesen</author>
2995
+ </member>
2996
+ <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
2997
+ <summary>
2998
+ The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
2999
+ standard output stream.
3000
+ </summary>
3001
+ <remarks>
3002
+ <para>
3003
+ The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
3004
+ standard output stream.
3005
+ </para>
3006
+ </remarks>
3007
+ </member>
3008
+ <member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
3009
+ <summary>
3010
+ The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
3011
+ standard error output stream.
3012
+ </summary>
3013
+ <remarks>
3014
+ <para>
3015
+ The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
3016
+ standard error output stream.
3017
+ </para>
3018
+ </remarks>
3019
+ </member>
3020
+ <member name="M:log4net.Appender.ConsoleAppender.#ctor">
3021
+ <summary>
3022
+ Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class.
3023
+ </summary>
3024
+ <remarks>
3025
+ The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
3026
+ to the standard output stream.
3027
+ </remarks>
3028
+ </member>
3029
+ <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
3030
+ <summary>
3031
+ Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
3032
+ with the specified layout.
3033
+ </summary>
3034
+ <param name="layout">the layout to use for this appender</param>
3035
+ <remarks>
3036
+ The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
3037
+ to the standard output stream.
3038
+ </remarks>
3039
+ </member>
3040
+ <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
3041
+ <summary>
3042
+ Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
3043
+ with the specified layout.
3044
+ </summary>
3045
+ <param name="layout">the layout to use for this appender</param>
3046
+ <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
3047
+ <remarks>
3048
+ When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
3049
+ the standard error output stream. Otherwise, output is written to the standard
3050
+ output stream.
3051
+ </remarks>
3052
+ </member>
3053
+ <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
3054
+ <summary>
3055
+ This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
3056
+ </summary>
3057
+ <param name="loggingEvent">The event to log.</param>
3058
+ <remarks>
3059
+ <para>
3060
+ Writes the event to the console.
3061
+ </para>
3062
+ <para>
3063
+ The format of the output will depend on the appender's layout.
3064
+ </para>
3065
+ </remarks>
3066
+ </member>
3067
+ <member name="P:log4net.Appender.ConsoleAppender.Target">
3068
+ <summary>
3069
+ Target is the value of the console output stream.
3070
+ This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
3071
+ </summary>
3072
+ <value>
3073
+ Target is the value of the console output stream.
3074
+ This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
3075
+ </value>
3076
+ <remarks>
3077
+ <para>
3078
+ Target is the value of the console output stream.
3079
+ This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
3080
+ </para>
3081
+ </remarks>
3082
+ </member>
3083
+ <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
3084
+ <summary>
3085
+ This appender requires a <see cref="N:log4net.Layout"/> to be set.
3086
+ </summary>
3087
+ <value><c>true</c></value>
3088
+ <remarks>
3089
+ <para>
3090
+ This appender requires a <see cref="N:log4net.Layout"/> to be set.
3091
+ </para>
3092
+ </remarks>
3093
+ </member>
3094
+ <member name="T:log4net.Appender.DebugAppender">
3095
+ <summary>
3096
+ Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
3097
+ </summary>
3098
+ <remarks>
3099
+ <para>
3100
+ The application configuration file can be used to control what listeners
3101
+ are actually used. See the MSDN documentation for the
3102
+ <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
3103
+ debug system.
3104
+ </para>
3105
+ <para>
3106
+ Events are written using the <see cref="M:System.Diagnostics.Debug.Write(System.String,System.String)"/>
3107
+ method. The event's logger name is passed as the value for the category name to the Write method.
3108
+ </para>
3109
+ </remarks>
3110
+ <author>Nicko Cadell</author>
3111
+ </member>
3112
+ <member name="M:log4net.Appender.DebugAppender.#ctor">
3113
+ <summary>
3114
+ Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>.
3115
+ </summary>
3116
+ <remarks>
3117
+ <para>
3118
+ Default constructor.
3119
+ </para>
3120
+ </remarks>
3121
+ </member>
3122
+ <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
3123
+ <summary>
3124
+ Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>
3125
+ with a specified layout.
3126
+ </summary>
3127
+ <param name="layout">The layout to use with this appender.</param>
3128
+ <remarks>
3129
+ <para>
3130
+ Obsolete constructor.
3131
+ </para>
3132
+ </remarks>
3133
+ </member>
3134
+ <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
3135
+ <summary>
3136
+ Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
3137
+ </summary>
3138
+ <param name="loggingEvent">The event to log.</param>
3139
+ <remarks>
3140
+ <para>
3141
+ Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
3142
+ If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/>
3143
+ is called.
3144
+ </para>
3145
+ </remarks>
3146
+ </member>
3147
+ <member name="F:log4net.Appender.DebugAppender.m_immediateFlush">
3148
+ <summary>
3149
+ Immediate flush means that the underlying writer or output stream
3150
+ will be flushed at the end of each append operation.
3151
+ </summary>
3152
+ <remarks>
3153
+ <para>
3154
+ Immediate flush is slower but ensures that each append request is
3155
+ actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to
3156
+ <c>false</c>, then there is a good chance that the last few
3157
+ logs events are not actually written to persistent media if and
3158
+ when the application crashes.
3159
+ </para>
3160
+ <para>
3161
+ The default value is <c>true</c>.</para>
3162
+ </remarks>
3163
+ </member>
3164
+ <member name="P:log4net.Appender.DebugAppender.ImmediateFlush">
3165
+ <summary>
3166
+ Gets or sets a value that indicates whether the appender will
3167
+ flush at the end of each write.
2710
3168
  </summary>
2711
3169
  <remarks>
2712
3170
  <para>The default behavior is to flush at the end of each
@@ -2829,6 +3287,14 @@
2829
3287
  </para>
2830
3288
  </remarks>
2831
3289
  </member>
3290
+ <member name="M:log4net.Appender.EventLogAppender.CreateEventSource(System.String,System.String,System.String)">
3291
+ <summary>
3292
+ Create an event log source
3293
+ </summary>
3294
+ <remarks>
3295
+ Uses different API calls under NET_2_0
3296
+ </remarks>
3297
+ </member>
2832
3298
  <member name="M:log4net.Appender.EventLogAppender.Append(log4net.Core.LoggingEvent)">
2833
3299
  <summary>
2834
3300
  This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/>
@@ -3118,6 +3584,19 @@
3118
3584
  </para>
3119
3585
  </remarks>
3120
3586
  </member>
3587
+ <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])">
3588
+ <summary>
3589
+ This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])"/>
3590
+ method.
3591
+ </summary>
3592
+ <param name="loggingEvents">The array of events to log.</param>
3593
+ <remarks>
3594
+ <para>
3595
+ This method writes all the bulk logged events to the output writer
3596
+ before flushing the stream.
3597
+ </para>
3598
+ </remarks>
3599
+ </member>
3121
3600
  <member name="M:log4net.Appender.TextWriterAppender.OnClose">
3122
3601
  <summary>
3123
3602
  Close this appender instance. The underlying stream or writer is also closed.
@@ -3380,7 +3859,20 @@
3380
3859
  and is writable.
3381
3860
  </para>
3382
3861
  <para>
3383
- The format of the output will depend on the appender's layout.
3862
+ The format of the output will depend on the appender's layout.
3863
+ </para>
3864
+ </remarks>
3865
+ </member>
3866
+ <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])">
3867
+ <summary>
3868
+ This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])"/>
3869
+ method.
3870
+ </summary>
3871
+ <param name="loggingEvents">The array of events to log.</param>
3872
+ <remarks>
3873
+ <para>
3874
+ Acquires the output file locks once before writing all the events to
3875
+ the stream.
3384
3876
  </para>
3385
3877
  </remarks>
3386
3878
  </member>
@@ -3926,7 +4418,7 @@
3926
4418
  </member>
3927
4419
  <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)">
3928
4420
  <summary>
3929
- Append the logging event.
4421
+ Forward the logging event to the attached appenders
3930
4422
  </summary>
3931
4423
  <param name="loggingEvent">The event to log.</param>
3932
4424
  <remarks>
@@ -3935,6 +4427,17 @@
3935
4427
  </para>
3936
4428
  </remarks>
3937
4429
  </member>
4430
+ <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])">
4431
+ <summary>
4432
+ Forward the logging events to the attached appenders
4433
+ </summary>
4434
+ <param name="loggingEvents">The array of events to log.</param>
4435
+ <remarks>
4436
+ <para>
4437
+ Delivers the logging events to all the attached appenders.
4438
+ </para>
4439
+ </remarks>
4440
+ </member>
3938
4441
  <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)">
3939
4442
  <summary>
3940
4443
  Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
@@ -4158,10 +4661,19 @@
4158
4661
  Open connection to system logger.
4159
4662
  </summary>
4160
4663
  </member>
4161
- <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String)">
4664
+ <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)">
4162
4665
  <summary>
4163
4666
  Generate a log message.
4164
4667
  </summary>
4668
+ <remarks>
4669
+ <para>
4670
+ The libc syslog method takes a format string and a variable argument list similar
4671
+ to the classic printf function. As this type of vararg list is not supported
4672
+ by C# we need to specify the arguments explicitly. Here we have specified the
4673
+ format string with a single message argument. The caller must set the format
4674
+ string to <c>"%s"</c>.
4675
+ </para>
4676
+ </remarks>
4165
4677
  </member>
4166
4678
  <member name="M:log4net.Appender.LocalSyslogAppender.closelog">
4167
4679
  <summary>
@@ -4457,58 +4969,403 @@
4457
4969
  </summary>
4458
4970
  <param name="loggingEvent">the event to log</param>
4459
4971
  <remarks>
4460
- <para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
4972
+ <para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
4973
+ </remarks>
4974
+ </member>
4975
+ <member name="M:log4net.Appender.MemoryAppender.Clear">
4976
+ <summary>
4977
+ Clear the list of events
4978
+ </summary>
4979
+ <remarks>
4980
+ Clear the list of events
4981
+ </remarks>
4982
+ </member>
4983
+ <member name="F:log4net.Appender.MemoryAppender.m_eventsList">
4984
+ <summary>
4985
+ The list of events that have been appended.
4986
+ </summary>
4987
+ </member>
4988
+ <member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
4989
+ <summary>
4990
+ Value indicating which fields in the event should be fixed
4991
+ </summary>
4992
+ <remarks>
4993
+ By default all fields are fixed
4994
+ </remarks>
4995
+ </member>
4996
+ <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
4997
+ <summary>
4998
+ Gets or sets a value indicating whether only part of the logging event
4999
+ data should be fixed.
5000
+ </summary>
5001
+ <value>
5002
+ <c>true</c> if the appender should only fix part of the logging event
5003
+ data, otherwise <c>false</c>. The default is <c>false</c>.
5004
+ </value>
5005
+ <remarks>
5006
+ <para>
5007
+ Setting this property to <c>true</c> will cause only part of the event
5008
+ data to be fixed and stored in the appender, hereby improving performance.
5009
+ </para>
5010
+ <para>
5011
+ See <see cref="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)"/> for more information.
5012
+ </para>
5013
+ </remarks>
5014
+ </member>
5015
+ <member name="P:log4net.Appender.MemoryAppender.Fix">
5016
+ <summary>
5017
+ Gets or sets the fields that will be fixed in the event
5018
+ </summary>
5019
+ <remarks>
5020
+ <para>
5021
+ The logging event needs to have certain thread specific values
5022
+ captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
5023
+ for details.
5024
+ </para>
5025
+ </remarks>
5026
+ </member>
5027
+ <member name="T:log4net.Appender.NetSendAppender">
5028
+ <summary>
5029
+ Logs entries by sending network messages using the
5030
+ <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/> native function.
5031
+ </summary>
5032
+ <remarks>
5033
+ <para>
5034
+ You can send messages only to names that are active
5035
+ on the network. If you send the message to a user name,
5036
+ that user must be logged on and running the Messenger
5037
+ service to receive the message.
5038
+ </para>
5039
+ <para>
5040
+ The receiver will get a top most window displaying the
5041
+ messages one at a time, therefore this appender should
5042
+ not be used to deliver a high volume of messages.
5043
+ </para>
5044
+ <para>
5045
+ The following table lists some possible uses for this appender :
5046
+ </para>
5047
+ <para>
5048
+ <list type="table">
5049
+ <listheader>
5050
+ <term>Action</term>
5051
+ <description>Property Value(s)</description>
5052
+ </listheader>
5053
+ <item>
5054
+ <term>Send a message to a user account on the local machine</term>
5055
+ <description>
5056
+ <para>
5057
+ <paramref name="Server"/> = &lt;name of the local machine&gt;
5058
+ </para>
5059
+ <para>
5060
+ <paramref name="Recipient"/> = &lt;user name&gt;
5061
+ </para>
5062
+ </description>
5063
+ </item>
5064
+ <item>
5065
+ <term>Send a message to a user account on a remote machine</term>
5066
+ <description>
5067
+ <para>
5068
+ <paramref name="Server"/> = &lt;name of the remote machine&gt;
5069
+ </para>
5070
+ <para>
5071
+ <paramref name="Recipient"/> = &lt;user name&gt;
5072
+ </para>
5073
+ </description>
5074
+ </item>
5075
+ <item>
5076
+ <term>Send a message to a domain user account</term>
5077
+ <description>
5078
+ <para>
5079
+ <paramref name="Server"/> = &lt;name of a domain controller | uninitialized&gt;
5080
+ </para>
5081
+ <para>
5082
+ <paramref name="Recipient"/> = &lt;user name&gt;
5083
+ </para>
5084
+ </description>
5085
+ </item>
5086
+ <item>
5087
+ <term>Send a message to all the names in a workgroup or domain</term>
5088
+ <description>
5089
+ <para>
5090
+ <paramref name="Recipient"/> = &lt;workgroup name | domain name&gt;*
5091
+ </para>
5092
+ </description>
5093
+ </item>
5094
+ <item>
5095
+ <term>Send a message from the local machine to a remote machine</term>
5096
+ <description>
5097
+ <para>
5098
+ <paramref name="Server"/> = &lt;name of the local machine | uninitialized&gt;
5099
+ </para>
5100
+ <para>
5101
+ <paramref name="Recipient"/> = &lt;name of the remote machine&gt;
5102
+ </para>
5103
+ </description>
5104
+ </item>
5105
+ </list>
5106
+ </para>
5107
+ <para>
5108
+ <b>Note :</b> security restrictions apply for sending
5109
+ network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/>
5110
+ for more information.
5111
+ </para>
5112
+ </remarks>
5113
+ <example>
5114
+ <para>
5115
+ An example configuration section to log information
5116
+ using this appender from the local machine, named
5117
+ LOCAL_PC, to machine OPERATOR_PC :
5118
+ </para>
5119
+ <code lang="XML" escaped="true">
5120
+ <appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender">
5121
+ <server value="LOCAL_PC"/>
5122
+ <recipient value="OPERATOR_PC"/>
5123
+ <layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n"/>
5124
+ </appender>
5125
+ </code>
5126
+ </example>
5127
+ <author>Nicko Cadell</author>
5128
+ <author>Gert Driesen</author>
5129
+ </member>
5130
+ <member name="F:log4net.Appender.NetSendAppender.m_server">
5131
+ <summary>
5132
+ The DNS or NetBIOS name of the server on which the function is to execute.
5133
+ </summary>
5134
+ </member>
5135
+ <member name="F:log4net.Appender.NetSendAppender.m_sender">
5136
+ <summary>
5137
+ The sender of the network message.
5138
+ </summary>
5139
+ </member>
5140
+ <member name="F:log4net.Appender.NetSendAppender.m_recipient">
5141
+ <summary>
5142
+ The message alias to which the message should be sent.
5143
+ </summary>
5144
+ </member>
5145
+ <member name="F:log4net.Appender.NetSendAppender.m_securityContext">
5146
+ <summary>
5147
+ The security context to use for privileged calls
5148
+ </summary>
5149
+ </member>
5150
+ <member name="M:log4net.Appender.NetSendAppender.#ctor">
5151
+ <summary>
5152
+ Initializes the appender.
5153
+ </summary>
5154
+ <remarks>
5155
+ The default constructor initializes all fields to their default values.
5156
+ </remarks>
5157
+ </member>
5158
+ <member name="M:log4net.Appender.NetSendAppender.ActivateOptions">
5159
+ <summary>
5160
+ Initialize the appender based on the options set.
5161
+ </summary>
5162
+ <remarks>
5163
+ <para>
5164
+ This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
5165
+ activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must
5166
+ be called on this object after the configuration properties have
5167
+ been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this
5168
+ object is in an undefined state and must not be used.
5169
+ </para>
5170
+ <para>
5171
+ If any of the configuration properties are modified then
5172
+ <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again.
5173
+ </para>
5174
+ <para>
5175
+ The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was specified.
5176
+ </para>
5177
+ </remarks>
5178
+ <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was not specified.</exception>
5179
+ </member>
5180
+ <member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)">
5181
+ <summary>
5182
+ This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
5183
+ </summary>
5184
+ <param name="loggingEvent">The event to log.</param>
5185
+ <remarks>
5186
+ <para>
5187
+ Sends the event using a network message.
5188
+ </para>
5189
+ </remarks>
5190
+ </member>
5191
+ <member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)">
5192
+ <summary>
5193
+ Sends a buffer of information to a registered message alias.
5194
+ </summary>
5195
+ <param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param>
5196
+ <param name="msgName">The message alias to which the message buffer should be sent</param>
5197
+ <param name="fromName">The originator of the message.</param>
5198
+ <param name="buffer">The message text.</param>
5199
+ <param name="bufferSize">The length, in bytes, of the message text.</param>
5200
+ <remarks>
5201
+ <para>
5202
+ The following restrictions apply for sending network messages:
5203
+ </para>
5204
+ <para>
5205
+ <list type="table">
5206
+ <listheader>
5207
+ <term>Platform</term>
5208
+ <description>Requirements</description>
5209
+ </listheader>
5210
+ <item>
5211
+ <term>Windows NT</term>
5212
+ <description>
5213
+ <para>
5214
+ No special group membership is required to send a network message.
5215
+ </para>
5216
+ <para>
5217
+ Admin, Accounts, Print, or Server Operator group membership is required to
5218
+ successfully send a network message on a remote server.
5219
+ </para>
5220
+ </description>
5221
+ </item>
5222
+ <item>
5223
+ <term>Windows 2000 or later</term>
5224
+ <description>
5225
+ <para>
5226
+ If you send a message on a domain controller that is running Active Directory,
5227
+ access is allowed or denied based on the access control list (ACL) for the securable
5228
+ object. The default ACL permits only Domain Admins and Account Operators to send a network message.
5229
+ </para>
5230
+ <para>
5231
+ On a member server or workstation, only Administrators and Server Operators can send a network message.
5232
+ </para>
5233
+ </description>
5234
+ </item>
5235
+ </list>
5236
+ </para>
5237
+ <para>
5238
+ For more information see <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/security_requirements_for_the_network_management_functions.asp">Security Requirements for the Network Management Functions</a>.
5239
+ </para>
5240
+ </remarks>
5241
+ <returns>
5242
+ <para>
5243
+ If the function succeeds, the return value is zero.
5244
+ </para>
5245
+ </returns>
5246
+ </member>
5247
+ <member name="P:log4net.Appender.NetSendAppender.Sender">
5248
+ <summary>
5249
+ Gets or sets the sender of the message.
5250
+ </summary>
5251
+ <value>
5252
+ The sender of the message.
5253
+ </value>
5254
+ <remarks>
5255
+ If this property is not specified, the message is sent from the local computer.
5256
+ </remarks>
5257
+ </member>
5258
+ <member name="P:log4net.Appender.NetSendAppender.Recipient">
5259
+ <summary>
5260
+ Gets or sets the message alias to which the message should be sent.
5261
+ </summary>
5262
+ <value>
5263
+ The recipient of the message.
5264
+ </value>
5265
+ <remarks>
5266
+ This property should always be specified in order to send a message.
5267
+ </remarks>
5268
+ </member>
5269
+ <member name="P:log4net.Appender.NetSendAppender.Server">
5270
+ <summary>
5271
+ Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute.
5272
+ </summary>
5273
+ <value>
5274
+ DNS or NetBIOS name of the remote server on which the function is to execute.
5275
+ </value>
5276
+ <remarks>
5277
+ <para>
5278
+ For Windows NT 4.0 and earlier, the string should begin with \\.
5279
+ </para>
5280
+ <para>
5281
+ If this property is not specified, the local computer is used.
5282
+ </para>
5283
+ </remarks>
5284
+ </member>
5285
+ <member name="P:log4net.Appender.NetSendAppender.SecurityContext">
5286
+ <summary>
5287
+ Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
5288
+ </summary>
5289
+ <value>
5290
+ The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
5291
+ </value>
5292
+ <remarks>
5293
+ <para>
5294
+ Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender
5295
+ the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
5296
+ security context to use. The default behavior is to use the security context
5297
+ of the current thread.
5298
+ </para>
5299
+ </remarks>
5300
+ </member>
5301
+ <member name="P:log4net.Appender.NetSendAppender.RequiresLayout">
5302
+ <summary>
5303
+ This appender requires a <see cref="N:log4net.Layout"/> to be set.
5304
+ </summary>
5305
+ <value><c>true</c></value>
5306
+ <remarks>
5307
+ <para>
5308
+ This appender requires a <see cref="N:log4net.Layout"/> to be set.
5309
+ </para>
4461
5310
  </remarks>
4462
5311
  </member>
4463
- <member name="M:log4net.Appender.MemoryAppender.Clear">
5312
+ <member name="T:log4net.Appender.OutputDebugStringAppender">
4464
5313
  <summary>
4465
- Clear the list of events
5314
+ Appends log events to the OutputDebugString system.
4466
5315
  </summary>
4467
5316
  <remarks>
4468
- Clear the list of events
5317
+ <para>
5318
+ OutputDebugStringAppender appends log events to the
5319
+ OutputDebugString system.
5320
+ </para>
5321
+ <para>
5322
+ The string is passed to the native <c>OutputDebugString</c>
5323
+ function.
5324
+ </para>
4469
5325
  </remarks>
5326
+ <author>Nicko Cadell</author>
5327
+ <author>Gert Driesen</author>
4470
5328
  </member>
4471
- <member name="F:log4net.Appender.MemoryAppender.m_eventsList">
5329
+ <member name="M:log4net.Appender.OutputDebugStringAppender.#ctor">
4472
5330
  <summary>
4473
- The list of events that have been appended.
5331
+ Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender"/> class.
4474
5332
  </summary>
5333
+ <remarks>
5334
+ <para>
5335
+ Default constructor.
5336
+ </para>
5337
+ </remarks>
4475
5338
  </member>
4476
- <member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
5339
+ <member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)">
4477
5340
  <summary>
4478
- Value indicating which fields in the event should be fixed
5341
+ Write the logging event to the output debug string API
4479
5342
  </summary>
5343
+ <param name="loggingEvent">the event to log</param>
4480
5344
  <remarks>
4481
- By default all fields are fixed
5345
+ <para>
5346
+ Write the logging event to the output debug string API
5347
+ </para>
4482
5348
  </remarks>
4483
5349
  </member>
4484
- <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
5350
+ <member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)">
4485
5351
  <summary>
4486
- Gets or sets a value indicating whether only part of the logging event
4487
- data should be fixed.
5352
+ Stub for OutputDebugString native method
4488
5353
  </summary>
4489
- <value>
4490
- <c>true</c> if the appender should only fix part of the logging event
4491
- data, otherwise <c>false</c>. The default is <c>false</c>.
4492
- </value>
5354
+ <param name="message">the string to output</param>
4493
5355
  <remarks>
4494
5356
  <para>
4495
- Setting this property to <c>true</c> will cause only part of the event
4496
- data to be fixed and stored in the appender, hereby improving performance.
4497
- </para>
4498
- <para>
4499
- See <see cref="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)"/> for more information.
5357
+ Stub for OutputDebugString native method
4500
5358
  </para>
4501
5359
  </remarks>
4502
5360
  </member>
4503
- <member name="P:log4net.Appender.MemoryAppender.Fix">
5361
+ <member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout">
4504
5362
  <summary>
4505
- Gets or sets a the fields that will be fixed in the event
5363
+ This appender requires a <see cref="N:log4net.Layout"/> to be set.
4506
5364
  </summary>
5365
+ <value><c>true</c></value>
4507
5366
  <remarks>
4508
5367
  <para>
4509
- The logging event needs to have certain thread specific values
4510
- captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
4511
- for details.
5368
+ This appender requires a <see cref="N:log4net.Layout"/> to be set.
4512
5369
  </para>
4513
5370
  </remarks>
4514
5371
  </member>
@@ -4555,83 +5412,83 @@
4555
5412
  <author>Nicko Cadell</author>
4556
5413
  </member>
4557
5414
  <member name="T:log4net.Appender.UdpAppender">
4558
- <summary>
4559
- Sends logging events as connectionless UDP datagrams to a remote host or a
4560
- multicast group using an <see cref="T:System.Net.Sockets.UdpClient"/>.
4561
- </summary>
4562
- <remarks>
4563
- <para>
4564
- UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
4565
- </para>
4566
- <para>
4567
- To view the logging results, a custom application can be developed that listens for logging
4568
- events.
4569
- </para>
4570
- <para>
4571
- When decoding events send via this appender remember to use the same encoding
4572
- to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
4573
- property to specify the encoding to use.
4574
- </para>
4575
- </remarks>
4576
- <example>
4577
- This example shows how to log receive logging events that are sent
4578
- on IP address 244.0.0.1 and port 8080 to the console. The event is
4579
- encoded in the packet as a unicode string and it is decoded as such.
4580
- <code lang="C#">
4581
- IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
4582
- UdpClient udpClient;
4583
- byte[] buffer;
4584
- string loggingEvent;
4585
-
4586
- try
4587
- {
4588
- udpClient = new UdpClient(8080);
4589
-
4590
- while(true)
4591
- {
4592
- buffer = udpClient.Receive(ref remoteEndPoint);
4593
- loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
4594
- Console.WriteLine(loggingEvent);
4595
- }
4596
- }
4597
- catch(Exception e)
4598
- {
4599
- Console.WriteLine(e.ToString());
4600
- }
4601
- </code>
4602
- <code lang="Visual Basic">
4603
- Dim remoteEndPoint as IPEndPoint
4604
- Dim udpClient as UdpClient
4605
- Dim buffer as Byte()
4606
- Dim loggingEvent as String
4607
-
4608
- Try
4609
- remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
4610
- udpClient = new UdpClient(8080)
5415
+ <summary>
5416
+ Sends logging events as connectionless UDP datagrams to a remote host or a
5417
+ multicast group using an <see cref="T:System.Net.Sockets.UdpClient"/>.
5418
+ </summary>
5419
+ <remarks>
5420
+ <para>
5421
+ UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
5422
+ </para>
5423
+ <para>
5424
+ To view the logging results, a custom application can be developed that listens for logging
5425
+ events.
5426
+ </para>
5427
+ <para>
5428
+ When decoding events send via this appender remember to use the same encoding
5429
+ to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
5430
+ property to specify the encoding to use.
5431
+ </para>
5432
+ </remarks>
5433
+ <example>
5434
+ This example shows how to log receive logging events that are sent
5435
+ on IP address 244.0.0.1 and port 8080 to the console. The event is
5436
+ encoded in the packet as a unicode string and it is decoded as such.
5437
+ <code lang="C#">
5438
+ IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
5439
+ UdpClient udpClient;
5440
+ byte[] buffer;
5441
+ string loggingEvent;
5442
+
5443
+ try
5444
+ {
5445
+ udpClient = new UdpClient(8080);
5446
+
5447
+ while(true)
5448
+ {
5449
+ buffer = udpClient.Receive(ref remoteEndPoint);
5450
+ loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
5451
+ Console.WriteLine(loggingEvent);
5452
+ }
5453
+ }
5454
+ catch(Exception e)
5455
+ {
5456
+ Console.WriteLine(e.ToString());
5457
+ }
5458
+ </code>
5459
+ <code lang="Visual Basic">
5460
+ Dim remoteEndPoint as IPEndPoint
5461
+ Dim udpClient as UdpClient
5462
+ Dim buffer as Byte()
5463
+ Dim loggingEvent as String
5464
+
5465
+ Try
5466
+ remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
5467
+ udpClient = new UdpClient(8080)
4611
5468
 
4612
- While True
4613
- buffer = udpClient.Receive(ByRef remoteEndPoint)
4614
- loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
4615
- Console.WriteLine(loggingEvent)
4616
- Wend
4617
- Catch e As Exception
4618
- Console.WriteLine(e.ToString())
4619
- End Try
4620
- </code>
4621
- <para>
4622
- An example configuration section to log information using this appender to the
4623
- IP 224.0.0.1 on port 8080:
4624
- </para>
4625
- <code lang="XML" escaped="true">
4626
- <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
4627
- <remoteAddress value="224.0.0.1"/>
4628
- <remotePort value="8080"/>
4629
- <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline"/>
4630
- </appender>
4631
- </code>
4632
- </example>
4633
- <author>Gert Driesen</author>
4634
- <author>Nicko Cadell</author>
5469
+ While True
5470
+ buffer = udpClient.Receive(ByRef remoteEndPoint)
5471
+ loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
5472
+ Console.WriteLine(loggingEvent)
5473
+ Wend
5474
+ Catch e As Exception
5475
+ Console.WriteLine(e.ToString())
5476
+ End Try
5477
+ </code>
5478
+ <para>
5479
+ An example configuration section to log information using this appender to the
5480
+ IP 224.0.0.1 on port 8080:
5481
+ </para>
5482
+ <code lang="XML" escaped="true">
5483
+ <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
5484
+ <remoteAddress value="224.0.0.1"/>
5485
+ <remotePort value="8080"/>
5486
+ <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline"/>
5487
+ </appender>
5488
+ </code>
5489
+ </example>
5490
+ <author>Gert Driesen</author>
5491
+ <author>Nicko Cadell</author>
4635
5492
  </member>
4636
5493
  <member name="M:log4net.Appender.UdpAppender.#ctor">
4637
5494
  <summary>
@@ -5230,12 +6087,11 @@
5230
6087
  number of non obvious reasons. The remoting infrastructure will
5231
6088
  flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
5232
6089
  if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
5233
- remoting boundary. This means that a large amount of unnecessary data could
5234
- be flowed across the remoting boundary. If the server is not contactable then
6090
+ remoting boundary. If the server is not contactable then
5235
6091
  the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
5236
6092
  objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
5237
6093
  having side effects on the calling application the remoting call must be made
5238
- from a separate thread to the use used by the application. A <see cref="T:System.Threading.ThreadPool"/>
6094
+ from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
5239
6095
  thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
5240
6096
  the events will block in the thread pool manager until a thread is available.</para>
5241
6097
  <para>
@@ -5244,9 +6100,9 @@
5244
6100
  When closing the appender attempts to wait until all the queued events have been sent, but
5245
6101
  this will timeout after 30 seconds regardless.</para>
5246
6102
  <para>
5247
- If this appender is being closed because the <see cref="F:System.AppDomain.ProcessExit"/>
6103
+ If this appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
5248
6104
  event has fired it may not be possible to send all the queued events. During process
5249
- exit the runtime limits the time that a <see cref="F:System.AppDomain.ProcessExit"/>
6105
+ exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
5250
6106
  event handler is allowed to run for. If the runtime terminates the threads before
5251
6107
  the queued events have been sent then they will be lost. To ensure that all events
5252
6108
  are sent the appender must be closed before the application exits. See
@@ -5296,12 +6152,11 @@
5296
6152
  This is very important for a number of non obvious reasons. The remoting
5297
6153
  infrastructure will flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
5298
6154
  if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
5299
- remoting boundary. This means that a large amount of unnecessary data could
5300
- be flowed across the remoting boundary. If the server is not contactable then
6155
+ remoting boundary. If the server is not contactable then
5301
6156
  the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
5302
6157
  objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
5303
6158
  having side effects on the calling application the remoting call must be made
5304
- from a separate thread to the use used by the application. A <see cref="T:System.Threading.ThreadPool"/>
6159
+ from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
5305
6160
  thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
5306
6161
  the events will block in the thread pool manager until a thread is available.
5307
6162
  </remarks>
@@ -5322,9 +6177,9 @@
5322
6177
  This method attempts to wait until all the queued events have been sent, but this
5323
6178
  method will timeout after 30 seconds regardless.</para>
5324
6179
  <para>
5325
- If the appender is being closed because the <see cref="F:System.AppDomain.ProcessExit"/>
6180
+ If the appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
5326
6181
  event has fired it may not be possible to send all the queued events. During process
5327
- exit the runtime limits the time that a <see cref="F:System.AppDomain.ProcessExit"/>
6182
+ exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
5328
6183
  event handler is allowed to run for.</para>
5329
6184
  </remarks>
5330
6185
  </member>
@@ -5520,7 +6375,32 @@
5520
6375
  <param name="loggingEvent">the event to write to file.</param>
5521
6376
  <remarks>
5522
6377
  <para>
5523
- Handles append time behavior for CompositeRollingAppender. This checks
6378
+ Handles append time behavior for RollingFileAppender. This checks
6379
+ if a roll over either by date (checked first) or time (checked second)
6380
+ is need and then appends to the file last.
6381
+ </para>
6382
+ </remarks>
6383
+ </member>
6384
+ <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])">
6385
+ <summary>
6386
+ Write out an array of logging events.
6387
+ </summary>
6388
+ <param name="loggingEvents">the events to write to file.</param>
6389
+ <remarks>
6390
+ <para>
6391
+ Handles append time behavior for RollingFileAppender. This checks
6392
+ if a roll over either by date (checked first) or time (checked second)
6393
+ is need and then appends to the file last.
6394
+ </para>
6395
+ </remarks>
6396
+ </member>
6397
+ <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend">
6398
+ <summary>
6399
+ Performs any required rolling before outputting the next event
6400
+ </summary>
6401
+ <remarks>
6402
+ <para>
6403
+ Handles append time behavior for RollingFileAppender. This checks
5524
6404
  if a roll over either by date (checked first) or time (checked second)
5525
6405
  is need and then appends to the file last.
5526
6406
  </para>
@@ -5711,7 +6591,7 @@
5711
6591
  <para>
5712
6592
  If the maximum number of size based backups is reached
5713
6593
  (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
5714
- file is deleted -- it's index determined by the sign of countDirection.
6594
+ file is deleted -- its index determined by the sign of countDirection.
5715
6595
  If <c>countDirection</c> &lt; 0, then files
5716
6596
  {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
5717
6597
  are renamed to {<c>File.2</c>, ...,
@@ -5740,7 +6620,7 @@
5740
6620
  <para>
5741
6621
  If the maximum number of size based backups is reached
5742
6622
  (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
5743
- file is deleted -- it's index determined by the sign of countDirection.
6623
+ file is deleted -- its index determined by the sign of countDirection.
5744
6624
  If <c>countDirection</c> &lt; 0, then files
5745
6625
  {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
5746
6626
  are renamed to {<c>File.2</c>, ...,
@@ -5761,15 +6641,20 @@
5761
6641
  </member>
5762
6642
  <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)">
5763
6643
  <summary>
5764
- Roll on to the next interval after the date passed
6644
+ Get the start time of the next window for the current rollpoint
5765
6645
  </summary>
5766
6646
  <param name="currentDateTime">the current date</param>
5767
6647
  <param name="rollPoint">the type of roll point we are working with</param>
5768
- <returns>the next roll point an interval after the currentDateTime date</returns>
6648
+ <returns>the start time for the next roll point an interval after the currentDateTime date</returns>
5769
6649
  <remarks>
5770
6650
  <para>
5771
- Advances the date to the next roll point after the
5772
- currentDateTime date passed to the method.
6651
+ Returns the date of the next roll point after the currentDateTime date passed to the method.
6652
+ </para>
6653
+ <para>
6654
+ The basic strategy is to subtract the time parts that are less significant
6655
+ than the rollpoint from the current time. This should roll the time back to
6656
+ the start of the time window for the current rollpoint. Then we add 1 window
6657
+ worth of time and get the start time of the next window for the rollpoint.
5773
6658
  </para>
5774
6659
  </remarks>
5775
6660
  </member>
@@ -6188,6 +7073,12 @@
6188
7073
  </summary>
6189
7074
  <param name="events">The logging events to send.</param>
6190
7075
  </member>
7076
+ <member name="M:log4net.Appender.SmtpAppender.SendEmail(System.String)">
7077
+ <summary>
7078
+ Send the email message
7079
+ </summary>
7080
+ <param name="messageBody">the body text to include in the mail</param>
7081
+ </member>
6191
7082
  <member name="P:log4net.Appender.SmtpAppender.To">
6192
7083
  <summary>
6193
7084
  Gets or sets a semicolon-delimited list of recipient e-mail addresses.
@@ -6312,6 +7203,24 @@
6312
7203
  </para>
6313
7204
  </remarks>
6314
7205
  </member>
7206
+ <member name="P:log4net.Appender.SmtpAppender.Priority">
7207
+ <summary>
7208
+ Gets or sets the priority of the e-mail message
7209
+ </summary>
7210
+ <value>
7211
+ One of the <see cref="T:System.Net.Mail.MailPriority"/> values.
7212
+ </value>
7213
+ <remarks>
7214
+ <para>
7215
+ Sets the priority of the e-mails generated by this
7216
+ appender. The default priority is <see cref="F:System.Net.Mail.MailPriority.Normal"/>.
7217
+ </para>
7218
+ <para>
7219
+ If you are using this appender to report errors then
7220
+ you may want to set the priority to <see cref="F:System.Net.Mail.MailPriority.High"/>.
7221
+ </para>
7222
+ </remarks>
7223
+ </member>
6315
7224
  <member name="P:log4net.Appender.SmtpAppender.RequiresLayout">
6316
7225
  <summary>
6317
7226
  This appender requires a <see cref="N:log4net.Layout"/> to be set.
@@ -7730,6 +8639,21 @@
7730
8639
  </remarks>
7731
8640
  </member>
7732
8641
  <member name="M:log4net.Config.PluginAttribute.#ctor(System.String)">
8642
+ <summary>
8643
+ Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
8644
+ with the specified type.
8645
+ </summary>
8646
+ <param name="typeName">The type name of plugin to create.</param>
8647
+ <remarks>
8648
+ <para>
8649
+ Create the attribute with the plugin type specified.
8650
+ </para>
8651
+ <para>
8652
+ Where possible use the constructor that takes a <see cref="T:System.Type"/>.
8653
+ </para>
8654
+ </remarks>
8655
+ </member>
8656
+ <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)">
7733
8657
  <summary>
7734
8658
  Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
7735
8659
  with the specified type.
@@ -7766,6 +8690,19 @@
7766
8690
  <returns>A representation of the properties of this object</returns>
7767
8691
  </member>
7768
8692
  <member name="P:log4net.Config.PluginAttribute.Type">
8693
+ <summary>
8694
+ Gets or sets the type for the plugin.
8695
+ </summary>
8696
+ <value>
8697
+ The type for the plugin.
8698
+ </value>
8699
+ <remarks>
8700
+ <para>
8701
+ The type for the plugin.
8702
+ </para>
8703
+ </remarks>
8704
+ </member>
8705
+ <member name="P:log4net.Config.PluginAttribute.TypeName">
7769
8706
  <summary>
7770
8707
  Gets or sets the type name for the plugin.
7771
8708
  </summary>
@@ -7776,6 +8713,9 @@
7776
8713
  <para>
7777
8714
  The type name for the plugin.
7778
8715
  </para>
8716
+ <para>
8717
+ Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead.
8718
+ </para>
7779
8719
  </remarks>
7780
8720
  </member>
7781
8721
  <member name="T:log4net.Config.SecurityContextProviderAttribute">
@@ -8496,8 +9436,8 @@
8496
9436
  <returns><c>true</c> if the repository exists</returns>
8497
9437
  <remarks>
8498
9438
  <para>
8499
- Test if a named repository exists. Use <see cref="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)"/>
8500
- to create a new repository and <see cref="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)"/> to retrieve
9439
+ Test if a named repository exists. Use <see cref="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)"/>
9440
+ to create a new repository and <see cref="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)"/> to retrieve
8501
9441
  a repository.
8502
9442
  </para>
8503
9443
  </remarks>
@@ -8578,7 +9518,7 @@
8578
9518
  <para>
8579
9519
  The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository
8580
9520
  to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/>
8581
- attribute on the <paramref name="assembly"/>.
9521
+ attribute on the <paramref name="repositoryAssembly"/>.
8582
9522
  </para>
8583
9523
  <para>
8584
9524
  The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
@@ -8588,11 +9528,11 @@
8588
9528
  <para>
8589
9529
  The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using
8590
9530
  any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on
8591
- the <paramref name="assembly"/>.
9531
+ the <paramref name="repositoryAssembly"/>.
8592
9532
  </para>
8593
9533
  </remarks>
8594
9534
  <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns>
8595
- <exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is <see langword="null"/>.</exception>
9535
+ <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
8596
9536
  </member>
8597
9537
  <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)">
8598
9538
  <summary>
@@ -8630,7 +9570,7 @@
8630
9570
  The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
8631
9571
  the repository to create can be overridden by specifying the
8632
9572
  <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
8633
- <paramref name="assembly"/>. The default values are to use the
9573
+ <paramref name="repositoryAssembly"/>. The default values are to use the
8634
9574
  <paramref name="repositoryType"/> implementation of the
8635
9575
  <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
8636
9576
  <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
@@ -8670,7 +9610,7 @@
8670
9610
  The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
8671
9611
  the repository to create can be overridden by specifying the
8672
9612
  <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
8673
- <paramref name="assembly"/>. The default values are to use the
9613
+ <paramref name="repositoryAssembly"/>. The default values are to use the
8674
9614
  <paramref name="repositoryType"/> implementation of the
8675
9615
  <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
8676
9616
  <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
@@ -8717,8 +9657,8 @@
8717
9657
  <returns><c>true</c> if the repository exists</returns>
8718
9658
  <remarks>
8719
9659
  <para>
8720
- Test if a named repository exists. Use <see cref="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)"/>
8721
- to create a new repository and <see cref="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)"/> to retrieve
9660
+ Test if a named repository exists. Use <see cref="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)"/>
9661
+ to create a new repository and <see cref="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)"/> to retrieve
8722
9662
  a repository.
8723
9663
  </para>
8724
9664
  </remarks>
@@ -8969,6 +9909,11 @@
8969
9909
  This interface supports logging events and testing if a level
8970
9910
  is enabled for logging.
8971
9911
  </para>
9912
+ <para>
9913
+ These methods will not throw exceptions. Note to implementor, ensure
9914
+ that the implementation of these methods cannot allow an exception
9915
+ to be thrown to the caller.
9916
+ </para>
8972
9917
  </remarks>
8973
9918
  <author>Nicko Cadell</author>
8974
9919
  <author>Gert Driesen</author>
@@ -10255,6 +11200,13 @@
10255
11200
  This class is used by the wrapper managers (e.g. <see cref="T:log4net.LogManager"/>)
10256
11201
  to provide access to the <see cref="T:log4net.Core.ILogger"/> objects.
10257
11202
  </para>
11203
+ <para>
11204
+ This manager also holds the <see cref="T:log4net.Core.IRepositorySelector"/> that is used to
11205
+ lookup and create repositories. The selector can be set either programmatically using
11206
+ the <see cref="P:log4net.Core.LoggerManager.RepositorySelector"/> property, or by setting the <c>log4net.RepositorySelector</c>
11207
+ AppSetting in the applications config file to the fully qualified type name of the
11208
+ selector to use.
11209
+ </para>
10258
11210
  </remarks>
10259
11211
  <author>Nicko Cadell</author>
10260
11212
  <author>Gert Driesen</author>
@@ -10701,13 +11653,13 @@
10701
11653
  </member>
10702
11654
  <member name="M:log4net.Core.LoggerManager.OnDomainUnload(System.Object,System.EventArgs)">
10703
11655
  <summary>
10704
- Called when the <see cref="F:System.AppDomain.DomainUnload"/> event fires
11656
+ Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires
10705
11657
  </summary>
10706
11658
  <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
10707
11659
  <param name="e">null</param>
10708
11660
  <remarks>
10709
11661
  <para>
10710
- Called when the <see cref="F:System.AppDomain.DomainUnload"/> event fires.
11662
+ Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires.
10711
11663
  </para>
10712
11664
  <para>
10713
11665
  When the event is triggered the log4net system is <see cref="M:log4net.Core.LoggerManager.Shutdown"/>.
@@ -10716,13 +11668,13 @@
10716
11668
  </member>
10717
11669
  <member name="M:log4net.Core.LoggerManager.OnProcessExit(System.Object,System.EventArgs)">
10718
11670
  <summary>
10719
- Called when the <see cref="F:System.AppDomain.ProcessExit"/> event fires
11671
+ Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires
10720
11672
  </summary>
10721
11673
  <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
10722
11674
  <param name="e">null</param>
10723
11675
  <remarks>
10724
11676
  <para>
10725
- Called when the <see cref="F:System.AppDomain.ProcessExit"/> event fires.
11677
+ Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires.
10726
11678
  </para>
10727
11679
  <para>
10728
11680
  When the event is triggered the log4net system is <see cref="M:log4net.Core.LoggerManager.Shutdown"/>.
@@ -11099,6 +12051,33 @@
11099
12051
  </para>
11100
12052
  </remarks>
11101
12053
  </member>
12054
+ <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData,log4net.Core.FixFlags)">
12055
+ <summary>
12056
+ Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
12057
+ using specific data.
12058
+ </summary>
12059
+ <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
12060
+ the stack boundary into the logging system for this call.</param>
12061
+ <param name="repository">The repository this event is logged in.</param>
12062
+ <param name="data">Data used to initialize the logging event.</param>
12063
+ <param name="fixedData">The fields in the <paranref name="data"/> struct that have already been fixed.</param>
12064
+ <remarks>
12065
+ <para>
12066
+ This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
12067
+ to be created independently of the log4net framework. This can
12068
+ be useful if you require a custom serialization scheme.
12069
+ </para>
12070
+ <para>
12071
+ Use the <see cref="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)"/> method to obtain an
12072
+ instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
12073
+ </para>
12074
+ <para>
12075
+ The <paramref name="fixedData"/> parameter should be used to specify which fields in the
12076
+ <paramref name="data"/> struct have been preset. Fields not specified in the <paramref name="fixedData"/>
12077
+ will be captured from the environment if requested or fixed.
12078
+ </para>
12079
+ </remarks>
12080
+ </member>
11102
12081
  <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData)">
11103
12082
  <summary>
11104
12083
  Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
@@ -11115,8 +12094,14 @@
11115
12094
  be useful if you require a custom serialization scheme.
11116
12095
  </para>
11117
12096
  <para>
11118
- Use the <see cref="M:log4net.Core.LoggingEvent.GetLoggingEventData"/> method to obtain an
11119
- instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.</para>
12097
+ Use the <see cref="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)"/> method to obtain an
12098
+ instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
12099
+ </para>
12100
+ <para>
12101
+ This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
12102
+ this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
12103
+ parameter and no other data should be captured from the environment.
12104
+ </para>
11120
12105
  </remarks>
11121
12106
  </member>
11122
12107
  <member name="M:log4net.Core.LoggingEvent.#ctor(log4net.Core.LoggingEventData)">
@@ -11132,8 +12117,14 @@
11132
12117
  be useful if you require a custom serialization scheme.
11133
12118
  </para>
11134
12119
  <para>
11135
- Use the <see cref="M:log4net.Core.LoggingEvent.GetLoggingEventData"/> method to obtain an
11136
- instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.</para>
12120
+ Use the <see cref="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)"/> method to obtain an
12121
+ instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
12122
+ </para>
12123
+ <para>
12124
+ This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
12125
+ this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
12126
+ parameter and no other data should be captured from the environment.
12127
+ </para>
11137
12128
  </remarks>
11138
12129
  </member>
11139
12130
  <member name="M:log4net.Core.LoggingEvent.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
@@ -11418,6 +12409,15 @@
11418
12409
  Not serialized.
11419
12410
  </remarks>
11420
12411
  </member>
12412
+ <member name="F:log4net.Core.LoggingEvent.m_cacheUpdatable">
12413
+ <summary>
12414
+ Indicated that the internal cache is updateable (ie not fixed)
12415
+ </summary>
12416
+ <remarks>
12417
+ This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler
12418
+ changes in the caching strategy.
12419
+ </remarks>
12420
+ </member>
11421
12421
  <member name="P:log4net.Core.LoggingEvent.StartTime">
11422
12422
  <summary>
11423
12423
  Gets the time when the current process started.
@@ -11778,7 +12778,7 @@
11778
12778
  <remarks>
11779
12779
  <para>
11780
12780
  Use the <see cref="T:log4net.LogManager"/> to obtain logger instances
11781
- that implement this interface. The <see cref="M:log4net.LogManager.GetLogger(System.String)"/>
12781
+ that implement this interface. The <see cref="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)"/>
11782
12782
  static method is used to get logger instances.
11783
12783
  </para>
11784
12784
  <para>
@@ -11807,7 +12807,7 @@
11807
12807
  </code>
11808
12808
  </example>
11809
12809
  <seealso cref="T:log4net.LogManager"/>
11810
- <seealso cref="M:log4net.LogManager.GetLogger(System.String)"/>
12810
+ <seealso cref="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)"/>
11811
12811
  <author>Nicko Cadell</author>
11812
12812
  <author>Gert Driesen</author>
11813
12813
  </member>
@@ -11864,12 +12864,78 @@
11864
12864
  <remarks>
11865
12865
  <para>
11866
12866
  The message is formatted using the <c>String.Format</c> method. See
11867
- <see cref="M:System.String.Format(System.String,System.Object)"/> for details of the syntax of the format string and the behavior
12867
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
12868
+ of the formatting.
12869
+ </para>
12870
+ <para>
12871
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
12872
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Debug(System.Object,System.Exception)"/>
12873
+ methods instead.
12874
+ </para>
12875
+ </remarks>
12876
+ <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
12877
+ <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
12878
+ </member>
12879
+ <member name="M:log4net.ILog.DebugFormat(System.String,System.Object)">
12880
+ <summary>
12881
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
12882
+ </summary>
12883
+ <param name="format">A String containing zero or more format items</param>
12884
+ <param name="arg0">An Object to format</param>
12885
+ <remarks>
12886
+ <para>
12887
+ The message is formatted using the <c>String.Format</c> method. See
12888
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
12889
+ of the formatting.
12890
+ </para>
12891
+ <para>
12892
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
12893
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Debug(System.Object,System.Exception)"/>
12894
+ methods instead.
12895
+ </para>
12896
+ </remarks>
12897
+ <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
12898
+ <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
12899
+ </member>
12900
+ <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object)">
12901
+ <summary>
12902
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
12903
+ </summary>
12904
+ <param name="format">A String containing zero or more format items</param>
12905
+ <param name="arg0">An Object to format</param>
12906
+ <param name="arg1">An Object to format</param>
12907
+ <remarks>
12908
+ <para>
12909
+ The message is formatted using the <c>String.Format</c> method. See
12910
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
12911
+ of the formatting.
12912
+ </para>
12913
+ <para>
12914
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
12915
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Debug(System.Object,System.Exception)"/>
12916
+ methods instead.
12917
+ </para>
12918
+ </remarks>
12919
+ <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
12920
+ <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
12921
+ </member>
12922
+ <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
12923
+ <summary>
12924
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
12925
+ </summary>
12926
+ <param name="format">A String containing zero or more format items</param>
12927
+ <param name="arg0">An Object to format</param>
12928
+ <param name="arg1">An Object to format</param>
12929
+ <param name="arg2">An Object to format</param>
12930
+ <remarks>
12931
+ <para>
12932
+ The message is formatted using the <c>String.Format</c> method. See
12933
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
11868
12934
  of the formatting.
11869
12935
  </para>
11870
12936
  <para>
11871
12937
  This method does not take an <see cref="T:System.Exception"/> object to include in the
11872
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Debug(System.Object)"/>
12938
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Debug(System.Object,System.Exception)"/>
11873
12939
  methods instead.
11874
12940
  </para>
11875
12941
  </remarks>
@@ -11886,12 +12952,12 @@
11886
12952
  <remarks>
11887
12953
  <para>
11888
12954
  The message is formatted using the <c>String.Format</c> method. See
11889
- <see cref="M:System.String.Format(System.String,System.Object)"/> for details of the syntax of the format string and the behavior
12955
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
11890
12956
  of the formatting.
11891
12957
  </para>
11892
12958
  <para>
11893
12959
  This method does not take an <see cref="T:System.Exception"/> object to include in the
11894
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Debug(System.Object)"/>
12960
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Debug(System.Object,System.Exception)"/>
11895
12961
  methods instead.
11896
12962
  </para>
11897
12963
  </remarks>
@@ -11921,46 +12987,112 @@
11921
12987
  <see cref="M:log4net.ILog.Info(System.Object,System.Exception)"/> form instead.
11922
12988
  </para>
11923
12989
  </remarks>
11924
- <param name="message">The message object to log.</param>
12990
+ <param name="message">The message object to log.</param>
12991
+ <seealso cref="M:log4net.ILog.Info(System.Object,System.Exception)"/>
12992
+ <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
12993
+ </member>
12994
+ <member name="M:log4net.ILog.Info(System.Object,System.Exception)">
12995
+ <summary>
12996
+ Logs a message object with the <c>INFO</c> level including
12997
+ the stack trace of the <see cref="T:System.Exception"/> passed
12998
+ as a parameter.
12999
+ </summary>
13000
+ <param name="message">The message object to log.</param>
13001
+ <param name="exception">The exception to log, including its stack trace.</param>
13002
+ <remarks>
13003
+ <para>
13004
+ See the <see cref="M:log4net.ILog.Info(System.Object)"/> form for more detailed information.
13005
+ </para>
13006
+ </remarks>
13007
+ <seealso cref="M:log4net.ILog.Info(System.Object)"/>
13008
+ <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
13009
+ </member>
13010
+ <member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])">
13011
+ <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
13012
+ <summary>
13013
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
13014
+ </summary>
13015
+ <param name="format">A String containing zero or more format items</param>
13016
+ <param name="args">An Object array containing zero or more objects to format</param>
13017
+ <remarks>
13018
+ <para>
13019
+ The message is formatted using the <c>String.Format</c> method. See
13020
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13021
+ of the formatting.
13022
+ </para>
13023
+ <para>
13024
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13025
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Info(System.Object)"/>
13026
+ methods instead.
13027
+ </para>
13028
+ </remarks>
11925
13029
  <seealso cref="M:log4net.ILog.Info(System.Object,System.Exception)"/>
11926
13030
  <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
11927
13031
  </member>
11928
- <member name="M:log4net.ILog.Info(System.Object,System.Exception)">
13032
+ <member name="M:log4net.ILog.InfoFormat(System.String,System.Object)">
11929
13033
  <summary>
11930
- Logs a message object with the <c>INFO</c> level including
11931
- the stack trace of the <see cref="T:System.Exception"/> passed
11932
- as a parameter.
13034
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
11933
13035
  </summary>
11934
- <param name="message">The message object to log.</param>
11935
- <param name="exception">The exception to log, including its stack trace.</param>
13036
+ <param name="format">A String containing zero or more format items</param>
13037
+ <param name="arg0">An Object to format</param>
11936
13038
  <remarks>
11937
13039
  <para>
11938
- See the <see cref="M:log4net.ILog.Info(System.Object)"/> form for more detailed information.
13040
+ The message is formatted using the <c>String.Format</c> method. See
13041
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13042
+ of the formatting.
13043
+ </para>
13044
+ <para>
13045
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13046
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Info(System.Object,System.Exception)"/>
13047
+ methods instead.
11939
13048
  </para>
11940
13049
  </remarks>
11941
13050
  <seealso cref="M:log4net.ILog.Info(System.Object)"/>
11942
13051
  <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
11943
13052
  </member>
11944
- <member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])">
11945
- <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
13053
+ <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object)">
11946
13054
  <summary>
11947
13055
  Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
11948
13056
  </summary>
11949
13057
  <param name="format">A String containing zero or more format items</param>
11950
- <param name="args">An Object array containing zero or more objects to format</param>
13058
+ <param name="arg0">An Object to format</param>
13059
+ <param name="arg1">An Object to format</param>
11951
13060
  <remarks>
11952
13061
  <para>
11953
13062
  The message is formatted using the <c>String.Format</c> method. See
11954
- <see cref="M:System.String.Format(System.String,System.Object)"/> for details of the syntax of the format string and the behavior
13063
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
11955
13064
  of the formatting.
11956
13065
  </para>
11957
13066
  <para>
11958
13067
  This method does not take an <see cref="T:System.Exception"/> object to include in the
11959
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Info(System.Object)"/>
13068
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Info(System.Object,System.Exception)"/>
11960
13069
  methods instead.
11961
13070
  </para>
11962
13071
  </remarks>
11963
- <seealso cref="M:log4net.ILog.Info(System.Object,System.Exception)"/>
13072
+ <seealso cref="M:log4net.ILog.Info(System.Object)"/>
13073
+ <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
13074
+ </member>
13075
+ <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
13076
+ <summary>
13077
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
13078
+ </summary>
13079
+ <param name="format">A String containing zero or more format items</param>
13080
+ <param name="arg0">An Object to format</param>
13081
+ <param name="arg1">An Object to format</param>
13082
+ <param name="arg2">An Object to format</param>
13083
+ <remarks>
13084
+ <para>
13085
+ The message is formatted using the <c>String.Format</c> method. See
13086
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13087
+ of the formatting.
13088
+ </para>
13089
+ <para>
13090
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13091
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Info(System.Object,System.Exception)"/>
13092
+ methods instead.
13093
+ </para>
13094
+ </remarks>
13095
+ <seealso cref="M:log4net.ILog.Info(System.Object)"/>
11964
13096
  <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
11965
13097
  </member>
11966
13098
  <member name="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
@@ -11973,7 +13105,7 @@
11973
13105
  <remarks>
11974
13106
  <para>
11975
13107
  The message is formatted using the <c>String.Format</c> method. See
11976
- <see cref="M:System.String.Format(System.String,System.Object)"/> for details of the syntax of the format string and the behavior
13108
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
11977
13109
  of the formatting.
11978
13110
  </para>
11979
13111
  <para>
@@ -12038,7 +13170,7 @@
12038
13170
  <remarks>
12039
13171
  <para>
12040
13172
  The message is formatted using the <c>String.Format</c> method. See
12041
- <see cref="M:System.String.Format(System.String,System.Object)"/> for details of the syntax of the format string and the behavior
13173
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
12042
13174
  of the formatting.
12043
13175
  </para>
12044
13176
  <para>
@@ -12050,6 +13182,72 @@
12050
13182
  <seealso cref="M:log4net.ILog.Warn(System.Object,System.Exception)"/>
12051
13183
  <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
12052
13184
  </member>
13185
+ <member name="M:log4net.ILog.WarnFormat(System.String,System.Object)">
13186
+ <summary>
13187
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
13188
+ </summary>
13189
+ <param name="format">A String containing zero or more format items</param>
13190
+ <param name="arg0">An Object to format</param>
13191
+ <remarks>
13192
+ <para>
13193
+ The message is formatted using the <c>String.Format</c> method. See
13194
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13195
+ of the formatting.
13196
+ </para>
13197
+ <para>
13198
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13199
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Warn(System.Object,System.Exception)"/>
13200
+ methods instead.
13201
+ </para>
13202
+ </remarks>
13203
+ <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
13204
+ <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
13205
+ </member>
13206
+ <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object)">
13207
+ <summary>
13208
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
13209
+ </summary>
13210
+ <param name="format">A String containing zero or more format items</param>
13211
+ <param name="arg0">An Object to format</param>
13212
+ <param name="arg1">An Object to format</param>
13213
+ <remarks>
13214
+ <para>
13215
+ The message is formatted using the <c>String.Format</c> method. See
13216
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13217
+ of the formatting.
13218
+ </para>
13219
+ <para>
13220
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13221
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Warn(System.Object,System.Exception)"/>
13222
+ methods instead.
13223
+ </para>
13224
+ </remarks>
13225
+ <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
13226
+ <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
13227
+ </member>
13228
+ <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
13229
+ <summary>
13230
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
13231
+ </summary>
13232
+ <param name="format">A String containing zero or more format items</param>
13233
+ <param name="arg0">An Object to format</param>
13234
+ <param name="arg1">An Object to format</param>
13235
+ <param name="arg2">An Object to format</param>
13236
+ <remarks>
13237
+ <para>
13238
+ The message is formatted using the <c>String.Format</c> method. See
13239
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13240
+ of the formatting.
13241
+ </para>
13242
+ <para>
13243
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13244
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Warn(System.Object,System.Exception)"/>
13245
+ methods instead.
13246
+ </para>
13247
+ </remarks>
13248
+ <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
13249
+ <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
13250
+ </member>
12053
13251
  <member name="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
12054
13252
  <summary>
12055
13253
  Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
@@ -12060,7 +13258,7 @@
12060
13258
  <remarks>
12061
13259
  <para>
12062
13260
  The message is formatted using the <c>String.Format</c> method. See
12063
- <see cref="M:System.String.Format(System.String,System.Object)"/> for details of the syntax of the format string and the behavior
13261
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
12064
13262
  of the formatting.
12065
13263
  </para>
12066
13264
  <para>
@@ -12125,7 +13323,7 @@
12125
13323
  <remarks>
12126
13324
  <para>
12127
13325
  The message is formatted using the <c>String.Format</c> method. See
12128
- <see cref="M:System.String.Format(System.String,System.Object)"/> for details of the syntax of the format string and the behavior
13326
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
12129
13327
  of the formatting.
12130
13328
  </para>
12131
13329
  <para>
@@ -12137,6 +13335,72 @@
12137
13335
  <seealso cref="M:log4net.ILog.Error(System.Object,System.Exception)"/>
12138
13336
  <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
12139
13337
  </member>
13338
+ <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object)">
13339
+ <summary>
13340
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
13341
+ </summary>
13342
+ <param name="format">A String containing zero or more format items</param>
13343
+ <param name="arg0">An Object to format</param>
13344
+ <remarks>
13345
+ <para>
13346
+ The message is formatted using the <c>String.Format</c> method. See
13347
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13348
+ of the formatting.
13349
+ </para>
13350
+ <para>
13351
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13352
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Error(System.Object,System.Exception)"/>
13353
+ methods instead.
13354
+ </para>
13355
+ </remarks>
13356
+ <seealso cref="M:log4net.ILog.Error(System.Object)"/>
13357
+ <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
13358
+ </member>
13359
+ <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object)">
13360
+ <summary>
13361
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
13362
+ </summary>
13363
+ <param name="format">A String containing zero or more format items</param>
13364
+ <param name="arg0">An Object to format</param>
13365
+ <param name="arg1">An Object to format</param>
13366
+ <remarks>
13367
+ <para>
13368
+ The message is formatted using the <c>String.Format</c> method. See
13369
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13370
+ of the formatting.
13371
+ </para>
13372
+ <para>
13373
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13374
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Error(System.Object,System.Exception)"/>
13375
+ methods instead.
13376
+ </para>
13377
+ </remarks>
13378
+ <seealso cref="M:log4net.ILog.Error(System.Object)"/>
13379
+ <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
13380
+ </member>
13381
+ <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
13382
+ <summary>
13383
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
13384
+ </summary>
13385
+ <param name="format">A String containing zero or more format items</param>
13386
+ <param name="arg0">An Object to format</param>
13387
+ <param name="arg1">An Object to format</param>
13388
+ <param name="arg2">An Object to format</param>
13389
+ <remarks>
13390
+ <para>
13391
+ The message is formatted using the <c>String.Format</c> method. See
13392
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13393
+ of the formatting.
13394
+ </para>
13395
+ <para>
13396
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13397
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Error(System.Object,System.Exception)"/>
13398
+ methods instead.
13399
+ </para>
13400
+ </remarks>
13401
+ <seealso cref="M:log4net.ILog.Error(System.Object)"/>
13402
+ <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
13403
+ </member>
12140
13404
  <member name="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
12141
13405
  <summary>
12142
13406
  Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
@@ -12147,7 +13411,7 @@
12147
13411
  <remarks>
12148
13412
  <para>
12149
13413
  The message is formatted using the <c>String.Format</c> method. See
12150
- <see cref="M:System.String.Format(System.String,System.Object)"/> for details of the syntax of the format string and the behavior
13414
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
12151
13415
  of the formatting.
12152
13416
  </para>
12153
13417
  <para>
@@ -12212,7 +13476,7 @@
12212
13476
  <remarks>
12213
13477
  <para>
12214
13478
  The message is formatted using the <c>String.Format</c> method. See
12215
- <see cref="M:System.String.Format(System.String,System.Object)"/> for details of the syntax of the format string and the behavior
13479
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
12216
13480
  of the formatting.
12217
13481
  </para>
12218
13482
  <para>
@@ -12224,6 +13488,72 @@
12224
13488
  <seealso cref="M:log4net.ILog.Fatal(System.Object,System.Exception)"/>
12225
13489
  <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
12226
13490
  </member>
13491
+ <member name="M:log4net.ILog.FatalFormat(System.String,System.Object)">
13492
+ <summary>
13493
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
13494
+ </summary>
13495
+ <param name="format">A String containing zero or more format items</param>
13496
+ <param name="arg0">An Object to format</param>
13497
+ <remarks>
13498
+ <para>
13499
+ The message is formatted using the <c>String.Format</c> method. See
13500
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13501
+ of the formatting.
13502
+ </para>
13503
+ <para>
13504
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13505
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Fatal(System.Object,System.Exception)"/>
13506
+ methods instead.
13507
+ </para>
13508
+ </remarks>
13509
+ <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
13510
+ <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
13511
+ </member>
13512
+ <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object)">
13513
+ <summary>
13514
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
13515
+ </summary>
13516
+ <param name="format">A String containing zero or more format items</param>
13517
+ <param name="arg0">An Object to format</param>
13518
+ <param name="arg1">An Object to format</param>
13519
+ <remarks>
13520
+ <para>
13521
+ The message is formatted using the <c>String.Format</c> method. See
13522
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13523
+ of the formatting.
13524
+ </para>
13525
+ <para>
13526
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13527
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Fatal(System.Object,System.Exception)"/>
13528
+ methods instead.
13529
+ </para>
13530
+ </remarks>
13531
+ <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
13532
+ <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
13533
+ </member>
13534
+ <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
13535
+ <summary>
13536
+ Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
13537
+ </summary>
13538
+ <param name="format">A String containing zero or more format items</param>
13539
+ <param name="arg0">An Object to format</param>
13540
+ <param name="arg1">An Object to format</param>
13541
+ <param name="arg2">An Object to format</param>
13542
+ <remarks>
13543
+ <para>
13544
+ The message is formatted using the <c>String.Format</c> method. See
13545
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
13546
+ of the formatting.
13547
+ </para>
13548
+ <para>
13549
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13550
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.ILog.Fatal(System.Object,System.Exception)"/>
13551
+ methods instead.
13552
+ </para>
13553
+ </remarks>
13554
+ <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
13555
+ <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
13556
+ </member>
12227
13557
  <member name="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
12228
13558
  <summary>
12229
13559
  Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
@@ -12234,7 +13564,7 @@
12234
13564
  <remarks>
12235
13565
  <para>
12236
13566
  The message is formatted using the <c>String.Format</c> method. See
12237
- <see cref="M:System.String.Format(System.String,System.Object)"/> for details of the syntax of the format string and the behavior
13567
+ <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
12238
13568
  of the formatting.
12239
13569
  </para>
12240
13570
  <para>
@@ -12315,7 +13645,7 @@
12315
13645
  </para>
12316
13646
  </remarks>
12317
13647
  <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
12318
- <seealso cref="M:log4net.ILog.DebugFormat(System.String,System.Object[])"/>
13648
+ <seealso cref="M:log4net.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])"/>
12319
13649
  </member>
12320
13650
  <member name="P:log4net.ILog.IsInfoEnabled">
12321
13651
  <summary>
@@ -12328,7 +13658,7 @@
12328
13658
  For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
12329
13659
  </remarks>
12330
13660
  <seealso cref="M:log4net.ILog.Info(System.Object)"/>
12331
- <seealso cref="M:log4net.ILog.InfoFormat(System.String,System.Object[])"/>
13661
+ <seealso cref="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])"/>
12332
13662
  <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
12333
13663
  </member>
12334
13664
  <member name="P:log4net.ILog.IsWarnEnabled">
@@ -12342,7 +13672,7 @@
12342
13672
  For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
12343
13673
  </remarks>
12344
13674
  <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
12345
- <seealso cref="M:log4net.ILog.WarnFormat(System.String,System.Object[])"/>
13675
+ <seealso cref="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])"/>
12346
13676
  <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
12347
13677
  </member>
12348
13678
  <member name="P:log4net.ILog.IsErrorEnabled">
@@ -12356,7 +13686,7 @@
12356
13686
  For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
12357
13687
  </remarks>
12358
13688
  <seealso cref="M:log4net.ILog.Error(System.Object)"/>
12359
- <seealso cref="M:log4net.ILog.ErrorFormat(System.String,System.Object[])"/>
13689
+ <seealso cref="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])"/>
12360
13690
  <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
12361
13691
  </member>
12362
13692
  <member name="P:log4net.ILog.IsFatalEnabled">
@@ -12370,7 +13700,7 @@
12370
13700
  For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
12371
13701
  </remarks>
12372
13702
  <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
12373
- <seealso cref="M:log4net.ILog.FatalFormat(System.String,System.Object[])"/>
13703
+ <seealso cref="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])"/>
12374
13704
  <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
12375
13705
  </member>
12376
13706
  <member name="M:log4net.Core.LogImpl.#ctor(log4net.Core.ILogger)">
@@ -12433,20 +13763,95 @@
12433
13763
  as a parameter.
12434
13764
  </para>
12435
13765
  <para>
12436
- See the <see cref="M:log4net.Core.LogImpl.Debug(System.Object)"/> form for more detailed information.
13766
+ See the <see cref="M:log4net.Core.LogImpl.Debug(System.Object)"/> form for more detailed information.
13767
+ </para>
13768
+ </remarks>
13769
+ <seealso cref="M:log4net.Core.LogImpl.Debug(System.Object)"/>
13770
+ </member>
13771
+ <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])">
13772
+ <summary>
13773
+ Logs a formatted message string with the <c>DEBUG</c> level.
13774
+ </summary>
13775
+ <param name="format">A String containing zero or more format items</param>
13776
+ <param name="args">An Object array containing zero or more objects to format</param>
13777
+ <remarks>
13778
+ <para>
13779
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
13780
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
13781
+ of the formatting.
13782
+ </para>
13783
+ <para>
13784
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
13785
+ format provider. To specify a localized provider use the
13786
+ <see cref="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
13787
+ </para>
13788
+ <para>
13789
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13790
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Debug(System.Object)"/>
13791
+ methods instead.
13792
+ </para>
13793
+ </remarks>
13794
+ </member>
13795
+ <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)">
13796
+ <summary>
13797
+ Logs a formatted message string with the <c>DEBUG</c> level.
13798
+ </summary>
13799
+ <param name="format">A String containing zero or more format items</param>
13800
+ <param name="arg0">An Object to format</param>
13801
+ <remarks>
13802
+ <para>
13803
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
13804
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
13805
+ of the formatting.
13806
+ </para>
13807
+ <para>
13808
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
13809
+ format provider. To specify a localized provider use the
13810
+ <see cref="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
13811
+ </para>
13812
+ <para>
13813
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13814
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Debug(System.Object)"/>
13815
+ methods instead.
13816
+ </para>
13817
+ </remarks>
13818
+ </member>
13819
+ <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)">
13820
+ <summary>
13821
+ Logs a formatted message string with the <c>DEBUG</c> level.
13822
+ </summary>
13823
+ <param name="format">A String containing zero or more format items</param>
13824
+ <param name="arg0">An Object to format</param>
13825
+ <param name="arg1">An Object to format</param>
13826
+ <remarks>
13827
+ <para>
13828
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
13829
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
13830
+ of the formatting.
13831
+ </para>
13832
+ <para>
13833
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
13834
+ format provider. To specify a localized provider use the
13835
+ <see cref="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
13836
+ </para>
13837
+ <para>
13838
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13839
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Debug(System.Object)"/>
13840
+ methods instead.
12437
13841
  </para>
12438
13842
  </remarks>
12439
- <seealso cref="M:log4net.Core.LogImpl.Debug(System.Object)"/>
12440
13843
  </member>
12441
- <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])">
13844
+ <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)">
12442
13845
  <summary>
12443
13846
  Logs a formatted message string with the <c>DEBUG</c> level.
12444
13847
  </summary>
12445
13848
  <param name="format">A String containing zero or more format items</param>
12446
- <param name="args">An Object array containing zero or more objects to format</param>
13849
+ <param name="arg0">An Object to format</param>
13850
+ <param name="arg1">An Object to format</param>
13851
+ <param name="arg2">An Object to format</param>
12447
13852
  <remarks>
12448
13853
  <para>
12449
- The message is formatted using the <see cref="M:System.String.Format(System.String,System.Object)"/> method. See
13854
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
12450
13855
  <c>String.Format</c> for details of the syntax of the format string and the behavior
12451
13856
  of the formatting.
12452
13857
  </para>
@@ -12471,7 +13876,7 @@
12471
13876
  <param name="args">An Object array containing zero or more objects to format</param>
12472
13877
  <remarks>
12473
13878
  <para>
12474
- The message is formatted using the <see cref="M:System.String.Format(System.String,System.Object)"/> method. See
13879
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
12475
13880
  <c>String.Format</c> for details of the syntax of the format string and the behavior
12476
13881
  of the formatting.
12477
13882
  </para>
@@ -12533,7 +13938,82 @@
12533
13938
  <param name="args">An Object array containing zero or more objects to format</param>
12534
13939
  <remarks>
12535
13940
  <para>
12536
- The message is formatted using the <see cref="M:System.String.Format(System.String,System.Object)"/> method. See
13941
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
13942
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
13943
+ of the formatting.
13944
+ </para>
13945
+ <para>
13946
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
13947
+ format provider. To specify a localized provider use the
13948
+ <see cref="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
13949
+ </para>
13950
+ <para>
13951
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13952
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Info(System.Object)"/>
13953
+ methods instead.
13954
+ </para>
13955
+ </remarks>
13956
+ </member>
13957
+ <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)">
13958
+ <summary>
13959
+ Logs a formatted message string with the <c>INFO</c> level.
13960
+ </summary>
13961
+ <param name="format">A String containing zero or more format items</param>
13962
+ <param name="arg0">An Object to format</param>
13963
+ <remarks>
13964
+ <para>
13965
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
13966
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
13967
+ of the formatting.
13968
+ </para>
13969
+ <para>
13970
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
13971
+ format provider. To specify a localized provider use the
13972
+ <see cref="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
13973
+ </para>
13974
+ <para>
13975
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
13976
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Info(System.Object)"/>
13977
+ methods instead.
13978
+ </para>
13979
+ </remarks>
13980
+ </member>
13981
+ <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)">
13982
+ <summary>
13983
+ Logs a formatted message string with the <c>INFO</c> level.
13984
+ </summary>
13985
+ <param name="format">A String containing zero or more format items</param>
13986
+ <param name="arg0">An Object to format</param>
13987
+ <param name="arg1">An Object to format</param>
13988
+ <remarks>
13989
+ <para>
13990
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
13991
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
13992
+ of the formatting.
13993
+ </para>
13994
+ <para>
13995
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
13996
+ format provider. To specify a localized provider use the
13997
+ <see cref="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
13998
+ </para>
13999
+ <para>
14000
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
14001
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Info(System.Object)"/>
14002
+ methods instead.
14003
+ </para>
14004
+ </remarks>
14005
+ </member>
14006
+ <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)">
14007
+ <summary>
14008
+ Logs a formatted message string with the <c>INFO</c> level.
14009
+ </summary>
14010
+ <param name="format">A String containing zero or more format items</param>
14011
+ <param name="arg0">An Object to format</param>
14012
+ <param name="arg1">An Object to format</param>
14013
+ <param name="arg2">An Object to format</param>
14014
+ <remarks>
14015
+ <para>
14016
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
12537
14017
  <c>String.Format</c> for details of the syntax of the format string and the behavior
12538
14018
  of the formatting.
12539
14019
  </para>
@@ -12558,7 +14038,7 @@
12558
14038
  <param name="args">An Object array containing zero or more objects to format</param>
12559
14039
  <remarks>
12560
14040
  <para>
12561
- The message is formatted using the <see cref="M:System.String.Format(System.String,System.Object)"/> method. See
14041
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
12562
14042
  <c>String.Format</c> for details of the syntax of the format string and the behavior
12563
14043
  of the formatting.
12564
14044
  </para>
@@ -12620,7 +14100,82 @@
12620
14100
  <param name="args">An Object array containing zero or more objects to format</param>
12621
14101
  <remarks>
12622
14102
  <para>
12623
- The message is formatted using the <see cref="M:System.String.Format(System.String,System.Object)"/> method. See
14103
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
14104
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
14105
+ of the formatting.
14106
+ </para>
14107
+ <para>
14108
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
14109
+ format provider. To specify a localized provider use the
14110
+ <see cref="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
14111
+ </para>
14112
+ <para>
14113
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
14114
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Warn(System.Object)"/>
14115
+ methods instead.
14116
+ </para>
14117
+ </remarks>
14118
+ </member>
14119
+ <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)">
14120
+ <summary>
14121
+ Logs a formatted message string with the <c>WARN</c> level.
14122
+ </summary>
14123
+ <param name="format">A String containing zero or more format items</param>
14124
+ <param name="arg0">An Object to format</param>
14125
+ <remarks>
14126
+ <para>
14127
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
14128
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
14129
+ of the formatting.
14130
+ </para>
14131
+ <para>
14132
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
14133
+ format provider. To specify a localized provider use the
14134
+ <see cref="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
14135
+ </para>
14136
+ <para>
14137
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
14138
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Warn(System.Object)"/>
14139
+ methods instead.
14140
+ </para>
14141
+ </remarks>
14142
+ </member>
14143
+ <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)">
14144
+ <summary>
14145
+ Logs a formatted message string with the <c>WARN</c> level.
14146
+ </summary>
14147
+ <param name="format">A String containing zero or more format items</param>
14148
+ <param name="arg0">An Object to format</param>
14149
+ <param name="arg1">An Object to format</param>
14150
+ <remarks>
14151
+ <para>
14152
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
14153
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
14154
+ of the formatting.
14155
+ </para>
14156
+ <para>
14157
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
14158
+ format provider. To specify a localized provider use the
14159
+ <see cref="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
14160
+ </para>
14161
+ <para>
14162
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
14163
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Warn(System.Object)"/>
14164
+ methods instead.
14165
+ </para>
14166
+ </remarks>
14167
+ </member>
14168
+ <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)">
14169
+ <summary>
14170
+ Logs a formatted message string with the <c>WARN</c> level.
14171
+ </summary>
14172
+ <param name="format">A String containing zero or more format items</param>
14173
+ <param name="arg0">An Object to format</param>
14174
+ <param name="arg1">An Object to format</param>
14175
+ <param name="arg2">An Object to format</param>
14176
+ <remarks>
14177
+ <para>
14178
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
12624
14179
  <c>String.Format</c> for details of the syntax of the format string and the behavior
12625
14180
  of the formatting.
12626
14181
  </para>
@@ -12645,7 +14200,7 @@
12645
14200
  <param name="args">An Object array containing zero or more objects to format</param>
12646
14201
  <remarks>
12647
14202
  <para>
12648
- The message is formatted using the <see cref="M:System.String.Format(System.String,System.Object)"/> method. See
14203
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
12649
14204
  <c>String.Format</c> for details of the syntax of the format string and the behavior
12650
14205
  of the formatting.
12651
14206
  </para>
@@ -12707,7 +14262,82 @@
12707
14262
  <param name="args">An Object array containing zero or more objects to format</param>
12708
14263
  <remarks>
12709
14264
  <para>
12710
- The message is formatted using the <see cref="M:System.String.Format(System.String,System.Object)"/> method. See
14265
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
14266
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
14267
+ of the formatting.
14268
+ </para>
14269
+ <para>
14270
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
14271
+ format provider. To specify a localized provider use the
14272
+ <see cref="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
14273
+ </para>
14274
+ <para>
14275
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
14276
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Error(System.Object)"/>
14277
+ methods instead.
14278
+ </para>
14279
+ </remarks>
14280
+ </member>
14281
+ <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)">
14282
+ <summary>
14283
+ Logs a formatted message string with the <c>ERROR</c> level.
14284
+ </summary>
14285
+ <param name="format">A String containing zero or more format items</param>
14286
+ <param name="arg0">An Object to format</param>
14287
+ <remarks>
14288
+ <para>
14289
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
14290
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
14291
+ of the formatting.
14292
+ </para>
14293
+ <para>
14294
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
14295
+ format provider. To specify a localized provider use the
14296
+ <see cref="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
14297
+ </para>
14298
+ <para>
14299
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
14300
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Error(System.Object)"/>
14301
+ methods instead.
14302
+ </para>
14303
+ </remarks>
14304
+ </member>
14305
+ <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)">
14306
+ <summary>
14307
+ Logs a formatted message string with the <c>ERROR</c> level.
14308
+ </summary>
14309
+ <param name="format">A String containing zero or more format items</param>
14310
+ <param name="arg0">An Object to format</param>
14311
+ <param name="arg1">An Object to format</param>
14312
+ <remarks>
14313
+ <para>
14314
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
14315
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
14316
+ of the formatting.
14317
+ </para>
14318
+ <para>
14319
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
14320
+ format provider. To specify a localized provider use the
14321
+ <see cref="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
14322
+ </para>
14323
+ <para>
14324
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
14325
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Error(System.Object)"/>
14326
+ methods instead.
14327
+ </para>
14328
+ </remarks>
14329
+ </member>
14330
+ <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
14331
+ <summary>
14332
+ Logs a formatted message string with the <c>ERROR</c> level.
14333
+ </summary>
14334
+ <param name="format">A String containing zero or more format items</param>
14335
+ <param name="arg0">An Object to format</param>
14336
+ <param name="arg1">An Object to format</param>
14337
+ <param name="arg2">An Object to format</param>
14338
+ <remarks>
14339
+ <para>
14340
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
12711
14341
  <c>String.Format</c> for details of the syntax of the format string and the behavior
12712
14342
  of the formatting.
12713
14343
  </para>
@@ -12732,7 +14362,7 @@
12732
14362
  <param name="args">An Object array containing zero or more objects to format</param>
12733
14363
  <remarks>
12734
14364
  <para>
12735
- The message is formatted using the <see cref="M:System.String.Format(System.String,System.Object)"/> method. See
14365
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
12736
14366
  <c>String.Format</c> for details of the syntax of the format string and the behavior
12737
14367
  of the formatting.
12738
14368
  </para>
@@ -12781,20 +14411,95 @@
12781
14411
  passed as a parameter.
12782
14412
  </para>
12783
14413
  <para>
12784
- See the <see cref="M:log4net.Core.LogImpl.Fatal(System.Object)"/> form for more detailed information.
14414
+ See the <see cref="M:log4net.Core.LogImpl.Fatal(System.Object)"/> form for more detailed information.
14415
+ </para>
14416
+ </remarks>
14417
+ <seealso cref="M:log4net.Core.LogImpl.Fatal(System.Object)"/>
14418
+ </member>
14419
+ <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])">
14420
+ <summary>
14421
+ Logs a formatted message string with the <c>FATAL</c> level.
14422
+ </summary>
14423
+ <param name="format">A String containing zero or more format items</param>
14424
+ <param name="args">An Object array containing zero or more objects to format</param>
14425
+ <remarks>
14426
+ <para>
14427
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
14428
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
14429
+ of the formatting.
14430
+ </para>
14431
+ <para>
14432
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
14433
+ format provider. To specify a localized provider use the
14434
+ <see cref="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
14435
+ </para>
14436
+ <para>
14437
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
14438
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Fatal(System.Object)"/>
14439
+ methods instead.
14440
+ </para>
14441
+ </remarks>
14442
+ </member>
14443
+ <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)">
14444
+ <summary>
14445
+ Logs a formatted message string with the <c>FATAL</c> level.
14446
+ </summary>
14447
+ <param name="format">A String containing zero or more format items</param>
14448
+ <param name="arg0">An Object to format</param>
14449
+ <remarks>
14450
+ <para>
14451
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
14452
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
14453
+ of the formatting.
14454
+ </para>
14455
+ <para>
14456
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
14457
+ format provider. To specify a localized provider use the
14458
+ <see cref="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
14459
+ </para>
14460
+ <para>
14461
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
14462
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Fatal(System.Object)"/>
14463
+ methods instead.
14464
+ </para>
14465
+ </remarks>
14466
+ </member>
14467
+ <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)">
14468
+ <summary>
14469
+ Logs a formatted message string with the <c>FATAL</c> level.
14470
+ </summary>
14471
+ <param name="format">A String containing zero or more format items</param>
14472
+ <param name="arg0">An Object to format</param>
14473
+ <param name="arg1">An Object to format</param>
14474
+ <remarks>
14475
+ <para>
14476
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
14477
+ <c>String.Format</c> for details of the syntax of the format string and the behavior
14478
+ of the formatting.
14479
+ </para>
14480
+ <para>
14481
+ The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
14482
+ format provider. To specify a localized provider use the
14483
+ <see cref="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])"/> method.
14484
+ </para>
14485
+ <para>
14486
+ This method does not take an <see cref="T:System.Exception"/> object to include in the
14487
+ log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Core.LogImpl.Fatal(System.Object)"/>
14488
+ methods instead.
12785
14489
  </para>
12786
14490
  </remarks>
12787
- <seealso cref="M:log4net.Core.LogImpl.Fatal(System.Object)"/>
12788
14491
  </member>
12789
- <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])">
14492
+ <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)">
12790
14493
  <summary>
12791
14494
  Logs a formatted message string with the <c>FATAL</c> level.
12792
14495
  </summary>
12793
14496
  <param name="format">A String containing zero or more format items</param>
12794
- <param name="args">An Object array containing zero or more objects to format</param>
14497
+ <param name="arg0">An Object to format</param>
14498
+ <param name="arg1">An Object to format</param>
14499
+ <param name="arg2">An Object to format</param>
12795
14500
  <remarks>
12796
14501
  <para>
12797
- The message is formatted using the <see cref="M:System.String.Format(System.String,System.Object)"/> method. See
14502
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
12798
14503
  <c>String.Format</c> for details of the syntax of the format string and the behavior
12799
14504
  of the formatting.
12800
14505
  </para>
@@ -12819,7 +14524,7 @@
12819
14524
  <param name="args">An Object array containing zero or more objects to format</param>
12820
14525
  <remarks>
12821
14526
  <para>
12822
- The message is formatted using the <see cref="M:System.String.Format(System.String,System.Object)"/> method. See
14527
+ The message is formatted using the <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method. See
12823
14528
  <c>String.Format</c> for details of the syntax of the format string and the behavior
12824
14529
  of the formatting.
12825
14530
  </para>
@@ -13398,11 +15103,11 @@
13398
15103
  </member>
13399
15104
  <member name="T:log4net.DateFormatter.SimpleDateFormatter">
13400
15105
  <summary>
13401
- Formats the <see cref="T:System.DateTime"/> using the <see cref="M:System.DateTime.ToString"/> method.
15106
+ Formats the <see cref="T:System.DateTime"/> using the <see cref="M:System.DateTime.ToString(System.String,System.IFormatProvider)"/> method.
13402
15107
  </summary>
13403
15108
  <remarks>
13404
15109
  <para>
13405
- Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:System.DateTime.ToString"/> method.
15110
+ Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:System.DateTime.ToString(System.String,System.IFormatProvider)"/> method.
13406
15111
  </para>
13407
15112
  </remarks>
13408
15113
  <author>Nicko Cadell</author>
@@ -13420,20 +15125,20 @@
13420
15125
  </para>
13421
15126
  <para>
13422
15127
  The format string must be compatible with the options
13423
- that can be supplied to <see cref="M:System.DateTime.ToString"/>.
15128
+ that can be supplied to <see cref="M:System.DateTime.ToString(System.String,System.IFormatProvider)"/>.
13424
15129
  </para>
13425
15130
  </remarks>
13426
15131
  </member>
13427
15132
  <member name="M:log4net.DateFormatter.SimpleDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
13428
15133
  <summary>
13429
- Formats the date using <see cref="M:System.DateTime.ToString"/>.
15134
+ Formats the date using <see cref="M:System.DateTime.ToString(System.String,System.IFormatProvider)"/>.
13430
15135
  </summary>
13431
15136
  <param name="dateToFormat">The date to convert to a string.</param>
13432
15137
  <param name="writer">The writer to write to.</param>
13433
15138
  <remarks>
13434
15139
  <para>
13435
15140
  Uses the date format string supplied to the constructor to call
13436
- the <see cref="M:System.DateTime.ToString(System.String)"/> method to format the date.
15141
+ the <see cref="M:System.DateTime.ToString(System.String,System.IFormatProvider)"/> method to format the date.
13437
15142
  </para>
13438
15143
  </remarks>
13439
15144
  </member>
@@ -13444,7 +15149,7 @@
13444
15149
  <remarks>
13445
15150
  <para>
13446
15151
  The format string must be compatible with the options
13447
- that can be supplied to <see cref="M:System.DateTime.ToString"/>.
15152
+ that can be supplied to <see cref="M:System.DateTime.ToString(System.String,System.IFormatProvider)"/>.
13448
15153
  </para>
13449
15154
  </remarks>
13450
15155
  </member>
@@ -13712,7 +15417,8 @@
13712
15417
  <see cref="T:log4net.Core.LoggingEvent"/>, then the <see cref="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
13713
15418
  case the <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> option value is set
13714
15419
  to <c>true</c>, if it is <c>false</c> then
13715
- <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
15420
+ <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If the <see cref="T:log4net.Core.Level"/> does not match then
15421
+ the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
13716
15422
  </para>
13717
15423
  </remarks>
13718
15424
  <author>Nicko Cadell</author>
@@ -13746,7 +15452,7 @@
13746
15452
  value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If it is true then
13747
15453
  the function will return <see cref="F:log4net.Filter.FilterDecision.Accept"/>, it it is false then it
13748
15454
  will return <see cref="F:log4net.Filter.FilterDecision.Deny"/>. If the <see cref="T:log4net.Core.Level"/> does not match then
13749
- the result will be the opposite of when it does match.
15455
+ the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
13750
15456
  </para>
13751
15457
  </remarks>
13752
15458
  </member>
@@ -15431,7 +17137,7 @@
15431
17137
  <para>
15432
17138
  Each conversion specifier starts with a percent sign (%) and is
15433
17139
  followed by optional <i>format modifiers</i> and a <i>conversion
15434
- character</i>. The conversion character specifies the type of
17140
+ pattern name</i>. The conversion pattern name specifies the type of
15435
17141
  data, e.g. logger, level, date, thread name. The format
15436
17142
  modifiers control such things as field width, padding, left and
15437
17143
  right justification. The following is a simple example.
@@ -15460,11 +17166,11 @@
15460
17166
  justified to a width of five characters.
15461
17167
  </para>
15462
17168
  <para>
15463
- The recognized conversion characters are:
17169
+ The recognized conversion pattern names are:
15464
17170
  </para>
15465
17171
  <list type="table">
15466
17172
  <listheader>
15467
- <term>Conversion Character</term>
17173
+ <term>Conversion Pattern Name</term>
15468
17174
  <description>Effect</description>
15469
17175
  </listheader>
15470
17176
  <item>
@@ -15509,7 +17215,7 @@
15509
17215
  </para>
15510
17216
  <para>
15511
17217
  The date format specifier admits the same syntax as the
15512
- time pattern string of the <see cref="M:System.DateTime.ToString"/>.
17218
+ time pattern string of the <see cref="M:System.DateTime.ToString(System.String)"/>.
15513
17219
  </para>
15514
17220
  <para>
15515
17221
  For better results it is recommended to use the log4net date
@@ -15556,7 +17262,7 @@
15556
17262
  </para>
15557
17263
  <para>
15558
17264
  <b>WARNING</b> Generating caller location information is
15559
- extremely slow. It's use should be avoided unless execution speed
17265
+ extremely slow. Its use should be avoided unless execution speed
15560
17266
  is not an issue.
15561
17267
  </para>
15562
17268
  <para>
@@ -15573,7 +17279,7 @@
15573
17279
  </para>
15574
17280
  <para>
15575
17281
  <b>WARNING</b> Generating caller information is
15576
- extremely slow. It's use should be avoided unless execution speed
17282
+ extremely slow. Its use should be avoided unless execution speed
15577
17283
  is not an issue.
15578
17284
  </para>
15579
17285
  </description>
@@ -15600,8 +17306,8 @@
15600
17306
  number between parentheses.
15601
17307
  </para>
15602
17308
  <para>
15603
- The location information can be very useful. However, it's
15604
- generation is <b>extremely</b> slow. It's use should be avoided
17309
+ The location information can be very useful. However, its
17310
+ generation is <b>extremely</b> slow. Its use should be avoided
15605
17311
  unless execution speed is not an issue.
15606
17312
  </para>
15607
17313
  <para>
@@ -15626,7 +17332,7 @@
15626
17332
  </para>
15627
17333
  <para>
15628
17334
  <b>WARNING</b> Generating caller location information is
15629
- extremely slow. It's use should be avoided unless execution speed
17335
+ extremely slow. Its use should be avoided unless execution speed
15630
17336
  is not an issue.
15631
17337
  </para>
15632
17338
  <para>
@@ -15690,7 +17396,7 @@
15690
17396
  </para>
15691
17397
  <para>
15692
17398
  <b>WARNING</b> Generating caller location information is
15693
- extremely slow. It's use should be avoided unless execution speed
17399
+ extremely slow. Its use should be avoided unless execution speed
15694
17400
  is not an issue.
15695
17401
  </para>
15696
17402
  <para>
@@ -15710,7 +17416,7 @@
15710
17416
  characters.
15711
17417
  </para>
15712
17418
  <para>
15713
- This conversion character offers the same performance as using
17419
+ This conversion pattern offers the same performance as using
15714
17420
  non-portable line separator strings such as "\n", or "\r\n".
15715
17421
  Thus, it is the preferred way of specifying a line separator.
15716
17422
  </para>
@@ -15830,7 +17536,7 @@
15830
17536
  </para>
15831
17537
  <para>
15832
17538
  <b>WARNING</b> Generating the caller class information is
15833
- slow. Thus, it's use should be avoided unless execution speed is
17539
+ slow. Thus, its use should be avoided unless execution speed is
15834
17540
  not an issue.
15835
17541
  </para>
15836
17542
  <para>
@@ -15851,7 +17557,7 @@
15851
17557
  </para>
15852
17558
  <para>
15853
17559
  <b>WARNING</b> Generating caller WindowsIdentity information is
15854
- extremely slow. It's use should be avoided unless execution speed
17560
+ extremely slow. Its use should be avoided unless execution speed
15855
17561
  is not an issue.
15856
17562
  </para>
15857
17563
  </description>
@@ -15870,7 +17576,7 @@
15870
17576
  </para>
15871
17577
  <para>
15872
17578
  The date format specifier admits the same syntax as the
15873
- time pattern string of the <see cref="M:System.DateTime.ToString"/>.
17579
+ time pattern string of the <see cref="M:System.DateTime.ToString(System.String)"/>.
15874
17580
  </para>
15875
17581
  <para>
15876
17582
  For better results it is recommended to use the log4net date
@@ -15910,7 +17616,7 @@
15910
17616
  </list>
15911
17617
  <para>
15912
17618
  The single letter patterns are deprecated in favor of the
15913
- longer more descriptive patterns.
17619
+ longer more descriptive pattern names.
15914
17620
  </para>
15915
17621
  <para>
15916
17622
  By default the relevant information is output as is. However,
@@ -15919,7 +17625,7 @@
15919
17625
  </para>
15920
17626
  <para>
15921
17627
  The optional format modifier is placed between the percent sign
15922
- and the conversion character.
17628
+ and the conversion pattern name.
15923
17629
  </para>
15924
17630
  <para>
15925
17631
  The first optional format modifier is the <i>left justification
@@ -16055,7 +17761,7 @@
16055
17761
  </note>
16056
17762
  <para>
16057
17763
  Additional pattern converters may be registered with a specific <see cref="T:log4net.Layout.PatternLayout"/>
16058
- instance using the <see cref="M:log4net.Layout.PatternLayout.AddConverter(log4net.Layout.PatternLayout.ConverterInfo)"/> methods.
17764
+ instance using the <see cref="M:log4net.Layout.PatternLayout.AddConverter(System.String,System.Type)"/> method.
16059
17765
  </para>
16060
17766
  </remarks>
16061
17767
  <example>
@@ -16540,49 +18246,49 @@
16540
18246
  </remarks>
16541
18247
  </member>
16542
18248
  <member name="T:log4net.Layout.XmlLayout">
16543
- <summary>
16544
- Layout that formats the log events as XML elements.
16545
- </summary>
16546
- <remarks>
16547
- <para>
16548
- The output of the <see cref="T:log4net.Layout.XmlLayout"/> consists of a series of
16549
- log4net:event elements. It does not output a complete well-formed XML
16550
- file. The output is designed to be included as an <em>external entity</em>
16551
- in a separate file to form a correct XML file.
16552
- </para>
16553
- <para>
16554
- For example, if <c>abc</c> is the name of the file where
16555
- the <see cref="T:log4net.Layout.XmlLayout"/> output goes, then a well-formed XML file would
16556
- be:
16557
- </para>
16558
- <code lang="XML">
16559
- &lt;?xml version="1.0" ?&gt;
16560
-
16561
- &lt;!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [&lt;!ENTITY data SYSTEM "abc"&gt;]&gt;
18249
+ <summary>
18250
+ Layout that formats the log events as XML elements.
18251
+ </summary>
18252
+ <remarks>
18253
+ <para>
18254
+ The output of the <see cref="T:log4net.Layout.XmlLayout"/> consists of a series of
18255
+ log4net:event elements. It does not output a complete well-formed XML
18256
+ file. The output is designed to be included as an <em>external entity</em>
18257
+ in a separate file to form a correct XML file.
18258
+ </para>
18259
+ <para>
18260
+ For example, if <c>abc</c> is the name of the file where
18261
+ the <see cref="T:log4net.Layout.XmlLayout"/> output goes, then a well-formed XML file would
18262
+ be:
18263
+ </para>
18264
+ <code lang="XML">
18265
+ &lt;?xml version="1.0" ?&gt;
18266
+
18267
+ &lt;!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [&lt;!ENTITY data SYSTEM "abc"&gt;]&gt;
16562
18268
 
16563
- &lt;log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2&gt;
16564
- &amp;data;
16565
- &lt;/log4net:events&gt;
16566
- </code>
16567
- <para>
16568
- This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout"/>
16569
- and the appender where it is embedded.
16570
- </para>
16571
- <para>
16572
- The <c>version</c> attribute helps components to correctly
16573
- interpret output generated by <see cref="T:log4net.Layout.XmlLayout"/>. The value of
16574
- this attribute should be "1.2" for release 1.2 and later.
16575
- </para>
16576
- <para>
16577
- Alternatively the <c>Header</c> and <c>Footer</c> properties can be
16578
- configured to output the correct XML header, open tag and close tag.
16579
- When setting the <c>Header</c> and <c>Footer</c> properties it is essential
16580
- that the underlying data store not be appendable otherwise the data
16581
- will become invalid XML.
16582
- </para>
16583
- </remarks>
16584
- <author>Nicko Cadell</author>
16585
- <author>Gert Driesen</author>
18269
+ &lt;log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2&gt;
18270
+ &amp;data;
18271
+ &lt;/log4net:events&gt;
18272
+ </code>
18273
+ <para>
18274
+ This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout"/>
18275
+ and the appender where it is embedded.
18276
+ </para>
18277
+ <para>
18278
+ The <c>version</c> attribute helps components to correctly
18279
+ interpret output generated by <see cref="T:log4net.Layout.XmlLayout"/>. The value of
18280
+ this attribute should be "1.2" for release 1.2 and later.
18281
+ </para>
18282
+ <para>
18283
+ Alternatively the <c>Header</c> and <c>Footer</c> properties can be
18284
+ configured to output the correct XML header, open tag and close tag.
18285
+ When setting the <c>Header</c> and <c>Footer</c> properties it is essential
18286
+ that the underlying data store not be appendable otherwise the data
18287
+ will become invalid XML.
18288
+ </para>
18289
+ </remarks>
18290
+ <author>Nicko Cadell</author>
18291
+ <author>Gert Driesen</author>
16586
18292
  </member>
16587
18293
  <member name="T:log4net.Layout.XmlLayoutBase">
16588
18294
  <summary>
@@ -16690,6 +18396,11 @@
16690
18396
  Writer adapter that ignores Close
16691
18397
  </summary>
16692
18398
  </member>
18399
+ <member name="F:log4net.Layout.XmlLayoutBase.m_invalidCharReplacement">
18400
+ <summary>
18401
+ The string to replace invalid chars with
18402
+ </summary>
18403
+ </member>
16693
18404
  <member name="P:log4net.Layout.XmlLayoutBase.LocationInfo">
16694
18405
  <summary>
16695
18406
  Gets a value indicating whether to include location information in
@@ -16712,6 +18423,21 @@
16712
18423
  </para>
16713
18424
  </remarks>
16714
18425
  </member>
18426
+ <member name="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement">
18427
+ <summary>
18428
+ The string to replace characters that can not be expressed in XML with.
18429
+ <remarks>
18430
+ <para>
18431
+ Not all characters may be expressed in XML. This property contains the
18432
+ string to replace those that can not with. This defaults to a ?. Set it
18433
+ to the empty string to simply remove offending characters. For more
18434
+ details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets
18435
+ Character replacement will occur in the log message, the property names
18436
+ and the property values.
18437
+ </para>
18438
+ </remarks>
18439
+ </summary>
18440
+ </member>
16715
18441
  <member name="P:log4net.Layout.XmlLayoutBase.ContentType">
16716
18442
  <summary>
16717
18443
  Gets the content type output by this layout.
@@ -16800,6 +18526,36 @@
16800
18526
  </para>
16801
18527
  </remarks>
16802
18528
  </member>
18529
+ <member name="P:log4net.Layout.XmlLayout.Base64EncodeMessage">
18530
+ <summary>
18531
+ Set whether or not to base64 encode the message.
18532
+ </summary>
18533
+ <remarks>
18534
+ <para>
18535
+ By default the log message will be written as text to the xml
18536
+ output. This can cause problems when the message contains binary
18537
+ data. By setting this to true the contents of the message will be
18538
+ base64 encoded. If this is set then invalid character replacement
18539
+ (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
18540
+ on the log message.
18541
+ </para>
18542
+ </remarks>
18543
+ </member>
18544
+ <member name="P:log4net.Layout.XmlLayout.Base64EncodeProperties">
18545
+ <summary>
18546
+ Set whether or not to base64 encode the property values.
18547
+ </summary>
18548
+ <remarks>
18549
+ <para>
18550
+ By default the properties will be written as text to the xml
18551
+ output. This can cause problems when one or more properties contain
18552
+ binary data. By setting this to true the values of the properties
18553
+ will be base64 encoded. If this is set then invalid character replacement
18554
+ (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
18555
+ on the property values.
18556
+ </para>
18557
+ </remarks>
18558
+ </member>
16803
18559
  <member name="T:log4net.Layout.XmlLayoutSchemaLog4j">
16804
18560
  <summary>
16805
18561
  Layout that formats the log events as XML elements compatible with the log4j schema
@@ -16908,7 +18664,7 @@
16908
18664
  The <paramref name="rendererMap"/> parameter is
16909
18665
  provided to lookup and render other objects. This is
16910
18666
  very useful where <paramref name="obj"/> contains
16911
- nested objects of unknown type. The <see cref="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object)"/>
18667
+ nested objects of unknown type. The <see cref="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object,System.IO.TextWriter)"/>
16912
18668
  method can be used to render these objects.
16913
18669
  </para>
16914
18670
  </remarks>
@@ -16962,8 +18718,10 @@
16962
18718
  For a one dimensional array this is the
16963
18719
  array type name, an open brace, followed by a comma
16964
18720
  separated list of the elements (using the appropriate
16965
- renderer), followed by a close brace. For example:
16966
- <c>int[] {1, 2, 3}</c>.
18721
+ renderer), followed by a close brace.
18722
+ </para>
18723
+ <para>
18724
+ For example: <c>int[] {1, 2, 3}</c>.
16967
18725
  </para>
16968
18726
  <para>
16969
18727
  If the array is not one dimensional the
@@ -16972,13 +18730,19 @@
16972
18730
  </description>
16973
18731
  </item>
16974
18732
  <item>
16975
- <term><see cref="T:System.Collections.ICollection"/></term>
18733
+ <term><see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> &amp; <see cref="T:System.Collections.IEnumerator"/></term>
16976
18734
  <description>
16977
18735
  <para>
16978
18736
  Rendered as an open brace, followed by a comma
16979
18737
  separated list of the elements (using the appropriate
16980
- renderer), followed by a close brace. For example:
16981
- <c>{a, b, c}</c>.
18738
+ renderer), followed by a close brace.
18739
+ </para>
18740
+ <para>
18741
+ For example: <c>{a, b, c}</c>.
18742
+ </para>
18743
+ <para>
18744
+ All collection classes that implement <see cref="T:System.Collections.ICollection"/> its subclasses,
18745
+ or generic equivalents all implement the <see cref="T:System.Collections.IEnumerable"/> interface.
16982
18746
  </para>
16983
18747
  </description>
16984
18748
  </item>
@@ -16987,7 +18751,10 @@
16987
18751
  <description>
16988
18752
  <para>
16989
18753
  Rendered as the key, an equals sign ('='), and the value (using the appropriate
16990
- renderer). For example: <c>key=value</c>.
18754
+ renderer).
18755
+ </para>
18756
+ <para>
18757
+ For example: <c>key=value</c>.
16991
18758
  </para>
16992
18759
  </description>
16993
18760
  </item>
@@ -17021,12 +18788,12 @@
17021
18788
  </para>
17022
18789
  </remarks>
17023
18790
  </member>
17024
- <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderCollection(log4net.ObjectRenderer.RendererMap,System.Collections.ICollection,System.IO.TextWriter)">
18791
+ <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderEnumerator(log4net.ObjectRenderer.RendererMap,System.Collections.IEnumerator,System.IO.TextWriter)">
17025
18792
  <summary>
17026
- Render the collection argument into a string
18793
+ Render the enumerator argument into a string
17027
18794
  </summary>
17028
18795
  <param name="rendererMap">The map used to lookup renderers</param>
17029
- <param name="collection">the collection to render</param>
18796
+ <param name="enumerator">the enumerator to render</param>
17030
18797
  <param name="writer">The writer to render to</param>
17031
18798
  <remarks>
17032
18799
  <para>
@@ -17167,7 +18934,7 @@
17167
18934
  <remarks>
17168
18935
  <para>
17169
18936
  Register an object renderer for a specific source type.
17170
- This renderer will be returned from a call to <see cref="M:log4net.ObjectRenderer.RendererMap.Get(System.Object)"/>
18937
+ This renderer will be returned from a call to <see cref="M:log4net.ObjectRenderer.RendererMap.Get(System.Type)"/>
17171
18938
  specifying the same <paramref name="typeToRender"/> as an argument.
17172
18939
  </para>
17173
18940
  </remarks>
@@ -18102,6 +19869,9 @@
18102
19869
  Generate a logging event for the specified <paramref name="level"/> using
18103
19870
  the <paramref name="message"/> and <paramref name="exception"/>.
18104
19871
  </para>
19872
+ <para>
19873
+ This method must not throw any exception to the caller.
19874
+ </para>
18105
19875
  </remarks>
18106
19876
  </member>
18107
19877
  <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.LoggingEvent)">
@@ -18114,6 +19884,9 @@
18114
19884
  <para>
18115
19885
  Logs the specified logging event through this logger.
18116
19886
  </para>
19887
+ <para>
19888
+ This method must not throw any exception to the caller.
19889
+ </para>
18117
19890
  </remarks>
18118
19891
  </member>
18119
19892
  <member name="M:log4net.Repository.Hierarchy.Logger.IsEnabledFor(log4net.Core.Level)">
@@ -18128,6 +19901,9 @@
18128
19901
  <para>
18129
19902
  Test if this logger is going to log events of the specified <paramref name="level"/>.
18130
19903
  </para>
19904
+ <para>
19905
+ This method must not throw any exception to the caller.
19906
+ </para>
18131
19907
  </remarks>
18132
19908
  </member>
18133
19909
  <member name="M:log4net.Repository.Hierarchy.Logger.CallAppenders(log4net.Core.LoggingEvent)">
@@ -18504,7 +20280,7 @@
18504
20280
  <remarks>
18505
20281
  <para>
18506
20282
  This interface is implemented by logger repositories. e.g.
18507
- <see cref="N:log4net.Repository.Hierarchy"/>.
20283
+ <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
18508
20284
  </para>
18509
20285
  <para>
18510
20286
  This interface is used by the <see cref="T:log4net.LogManager"/>
@@ -19494,6 +21270,23 @@
19494
21270
  <para>
19495
21271
  Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
19496
21272
  </para>
21273
+ <para>
21274
+ Supports setting levels via the configuration file.
21275
+ </para>
21276
+ </remarks>
21277
+ </member>
21278
+ <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddProperty(log4net.Repository.Hierarchy.Hierarchy.PropertyEntry)">
21279
+ <summary>
21280
+ Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
21281
+ </summary>
21282
+ <param name="propertyEntry">the property value</param>
21283
+ <remarks>
21284
+ <para>
21285
+ Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument.
21286
+ </para>
21287
+ <para>
21288
+ Supports setting property values via the configuration file.
21289
+ </para>
19497
21290
  </remarks>
19498
21291
  </member>
19499
21292
  <member name="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent">
@@ -19540,11 +21333,11 @@
19540
21333
  </member>
19541
21334
  <member name="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry">
19542
21335
  <summary>
19543
- A class to hold the value, name and display name for a logging event
21336
+ A class to hold the value, name and display name for a level
19544
21337
  </summary>
19545
21338
  <remarks>
19546
21339
  <para>
19547
- A class to hold the value, name and display name for a logging event
21340
+ A class to hold the value, name and display name for a level
19548
21341
  </para>
19549
21342
  </remarks>
19550
21343
  </member>
@@ -19591,6 +21384,48 @@
19591
21384
  </para>
19592
21385
  </remarks>
19593
21386
  </member>
21387
+ <member name="T:log4net.Repository.Hierarchy.Hierarchy.PropertyEntry">
21388
+ <summary>
21389
+ A class to hold the key and data for a property set in the config file
21390
+ </summary>
21391
+ <remarks>
21392
+ <para>
21393
+ A class to hold the key and data for a property set in the config file
21394
+ </para>
21395
+ </remarks>
21396
+ </member>
21397
+ <member name="M:log4net.Repository.Hierarchy.Hierarchy.PropertyEntry.ToString">
21398
+ <summary>
21399
+ Override <c>Object.ToString</c> to return sensible debug info
21400
+ </summary>
21401
+ <returns>string info about this object</returns>
21402
+ </member>
21403
+ <member name="P:log4net.Repository.Hierarchy.Hierarchy.PropertyEntry.Key">
21404
+ <summary>
21405
+ Property Key
21406
+ </summary>
21407
+ <value>
21408
+ Property Key
21409
+ </value>
21410
+ <remarks>
21411
+ <para>
21412
+ Property Key.
21413
+ </para>
21414
+ </remarks>
21415
+ </member>
21416
+ <member name="P:log4net.Repository.Hierarchy.Hierarchy.PropertyEntry.Value">
21417
+ <summary>
21418
+ Property Value
21419
+ </summary>
21420
+ <value>
21421
+ Property Value
21422
+ </value>
21423
+ <remarks>
21424
+ <para>
21425
+ Property Value.
21426
+ </para>
21427
+ </remarks>
21428
+ </member>
19594
21429
  <member name="T:log4net.Repository.Hierarchy.LoggerKey">
19595
21430
  <summary>
19596
21431
  Used internally to accelerate hash table searches.
@@ -19888,6 +21723,20 @@
19888
21723
  set the property.
19889
21724
  </remarks>
19890
21725
  </member>
21726
+ <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.HasAttributesOrElements(System.Xml.XmlElement)">
21727
+ <summary>
21728
+ Test if an element has no attributes or child elements
21729
+ </summary>
21730
+ <param name="element">the element to inspect</param>
21731
+ <returns><c>true</c> if the element has any attributes or child elements, <c>false</c> otherwise</returns>
21732
+ </member>
21733
+ <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.IsTypeConstructible(System.Type)">
21734
+ <summary>
21735
+ Test if a <see cref="T:System.Type"/> is constructible with <c>Activator.CreateInstance</c>.
21736
+ </summary>
21737
+ <param name="type">the type to inspect</param>
21738
+ <returns><c>true</c> if the type is creatable using a default constructor, <c>false</c> otherwise</returns>
21739
+ </member>
19891
21740
  <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindMethodInfo(System.Type,System.String)">
19892
21741
  <summary>
19893
21742
  Look for a method on the <paramref name="targetType"/> that matches the <paramref name="name"/> supplied
@@ -20584,7 +22433,8 @@
20584
22433
  types.
20585
22434
  </para>
20586
22435
  <para>
20587
- Use the <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)"/> methods to register new converters.
22436
+ Use the <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)"/> and
22437
+ <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Type)"/> methods to register new converters.
20588
22438
  The <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)"/> and <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)"/> methods
20589
22439
  lookup appropriate converters to use.
20590
22440
  </para>
@@ -20736,8 +22586,8 @@
20736
22586
  <returns>the encoding</returns>
20737
22587
  <remarks>
20738
22588
  <para>
20739
- Uses the <see cref="M:System.Text.Encoding.GetEncoding(System.Int32)"/> method to convert the
20740
- <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>.
22589
+ Uses the <see cref="M:System.Text.Encoding.GetEncoding(System.String)"/> method to
22590
+ convert the <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>.
20741
22591
  </para>
20742
22592
  </remarks>
20743
22593
  <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
@@ -20926,7 +22776,7 @@
20926
22776
  <returns>the converted object</returns>
20927
22777
  <remarks>
20928
22778
  <para>
20929
- Uses the <see cref="M:log4net.Util.PatternString.Format(System.IO.TextWriter)"/> method to convert the
22779
+ Uses the <see cref="M:log4net.Util.PatternString.Format"/> method to convert the
20930
22780
  <see cref="T:log4net.Util.PatternString"/> argument to a <see cref="T:System.String"/>.
20931
22781
  </para>
20932
22782
  </remarks>
@@ -21003,7 +22853,7 @@
21003
22853
  <returns>the Type</returns>
21004
22854
  <remarks>
21005
22855
  <para>
21006
- Uses the <see cref="M:System.Type.GetType(System.String,System.Boolean,System.Boolean)"/> method to convert the
22856
+ Uses the <see cref="M:System.Type.GetType(System.String,System.Boolean)"/> method to convert the
21007
22857
  <see cref="T:System.String"/> argument to a <see cref="T:System.Type"/>.
21008
22858
  Additional effort is made to locate partially specified types
21009
22859
  by searching the loaded assemblies.
@@ -21123,6 +22973,35 @@
21123
22973
  </para>
21124
22974
  </remarks>
21125
22975
  </member>
22976
+ <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent[])">
22977
+ <summary>
22978
+ Append on on all attached appenders.
22979
+ </summary>
22980
+ <param name="loggingEvents">The array of events being logged.</param>
22981
+ <returns>The number of appenders called.</returns>
22982
+ <remarks>
22983
+ <para>
22984
+ Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all
22985
+ attached appenders.
22986
+ </para>
22987
+ </remarks>
22988
+ </member>
22989
+ <member name="M:log4net.Util.AppenderAttachedImpl.CallAppend(log4net.Appender.IAppender,log4net.Core.LoggingEvent[])">
22990
+ <summary>
22991
+ Calls the DoAppende method on the <see cref="T:log4net.Appender.IAppender"/> with
22992
+ the <see cref="T:log4net.Core.LoggingEvent"/> objects supplied.
22993
+ </summary>
22994
+ <param name="appender">The appender</param>
22995
+ <param name="loggingEvents">The events</param>
22996
+ <remarks>
22997
+ <para>
22998
+ If the <paramref name="appender"/> supports the <see cref="T:log4net.Appender.IBulkAppender"/>
22999
+ interface then the <paramref name="loggingEvents"/> will be passed
23000
+ through using that interface. Otherwise the <see cref="T:log4net.Core.LoggingEvent"/>
23001
+ objects in the array will be passed one at a time.
23002
+ </para>
23003
+ </remarks>
23004
+ </member>
21126
23005
  <member name="M:log4net.Util.AppenderAttachedImpl.AddAppender(log4net.Appender.IAppender)">
21127
23006
  <summary>
21128
23007
  Attaches an appender.
@@ -21583,14 +23462,42 @@
21583
23462
  </para>
21584
23463
  </remarks>
21585
23464
  </member>
23465
+ <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char)">
23466
+ <summary>
23467
+ Writes a character to the underlying writer and counts the number of bytes written.
23468
+ </summary>
23469
+ <param name="value">the char to write</param>
23470
+ <remarks>
23471
+ <para>
23472
+ Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
23473
+ the number of bytes written.
23474
+ </para>
23475
+ </remarks>
23476
+ </member>
23477
+ <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
23478
+ <summary>
23479
+ Writes a buffer to the underlying writer and counts the number of bytes written.
23480
+ </summary>
23481
+ <param name="buffer">the buffer to write</param>
23482
+ <param name="index">the start index to write from</param>
23483
+ <param name="count">the number of characters to write</param>
23484
+ <remarks>
23485
+ <para>
23486
+ Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
23487
+ the number of bytes written.
23488
+ </para>
23489
+ </remarks>
23490
+ </member>
21586
23491
  <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.String)">
21587
23492
  <summary>
21588
23493
  Writes a string to the output and counts the number of bytes written.
21589
23494
  </summary>
21590
23495
  <param name="str">The string data to write to the output.</param>
21591
23496
  <remarks>
23497
+ <para>
21592
23498
  Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
21593
23499
  the number of bytes written.
23500
+ </para>
21594
23501
  </remarks>
21595
23502
  </member>
21596
23503
  <member name="F:log4net.Util.CountingQuietTextWriter.m_countBytes">
@@ -21673,6 +23580,16 @@
21673
23580
  </para>
21674
23581
  </remarks>
21675
23582
  </member>
23583
+ <member name="M:log4net.Util.CyclicBuffer.Clear">
23584
+ <summary>
23585
+ Clear the buffer
23586
+ </summary>
23587
+ <remarks>
23588
+ <para>
23589
+ Clear the buffer of all events. The events in the buffer are lost.
23590
+ </para>
23591
+ </remarks>
23592
+ </member>
21676
23593
  <member name="P:log4net.Util.CyclicBuffer.Item(System.Int32)">
21677
23594
  <summary>
21678
23595
  Gets the <paramref name="i"/>th oldest event currently in the buffer.
@@ -22484,8 +24401,14 @@
22484
24401
  <param name="message">The message to log.</param>
22485
24402
  <remarks>
22486
24403
  <para>
22487
- Uses Console.Out for console output,
22488
- and Trace for OutputDebugString output.
24404
+ Writes to both Console.Out and System.Diagnostics.Trace.
24405
+ Note that the System.Diagnostics.Trace is not supported
24406
+ on the Compact Framework.
24407
+ </para>
24408
+ <para>
24409
+ If the AppDomain is not configured with a config file then
24410
+ the call to System.Diagnostics.Trace may fail. This is only
24411
+ an issue if you are programmatically creating your own AppDomains.
22489
24412
  </para>
22490
24413
  </remarks>
22491
24414
  </member>
@@ -22496,8 +24419,14 @@
22496
24419
  <param name="message">The message to log.</param>
22497
24420
  <remarks>
22498
24421
  <para>
22499
- Use Console.Error for console output,
22500
- and Trace for OutputDebugString output.
24422
+ Writes to both Console.Error and System.Diagnostics.Trace.
24423
+ Note that the System.Diagnostics.Trace is not supported
24424
+ on the Compact Framework.
24425
+ </para>
24426
+ <para>
24427
+ If the AppDomain is not configured with a config file then
24428
+ the call to System.Diagnostics.Trace may fail. This is only
24429
+ an issue if you are programmatically creating your own AppDomains.
22501
24430
  </para>
22502
24431
  </remarks>
22503
24432
  </member>
@@ -22585,43 +24514,187 @@
22585
24514
  </code>
22586
24515
  </example>
22587
24516
  </member>
22588
- <member name="P:log4net.Util.LogLog.IsDebugEnabled">
24517
+ <member name="P:log4net.Util.LogLog.IsDebugEnabled">
24518
+ <summary>
24519
+ Test if LogLog.Debug is enabled for output.
24520
+ </summary>
24521
+ <value>
24522
+ <c>true</c> if Debug is enabled
24523
+ </value>
24524
+ <remarks>
24525
+ <para>
24526
+ Test if LogLog.Debug is enabled for output.
24527
+ </para>
24528
+ </remarks>
24529
+ </member>
24530
+ <member name="P:log4net.Util.LogLog.IsWarnEnabled">
24531
+ <summary>
24532
+ Test if LogLog.Warn is enabled for output.
24533
+ </summary>
24534
+ <value>
24535
+ <c>true</c> if Warn is enabled
24536
+ </value>
24537
+ <remarks>
24538
+ <para>
24539
+ Test if LogLog.Warn is enabled for output.
24540
+ </para>
24541
+ </remarks>
24542
+ </member>
24543
+ <member name="P:log4net.Util.LogLog.IsErrorEnabled">
24544
+ <summary>
24545
+ Test if LogLog.Error is enabled for output.
24546
+ </summary>
24547
+ <value>
24548
+ <c>true</c> if Error is enabled
24549
+ </value>
24550
+ <remarks>
24551
+ <para>
24552
+ Test if LogLog.Error is enabled for output.
24553
+ </para>
24554
+ </remarks>
24555
+ </member>
24556
+ <member name="T:log4net.Util.NativeError">
24557
+ <summary>
24558
+ Represents a native error code and message.
24559
+ </summary>
24560
+ <remarks>
24561
+ <para>
24562
+ Represents a Win32 platform native error.
24563
+ </para>
24564
+ </remarks>
24565
+ <author>Nicko Cadell</author>
24566
+ <author>Gert Driesen</author>
24567
+ </member>
24568
+ <member name="M:log4net.Util.NativeError.#ctor(System.Int32,System.String)">
24569
+ <summary>
24570
+ Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
24571
+ error number and message.
24572
+ </summary>
24573
+ <param name="number">The number of the native error.</param>
24574
+ <param name="message">The message of the native error.</param>
24575
+ <remarks>
24576
+ <para>
24577
+ Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
24578
+ error number and message.
24579
+ </para>
24580
+ </remarks>
24581
+ </member>
24582
+ <member name="M:log4net.Util.NativeError.GetLastError">
24583
+ <summary>
24584
+ Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class for the last Windows error.
24585
+ </summary>
24586
+ <returns>
24587
+ An instance of the <see cref="T:log4net.Util.NativeError"/> class for the last windows error.
24588
+ </returns>
24589
+ <remarks>
24590
+ <para>
24591
+ The message for the <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/> error number is lookup up using the
24592
+ native Win32 <c>FormatMessage</c> function.
24593
+ </para>
24594
+ </remarks>
24595
+ </member>
24596
+ <member name="M:log4net.Util.NativeError.GetError(System.Int32)">
24597
+ <summary>
24598
+ Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class.
24599
+ </summary>
24600
+ <param name="number">the error number for the native error</param>
24601
+ <returns>
24602
+ An instance of the <see cref="T:log4net.Util.NativeError"/> class for the specified
24603
+ error number.
24604
+ </returns>
24605
+ <remarks>
24606
+ <para>
24607
+ The message for the specified error number is lookup up using the
24608
+ native Win32 <c>FormatMessage</c> function.
24609
+ </para>
24610
+ </remarks>
24611
+ </member>
24612
+ <member name="M:log4net.Util.NativeError.GetErrorMessage(System.Int32)">
24613
+ <summary>
24614
+ Retrieves the message corresponding with a Win32 message identifier.
24615
+ </summary>
24616
+ <param name="messageId">Message identifier for the requested message.</param>
24617
+ <returns>
24618
+ The message corresponding with the specified message identifier.
24619
+ </returns>
24620
+ <remarks>
24621
+ <para>
24622
+ The message will be searched for in system message-table resource(s)
24623
+ using the native <c>FormatMessage</c> function.
24624
+ </para>
24625
+ </remarks>
24626
+ </member>
24627
+ <member name="M:log4net.Util.NativeError.ToString">
24628
+ <summary>
24629
+ Return error information string
24630
+ </summary>
24631
+ <returns>error information string</returns>
24632
+ <remarks>
24633
+ <para>
24634
+ Return error information string
24635
+ </para>
24636
+ </remarks>
24637
+ </member>
24638
+ <member name="M:log4net.Util.NativeError.FormatMessage(System.Int32,System.IntPtr@,System.Int32,System.Int32,System.String@,System.Int32,System.IntPtr)">
22589
24639
  <summary>
22590
- Test if LogLog.Debug is enabled for output.
24640
+ Formats a message string.
22591
24641
  </summary>
22592
- <value>
22593
- <c>true</c> if Debug is enabled
22594
- </value>
24642
+ <param name="dwFlags">Formatting options, and how to interpret the <paramref name="lpSource"/> parameter.</param>
24643
+ <param name="lpSource">Location of the message definition.</param>
24644
+ <param name="dwMessageId">Message identifier for the requested message.</param>
24645
+ <param name="dwLanguageId">Language identifier for the requested message.</param>
24646
+ <param name="lpBuffer">If <paramref name="dwFlags"/> includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the <c>LocalAlloc</c> function, and places the pointer to the buffer at the address specified in <paramref name="lpBuffer"/>.</param>
24647
+ <param name="nSize">If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer.</param>
24648
+ <param name="Arguments">Pointer to an array of values that are used as insert values in the formatted message.</param>
22595
24649
  <remarks>
22596
24650
  <para>
22597
- Test if LogLog.Debug is enabled for output.
24651
+ The function requires a message definition as input. The message definition can come from a
24652
+ buffer passed into the function. It can come from a message table resource in an
24653
+ already-loaded module. Or the caller can ask the function to search the system's message
24654
+ table resource(s) for the message definition. The function finds the message definition
24655
+ in a message table resource based on a message identifier and a language identifier.
24656
+ The function copies the formatted message text to an output buffer, processing any embedded
24657
+ insert sequences if requested.
24658
+ </para>
24659
+ <para>
24660
+ To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message.
22598
24661
  </para>
22599
24662
  </remarks>
24663
+ <returns>
24664
+ <para>
24665
+ If the function succeeds, the return value is the number of TCHARs stored in the output
24666
+ buffer, excluding the terminating null character.
24667
+ </para>
24668
+ <para>
24669
+ If the function fails, the return value is zero. To get extended error information,
24670
+ call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
24671
+ </para>
24672
+ </returns>
22600
24673
  </member>
22601
- <member name="P:log4net.Util.LogLog.IsWarnEnabled">
24674
+ <member name="P:log4net.Util.NativeError.Number">
22602
24675
  <summary>
22603
- Test if LogLog.Warn is enabled for output.
24676
+ Gets the number of the native error.
22604
24677
  </summary>
22605
24678
  <value>
22606
- <c>true</c> if Warn is enabled
24679
+ The number of the native error.
22607
24680
  </value>
22608
24681
  <remarks>
22609
24682
  <para>
22610
- Test if LogLog.Warn is enabled for output.
24683
+ Gets the number of the native error.
22611
24684
  </para>
22612
24685
  </remarks>
22613
24686
  </member>
22614
- <member name="P:log4net.Util.LogLog.IsErrorEnabled">
24687
+ <member name="P:log4net.Util.NativeError.Message">
22615
24688
  <summary>
22616
- Test if LogLog.Error is enabled for output.
24689
+ Gets the message of the native error.
22617
24690
  </summary>
22618
24691
  <value>
22619
- <c>true</c> if Error is enabled
24692
+ The message of the native error.
22620
24693
  </value>
22621
24694
  <remarks>
22622
24695
  <para>
22623
- Test if LogLog.Error is enabled for output.
22624
24696
  </para>
24697
+ Gets the message of the native error.
22625
24698
  </remarks>
22626
24699
  </member>
22627
24700
  <member name="T:log4net.Util.NullDictionaryEnumerator">
@@ -23299,15 +25372,15 @@
23299
25372
  This class functions similarly to the <see cref="T:log4net.Layout.PatternLayout"/>
23300
25373
  in that it accepts a pattern and renders it to a string. Unlike the
23301
25374
  <see cref="T:log4net.Layout.PatternLayout"/> however the <c>PatternString</c>
23302
- does does not render properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but
25375
+ does not render the properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but
23303
25376
  of the process in general.
23304
25377
  </para>
23305
25378
  <para>
23306
- The recognized conversion characters are:
25379
+ The recognized conversion pattern names are:
23307
25380
  </para>
23308
25381
  <list type="table">
23309
25382
  <listheader>
23310
- <term>Conversion Character</term>
25383
+ <term>Conversion Pattern Name</term>
23311
25384
  <description>Effect</description>
23312
25385
  </listheader>
23313
25386
  <item>
@@ -23333,7 +25406,7 @@
23333
25406
  </para>
23334
25407
  <para>
23335
25408
  The date format specifier admits the same syntax as the
23336
- time pattern string of the <see cref="M:System.DateTime.ToString"/>.
25409
+ time pattern string of the <see cref="M:System.DateTime.ToString(System.String)"/>.
23337
25410
  </para>
23338
25411
  <para>
23339
25412
  For better results it is recommended to use the log4net date
@@ -23381,7 +25454,7 @@
23381
25454
  characters.
23382
25455
  </para>
23383
25456
  <para>
23384
- This conversion character offers the same performance as using
25457
+ This conversion pattern name offers the same performance as using
23385
25458
  non-portable line separator strings such as "\n", or "\r\n".
23386
25459
  Thus, it is the preferred way of specifying a line separator.
23387
25460
  </para>
@@ -23468,7 +25541,7 @@
23468
25541
  </para>
23469
25542
  <para>
23470
25543
  The date format specifier admits the same syntax as the
23471
- time pattern string of the <see cref="M:System.DateTime.ToString"/>.
25544
+ time pattern string of the <see cref="M:System.DateTime.ToString(System.String)"/>.
23472
25545
  </para>
23473
25546
  <para>
23474
25547
  For better results it is recommended to use the log4net date
@@ -23496,7 +25569,8 @@
23496
25569
  </list>
23497
25570
  <para>
23498
25571
  Additional pattern converters may be registered with a specific <see cref="T:log4net.Util.PatternString"/>
23499
- instance using the <see cref="M:log4net.Util.PatternString.AddConverter(log4net.Util.PatternString.ConverterInfo)"/> methods.
25572
+ instance using <see cref="M:log4net.Util.PatternString.AddConverter(log4net.Util.PatternString.ConverterInfo)"/> or
25573
+ <see cref="M:log4net.Util.PatternString.AddConverter(System.String,System.Type)"/>.
23500
25574
  </para>
23501
25575
  <para>
23502
25576
  See the <see cref="T:log4net.Layout.PatternLayout"/> for details on the
@@ -23579,7 +25653,7 @@
23579
25653
  <para>
23580
25654
  Returns PatternParser used to parse the conversion string. Subclasses
23581
25655
  may override this to return a subclass of PatternParser which recognize
23582
- custom conversion characters.
25656
+ custom conversion pattern name.
23583
25657
  </para>
23584
25658
  </remarks>
23585
25659
  </member>
@@ -23866,7 +25940,7 @@
23866
25940
  See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
23867
25941
  </summary>
23868
25942
  </member>
23869
- <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#$Item$(System.Object)">
25943
+ <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
23870
25944
  <summary>
23871
25945
  See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
23872
25946
  </summary>
@@ -24045,7 +26119,7 @@
24045
26119
  </para>
24046
26120
  </remarks>
24047
26121
  </member>
24048
- <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#$Item$(System.Object)">
26122
+ <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
24049
26123
  <summary>
24050
26124
  See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
24051
26125
  </summary>
@@ -24273,6 +26347,16 @@
24273
26347
  </para>
24274
26348
  </remarks>
24275
26349
  </member>
26350
+ <member name="M:log4net.Util.SystemInfo.#cctor">
26351
+ <summary>
26352
+ Initialize default values for private static fields.
26353
+ </summary>
26354
+ <remarks>
26355
+ <para>
26356
+ Only static methods are exposed from this type.
26357
+ </para>
26358
+ </remarks>
26359
+ </member>
24276
26360
  <member name="M:log4net.Util.SystemInfo.AssemblyLocationInfo(System.Reflection.Assembly)">
24277
26361
  <summary>
24278
26362
  Gets the assembly location path for the specified assembly.
@@ -24464,6 +26548,18 @@
24464
26548
  </para>
24465
26549
  </remarks>
24466
26550
  </member>
26551
+ <member name="M:log4net.Util.SystemInfo.GetAppSetting(System.String)">
26552
+ <summary>
26553
+ Lookup an application setting
26554
+ </summary>
26555
+ <param name="key">the application settings key to lookup</param>
26556
+ <returns>the value for the key, or <c>null</c></returns>
26557
+ <remarks>
26558
+ <para>
26559
+ Configuration APIs are not supported under the Compact Framework
26560
+ </para>
26561
+ </remarks>
26562
+ </member>
24467
26563
  <member name="M:log4net.Util.SystemInfo.ConvertToFullPath(System.String)">
24468
26564
  <summary>
24469
26565
  Convert a path into a fully qualified local file path.
@@ -24482,6 +26578,17 @@
24482
26578
  </para>
24483
26579
  </remarks>
24484
26580
  </member>
26581
+ <member name="M:log4net.Util.SystemInfo.CreateCaseInsensitiveHashtable">
26582
+ <summary>
26583
+ Creates a new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity.
26584
+ </summary>
26585
+ <returns>A new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity</returns>
26586
+ <remarks>
26587
+ <para>
26588
+ The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer.
26589
+ </para>
26590
+ </remarks>
26591
+ </member>
24485
26592
  <member name="F:log4net.Util.SystemInfo.EmptyTypes">
24486
26593
  <summary>
24487
26594
  Gets an empty array of types.
@@ -24503,6 +26610,21 @@
24503
26610
  Cache the application friendly name
24504
26611
  </summary>
24505
26612
  </member>
26613
+ <member name="F:log4net.Util.SystemInfo.s_nullText">
26614
+ <summary>
26615
+ Text to output when a <c>null</c> is encountered.
26616
+ </summary>
26617
+ </member>
26618
+ <member name="F:log4net.Util.SystemInfo.s_notAvailableText">
26619
+ <summary>
26620
+ Text to output when an unsupported feature is requested.
26621
+ </summary>
26622
+ </member>
26623
+ <member name="F:log4net.Util.SystemInfo.s_processStartTime">
26624
+ <summary>
26625
+ Start time for the current process.
26626
+ </summary>
26627
+ </member>
24506
26628
  <member name="P:log4net.Util.SystemInfo.NewLine">
24507
26629
  <summary>
24508
26630
  Gets the system dependent line terminator.
@@ -24574,6 +26696,11 @@
24574
26696
  <c>GetCurrentThreadId</c> is implemented inline in a header file
24575
26697
  and cannot be called.
24576
26698
  </para>
26699
+ <para>
26700
+ On the .NET Framework 2.0 the <c>Thread.ManagedThreadId</c> is used as this
26701
+ gives a stable id unrelated to the operating system thread ID which may
26702
+ change if the runtime is using fibers.
26703
+ </para>
24577
26704
  </remarks>
24578
26705
  </member>
24579
26706
  <member name="P:log4net.Util.SystemInfo.HostName">
@@ -24618,17 +26745,113 @@
24618
26745
  </summary>
24619
26746
  <remarks>
24620
26747
  <para>
24621
- Tries to get the start time for the current process.
24622
- Failing that it returns the time of the first call to
24623
- this property.
26748
+ This is the time at which the log4net library was loaded into the
26749
+ AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
26750
+ this is not the start time for the current process.
26751
+ </para>
26752
+ <para>
26753
+ The log4net library should be loaded by an application early during its
26754
+ startup, therefore this start time should be a good approximation for
26755
+ the actual start time.
24624
26756
  </para>
24625
26757
  <para>
24626
26758
  Note that AppDomains may be loaded and unloaded within the
24627
- same process without the process terminating and therefore
24628
- without the process start time being reset.
26759
+ same process without the process terminating, however this start time
26760
+ will be set per AppDomain.
26761
+ </para>
26762
+ </remarks>
26763
+ </member>
26764
+ <member name="P:log4net.Util.SystemInfo.NullText">
26765
+ <summary>
26766
+ Text to output when a <c>null</c> is encountered.
26767
+ </summary>
26768
+ <remarks>
26769
+ <para>
26770
+ Use this value to indicate a <c>null</c> has been encountered while
26771
+ outputting a string representation of an item.
26772
+ </para>
26773
+ <para>
26774
+ The default value is <c>(null)</c>. This value can be overridden by specifying
26775
+ a value for the <c>log4net.NullText</c> appSetting in the application's
26776
+ .config file.
26777
+ </para>
26778
+ </remarks>
26779
+ </member>
26780
+ <member name="P:log4net.Util.SystemInfo.NotAvailableText">
26781
+ <summary>
26782
+ Text to output when an unsupported feature is requested.
26783
+ </summary>
26784
+ <remarks>
26785
+ <para>
26786
+ Use this value when an unsupported feature is requested.
26787
+ </para>
26788
+ <para>
26789
+ The default value is <c>NOT AVAILABLE</c>. This value can be overridden by specifying
26790
+ a value for the <c>log4net.NotAvailableText</c> appSetting in the application's
26791
+ .config file.
26792
+ </para>
26793
+ </remarks>
26794
+ </member>
26795
+ <member name="T:log4net.Util.SystemStringFormat">
26796
+ <summary>
26797
+ Utility class that represents a format string.
26798
+ </summary>
26799
+ <remarks>
26800
+ <para>
26801
+ Utility class that represents a format string.
26802
+ </para>
26803
+ </remarks>
26804
+ <author>Nicko Cadell</author>
26805
+ </member>
26806
+ <member name="M:log4net.Util.SystemStringFormat.#ctor(System.IFormatProvider,System.String,System.Object[])">
26807
+ <summary>
26808
+ Initialise the <see cref="T:log4net.Util.SystemStringFormat"/>
26809
+ </summary>
26810
+ <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
26811
+ <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
26812
+ <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
26813
+ </member>
26814
+ <member name="M:log4net.Util.SystemStringFormat.ToString">
26815
+ <summary>
26816
+ Format the string and arguments
26817
+ </summary>
26818
+ <returns>the formatted string</returns>
26819
+ </member>
26820
+ <member name="M:log4net.Util.SystemStringFormat.StringFormat(System.IFormatProvider,System.String,System.Object[])">
26821
+ <summary>
26822
+ Replaces the format item in a specified <see cref="T:System.String"/> with the text equivalent
26823
+ of the value of a corresponding <see cref="T:System.Object"/> instance in a specified array.
26824
+ A specified parameter supplies culture-specific formatting information.
26825
+ </summary>
26826
+ <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
26827
+ <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
26828
+ <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
26829
+ <returns>
26830
+ A copy of format in which the format items have been replaced by the <see cref="T:System.String"/>
26831
+ equivalent of the corresponding instances of <see cref="T:System.Object"/> in args.
26832
+ </returns>
26833
+ <remarks>
26834
+ <para>
26835
+ This method does not throw exceptions. If an exception thrown while formatting the result the
26836
+ exception and arguments are returned in the result string.
24629
26837
  </para>
24630
26838
  </remarks>
24631
26839
  </member>
26840
+ <member name="M:log4net.Util.SystemStringFormat.StringFormatError(System.Exception,System.String,System.Object[])">
26841
+ <summary>
26842
+ Process an error during StringFormat
26843
+ </summary>
26844
+ </member>
26845
+ <member name="M:log4net.Util.SystemStringFormat.RenderArray(System.Array,System.Text.StringBuilder)">
26846
+ <summary>
26847
+ Dump the contents of an array into a string builder
26848
+ </summary>
26849
+ </member>
26850
+ <member name="M:log4net.Util.SystemStringFormat.RenderObject(System.Object,System.Text.StringBuilder)">
26851
+ <summary>
26852
+ Dump an object to a string
26853
+ </summary>
26854
+ </member>
24632
26855
  <member name="T:log4net.Util.ThreadContextProperties">
24633
26856
  <summary>
24634
26857
  Implementation of Properties collection for the <see cref="T:log4net.ThreadContext"/>
@@ -24793,12 +27016,12 @@
24793
27016
  </member>
24794
27017
  <member name="M:log4net.Util.ThreadContextStack.ToString">
24795
27018
  <summary>
24796
- Gets the current context information for this stack.
27019
+ Gets the current context information for this stack.
24797
27020
  </summary>
24798
27021
  <returns>Gets the current context information</returns>
24799
27022
  <remarks>
24800
27023
  <para>
24801
- Gets the current context information for this stack.
27024
+ Gets the current context information for this stack.
24802
27025
  </para>
24803
27026
  </remarks>
24804
27027
  </member>
@@ -24988,12 +27211,13 @@
24988
27211
  </para>
24989
27212
  </remarks>
24990
27213
  </member>
24991
- <member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String)">
27214
+ <member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String,System.String)">
24992
27215
  <summary>
24993
27216
  Write a string to an <see cref="T:System.Xml.XmlWriter"/>
24994
27217
  </summary>
24995
27218
  <param name="writer">the writer to write to</param>
24996
- <param name="stringData">the string to write</param>
27219
+ <param name="textData">the string to write</param>
27220
+ <param name="invalidCharReplacement">The string to replace non XML compliant chars with</param>
24997
27221
  <remarks>
24998
27222
  <para>
24999
27223
  The test is escaped either using XML escape entities
@@ -25001,6 +27225,24 @@
25001
27225
  </para>
25002
27226
  </remarks>
25003
27227
  </member>
27228
+ <member name="M:log4net.Util.Transform.MaskXmlInvalidCharacters(System.String,System.String)">
27229
+ <summary>
27230
+ Replace invalid XML characters in text string
27231
+ </summary>
27232
+ <param name="textData">the XML text input string</param>
27233
+ <param name="mask">the string to use in place of invalid characters</param>
27234
+ <returns>A string that does not contain invalid XML characters.</returns>
27235
+ <remarks>
27236
+ <para>
27237
+ Certain Unicode code points are not allowed in the XML InfoSet, for
27238
+ details see: <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a>.
27239
+ </para>
27240
+ <para>
27241
+ This method replaces any illegal characters in the input string
27242
+ with the mask string specified.
27243
+ </para>
27244
+ </remarks>
27245
+ </member>
25004
27246
  <member name="M:log4net.Util.Transform.CountSubstrings(System.String,System.String)">
25005
27247
  <summary>
25006
27248
  Count the number of times that the substring occurs in the text
@@ -25014,6 +27256,215 @@
25014
27256
  </para>
25015
27257
  </remarks>
25016
27258
  </member>
27259
+ <member name="T:log4net.Util.WindowsSecurityContext">
27260
+ <summary>
27261
+ Impersonate a Windows Account
27262
+ </summary>
27263
+ <remarks>
27264
+ <para>
27265
+ This <see cref="T:log4net.Core.SecurityContext"/> impersonates a Windows account.
27266
+ </para>
27267
+ <para>
27268
+ How the impersonation is done depends on the value of <see cref="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)"/>.
27269
+ This allows the context to either impersonate a set of user credentials specified
27270
+ using username, domain name and password or to revert to the process credentials.
27271
+ </para>
27272
+ </remarks>
27273
+ </member>
27274
+ <member name="M:log4net.Util.WindowsSecurityContext.#ctor">
27275
+ <summary>
27276
+ Default constructor
27277
+ </summary>
27278
+ <remarks>
27279
+ <para>
27280
+ Default constructor
27281
+ </para>
27282
+ </remarks>
27283
+ </member>
27284
+ <member name="M:log4net.Util.WindowsSecurityContext.ActivateOptions">
27285
+ <summary>
27286
+ Initialize the SecurityContext based on the options set.
27287
+ </summary>
27288
+ <remarks>
27289
+ <para>
27290
+ This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
27291
+ activation scheme. The <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> method must
27292
+ be called on this object after the configuration properties have
27293
+ been set. Until <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> is called this
27294
+ object is in an undefined state and must not be used.
27295
+ </para>
27296
+ <para>
27297
+ If any of the configuration properties are modified then
27298
+ <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> must be called again.
27299
+ </para>
27300
+ <para>
27301
+ The security context will try to Logon the specified user account and
27302
+ capture a primary token for impersonation.
27303
+ </para>
27304
+ </remarks>
27305
+ <exception cref="T:System.ArgumentNullException">The required <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>,
27306
+ <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> or <see cref="P:log4net.Util.WindowsSecurityContext.Password"/> properties were not specified.</exception>
27307
+ </member>
27308
+ <member name="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)">
27309
+ <summary>
27310
+ Impersonate the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
27311
+ </summary>
27312
+ <param name="state">caller provided state</param>
27313
+ <returns>
27314
+ An <see cref="T:System.IDisposable"/> instance that will revoke the impersonation of this SecurityContext
27315
+ </returns>
27316
+ <remarks>
27317
+ <para>
27318
+ Depending on the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property either
27319
+ impersonate a user using credentials supplied or revert
27320
+ to the process credentials.
27321
+ </para>
27322
+ </remarks>
27323
+ </member>
27324
+ <member name="M:log4net.Util.WindowsSecurityContext.LogonUser(System.String,System.String,System.String)">
27325
+ <summary>
27326
+ Create a <see cref="T:System.Security.Principal.WindowsIdentity"/> given the userName, domainName and password.
27327
+ </summary>
27328
+ <param name="userName">the user name</param>
27329
+ <param name="domainName">the domain name</param>
27330
+ <param name="password">the password</param>
27331
+ <returns>the <see cref="T:System.Security.Principal.WindowsIdentity"/> for the account specified</returns>
27332
+ <remarks>
27333
+ <para>
27334
+ Uses the Windows API call LogonUser to get a principal token for the account. This
27335
+ token is used to initialize the WindowsIdentity.
27336
+ </para>
27337
+ </remarks>
27338
+ </member>
27339
+ <member name="P:log4net.Util.WindowsSecurityContext.Credentials">
27340
+ <summary>
27341
+ Gets or sets the impersonation mode for this security context
27342
+ </summary>
27343
+ <value>
27344
+ The impersonation mode for this security context
27345
+ </value>
27346
+ <remarks>
27347
+ <para>
27348
+ Impersonate either a user with user credentials or
27349
+ revert this thread to the credentials of the process.
27350
+ The value is one of the <see cref="T:log4net.Util.WindowsSecurityContext.ImpersonationMode"/>
27351
+ enum.
27352
+ </para>
27353
+ <para>
27354
+ The default value is <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
27355
+ </para>
27356
+ <para>
27357
+ When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
27358
+ the user's credentials are established using the
27359
+ <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>, <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.Password"/>
27360
+ values.
27361
+ </para>
27362
+ <para>
27363
+ When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process"/>
27364
+ no other properties need to be set. If the calling thread is
27365
+ impersonating then it will be reverted back to the process credentials.
27366
+ </para>
27367
+ </remarks>
27368
+ </member>
27369
+ <member name="P:log4net.Util.WindowsSecurityContext.UserName">
27370
+ <summary>
27371
+ Gets or sets the Windows username for this security context
27372
+ </summary>
27373
+ <value>
27374
+ The Windows username for this security context
27375
+ </value>
27376
+ <remarks>
27377
+ <para>
27378
+ This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
27379
+ is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
27380
+ </para>
27381
+ </remarks>
27382
+ </member>
27383
+ <member name="P:log4net.Util.WindowsSecurityContext.DomainName">
27384
+ <summary>
27385
+ Gets or sets the Windows domain name for this security context
27386
+ </summary>
27387
+ <value>
27388
+ The Windows domain name for this security context
27389
+ </value>
27390
+ <remarks>
27391
+ <para>
27392
+ The default value for <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> is the local machine name
27393
+ taken from the <see cref="P:System.Environment.MachineName"/> property.
27394
+ </para>
27395
+ <para>
27396
+ This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
27397
+ is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
27398
+ </para>
27399
+ </remarks>
27400
+ </member>
27401
+ <member name="P:log4net.Util.WindowsSecurityContext.Password">
27402
+ <summary>
27403
+ Sets the password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
27404
+ </summary>
27405
+ <value>
27406
+ The password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
27407
+ </value>
27408
+ <remarks>
27409
+ <para>
27410
+ This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
27411
+ is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
27412
+ </para>
27413
+ </remarks>
27414
+ </member>
27415
+ <member name="T:log4net.Util.WindowsSecurityContext.ImpersonationMode">
27416
+ <summary>
27417
+ The impersonation modes for the <see cref="T:log4net.Util.WindowsSecurityContext"/>
27418
+ </summary>
27419
+ <remarks>
27420
+ <para>
27421
+ See the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property for
27422
+ details.
27423
+ </para>
27424
+ </remarks>
27425
+ </member>
27426
+ <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User">
27427
+ <summary>
27428
+ Impersonate a user using the credentials supplied
27429
+ </summary>
27430
+ </member>
27431
+ <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process">
27432
+ <summary>
27433
+ Revert this the thread to the credentials of the process
27434
+ </summary>
27435
+ </member>
27436
+ <member name="T:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext">
27437
+ <summary>
27438
+ Adds <see cref="T:System.IDisposable"/> to <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
27439
+ </summary>
27440
+ <remarks>
27441
+ <para>
27442
+ Helper class to expose the <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
27443
+ through the <see cref="T:System.IDisposable"/> interface.
27444
+ </para>
27445
+ </remarks>
27446
+ </member>
27447
+ <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.#ctor(System.Security.Principal.WindowsImpersonationContext)">
27448
+ <summary>
27449
+ Constructor
27450
+ </summary>
27451
+ <param name="impersonationContext">the impersonation context being wrapped</param>
27452
+ <remarks>
27453
+ <para>
27454
+ Constructor
27455
+ </para>
27456
+ </remarks>
27457
+ </member>
27458
+ <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.Dispose">
27459
+ <summary>
27460
+ Revert the impersonation
27461
+ </summary>
27462
+ <remarks>
27463
+ <para>
27464
+ Revert the impersonation
27465
+ </para>
27466
+ </remarks>
27467
+ </member>
25017
27468
  <member name="T:log4net.GlobalContext">
25018
27469
  <summary>
25019
27470
  The log4net Global Context.
@@ -25166,8 +27617,8 @@
25166
27617
  <remarks>
25167
27618
  <para>
25168
27619
  This class has static methods that are used by a client to request
25169
- a logger instance. The <see cref="M:log4net.LogManager.GetLogger(System.String)"/> method is used to
25170
- retrieve a logger.
27620
+ a logger instance. The <see cref="M:log4net.LogManager.GetLogger(System.String)"/> method is
27621
+ used to retrieve a logger.
25171
27622
  </para>
25172
27623
  <para>
25173
27624
  See the <see cref="T:log4net.ILog"/> interface for more details.