You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

32439 lines
1.4 MiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>log4net</name>
  5. </assembly>
  6. <members>
  7. <member name="T:log4net.Appender.AdoNetAppender">
  8. <summary>
  9. Appender that logs to a database.
  10. </summary>
  11. <remarks>
  12. <para>
  13. <see cref="T:log4net.Appender.AdoNetAppender"/> appends logging events to a table within a
  14. database. The appender can be configured to specify the connection
  15. string by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionString"/> property.
  16. The connection type (provider) can be specified by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/>
  17. property. For more information on database connection strings for
  18. your specific database see <a href="http://www.connectionstrings.com/">http://www.connectionstrings.com/</a>.
  19. </para>
  20. <para>
  21. Records are written into the database either using a prepared
  22. statement or a stored procedure. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property
  23. is set to <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify a prepared statement
  24. or to <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify a stored
  25. procedure.
  26. </para>
  27. <para>
  28. The prepared statement text or the name of the stored procedure
  29. must be set in the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property.
  30. </para>
  31. <para>
  32. The prepared statement or stored procedure can take a number
  33. of parameters. Parameters are added using the <see cref="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)"/>
  34. method. This adds a single <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> to the
  35. ordered list of parameters. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/>
  36. type may be subclassed if required to provide database specific
  37. functionality. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> specifies
  38. the parameter name, database type, size, and how the value should
  39. be generated using a <see cref="T:log4net.Layout.ILayout"/>.
  40. </para>
  41. </remarks>
  42. <example>
  43. An example of a SQL Server table that could be logged to:
  44. <code lang="SQL">
  45. CREATE TABLE [dbo].[Log] (
  46. [ID] [int] IDENTITY (1, 1) NOT NULL ,
  47. [Date] [datetime] NOT NULL ,
  48. [Thread] [varchar] (255) NOT NULL ,
  49. [Level] [varchar] (20) NOT NULL ,
  50. [Logger] [varchar] (255) NOT NULL ,
  51. [Message] [varchar] (4000) NOT NULL
  52. ) ON [PRIMARY]
  53. </code>
  54. </example>
  55. <example>
  56. An example configuration to log to the above table:
  57. <code lang="XML" escaped="true">
  58. <appender name="AdoNetAppender_SqlServer" type="log4net.Appender.AdoNetAppender">
  59. <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/>
  60. <connectionString value="data source=SQLSVR;initial catalog=test_log4net;integrated security=false;persist security info=True;User ID=sa;Password=sa"/>
  61. <commandText value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message]) VALUES (@log_date, @thread, @log_level, @logger, @message)"/>
  62. <parameter>
  63. <parameterName value="@log_date"/>
  64. <dbType value="DateTime"/>
  65. <layout type="log4net.Layout.PatternLayout" value="%date{yyyy'-'MM'-'dd HH':'mm':'ss'.'fff}"/>
  66. </parameter>
  67. <parameter>
  68. <parameterName value="@thread"/>
  69. <dbType value="String"/>
  70. <size value="255"/>
  71. <layout type="log4net.Layout.PatternLayout" value="%thread"/>
  72. </parameter>
  73. <parameter>
  74. <parameterName value="@log_level"/>
  75. <dbType value="String"/>
  76. <size value="50"/>
  77. <layout type="log4net.Layout.PatternLayout" value="%level"/>
  78. </parameter>
  79. <parameter>
  80. <parameterName value="@logger"/>
  81. <dbType value="String"/>
  82. <size value="255"/>
  83. <layout type="log4net.Layout.PatternLayout" value="%logger"/>
  84. </parameter>
  85. <parameter>
  86. <parameterName value="@message"/>
  87. <dbType value="String"/>
  88. <size value="4000"/>
  89. <layout type="log4net.Layout.PatternLayout" value="%message"/>
  90. </parameter>
  91. </appender>
  92. </code>
  93. </example>
  94. <author>Julian Biddle</author>
  95. <author>Nicko Cadell</author>
  96. <author>Gert Driesen</author>
  97. <author>Lance Nehring</author>
  98. </member>
  99. <member name="T:log4net.Appender.BufferingAppenderSkeleton">
  100. <summary>
  101. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that
  102. buffers events in a fixed size buffer.
  103. </summary>
  104. <remarks>
  105. <para>
  106. This base class should be used by appenders that need to buffer a
  107. number of events before logging them. For example the <see cref="T:log4net.Appender.AdoNetAppender"/>
  108. buffers events and then submits the entire contents of the buffer to
  109. the underlying database in one go.
  110. </para>
  111. <para>
  112. Subclasses should override the <see cref="M:SendBuffer(LoggingEvent[])"/>
  113. method to deliver the buffered events.
  114. </para>
  115. <para>The BufferingAppenderSkeleton maintains a fixed size cyclic
  116. buffer of events. The size of the buffer is set using
  117. the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property.
  118. </para>
  119. <para>A <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> is used to inspect
  120. each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  121. triggers, then the current buffer is sent immediately
  122. (see <see cref="M:SendBuffer(LoggingEvent[])"/>). Otherwise the event
  123. is stored in the buffer. For example, an evaluator can be used to
  124. deliver the events immediately when an ERROR event arrives.
  125. </para>
  126. <para>
  127. The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode.
  128. By default the appender is NOT lossy. When the buffer is full all
  129. the buffered events are sent with <see cref="M:SendBuffer(LoggingEvent[])"/>.
  130. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the
  131. buffer will not be sent when it is full, and new events arriving
  132. in the appender will overwrite the oldest event in the buffer.
  133. In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  134. triggers. This can be useful behavior when you need to know about
  135. ERROR events but not about events with a lower level, configure an
  136. evaluator that will trigger when an ERROR event arrives, the whole
  137. buffer will be sent which gives a history of events leading up to
  138. the ERROR event.
  139. </para>
  140. </remarks>
  141. <author>Nicko Cadell</author>
  142. <author>Gert Driesen</author>
  143. </member>
  144. <member name="T:log4net.Appender.AppenderSkeleton">
  145. <summary>
  146. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>.
  147. </summary>
  148. <remarks>
  149. <para>
  150. This class provides the code for common functionality, such
  151. as support for threshold filtering and support for general filters.
  152. </para>
  153. <para>
  154. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  155. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  156. be called after the appenders properties have been configured.
  157. </para>
  158. </remarks>
  159. <author>Nicko Cadell</author>
  160. <author>Gert Driesen</author>
  161. </member>
  162. <member name="T:log4net.Appender.IAppender">
  163. <summary>
  164. Implement this interface for your own strategies for printing log statements.
  165. </summary>
  166. <remarks>
  167. <para>
  168. Implementors should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/>
  169. class which provides a default implementation of this interface.
  170. </para>
  171. <para>
  172. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  173. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  174. be called after the appenders properties have been configured.
  175. </para>
  176. </remarks>
  177. <author>Nicko Cadell</author>
  178. <author>Gert Driesen</author>
  179. </member>
  180. <member name="M:log4net.Appender.IAppender.Close">
  181. <summary>
  182. Closes the appender and releases resources.
  183. </summary>
  184. <remarks>
  185. <para>
  186. Releases any resources allocated within the appender such as file handles,
  187. network connections, etc.
  188. </para>
  189. <para>
  190. It is a programming error to append to a closed appender.
  191. </para>
  192. </remarks>
  193. </member>
  194. <member name="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)">
  195. <summary>
  196. Log the logging event in Appender specific way.
  197. </summary>
  198. <param name="loggingEvent">The event to log</param>
  199. <remarks>
  200. <para>
  201. This method is called to log a message into this appender.
  202. </para>
  203. </remarks>
  204. </member>
  205. <member name="P:log4net.Appender.IAppender.Name">
  206. <summary>
  207. Gets or sets the name of this appender.
  208. </summary>
  209. <value>The name of the appender.</value>
  210. <remarks>
  211. <para>The name uniquely identifies the appender.</para>
  212. </remarks>
  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>
  238. <member name="T:log4net.Core.IOptionHandler">
  239. <summary>
  240. Interface used to delay activate a configured object.
  241. </summary>
  242. <remarks>
  243. <para>
  244. This allows an object to defer activation of its options until all
  245. options have been set. This is required for components which have
  246. related options that remain ambiguous until all are set.
  247. </para>
  248. <para>
  249. If a component implements this interface then the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method
  250. must be called by the container after its all the configured properties have been set
  251. and before the component can be used.
  252. </para>
  253. </remarks>
  254. <author>Nicko Cadell</author>
  255. </member>
  256. <member name="M:log4net.Core.IOptionHandler.ActivateOptions">
  257. <summary>
  258. Activate the options that were previously set with calls to properties.
  259. </summary>
  260. <remarks>
  261. <para>
  262. This allows an object to defer activation of its options until all
  263. options have been set. This is required for components which have
  264. related options that remain ambiguous until all are set.
  265. </para>
  266. <para>
  267. If a component implements this interface then this method must be called
  268. after its properties have been set before the component can be used.
  269. </para>
  270. </remarks>
  271. </member>
  272. <member name="T:log4net.Appender.IFlushable">
  273. <summary>
  274. Interface that can be implemented by Appenders that buffer logging data and expose a <see cref="M:log4net.Appender.IFlushable.Flush(System.Int32)"/> method.
  275. </summary>
  276. </member>
  277. <member name="M:log4net.Appender.IFlushable.Flush(System.Int32)">
  278. <summary>
  279. Flushes any buffered log data.
  280. </summary>
  281. <remarks>
  282. Appenders that implement the <see cref="M:log4net.Appender.IFlushable.Flush(System.Int32)"/> method must do so in a thread-safe manner: it can be called concurrently with
  283. the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  284. <para>
  285. Typically this is done by locking on the Appender instance, e.g.:
  286. <code>
  287. <![CDATA[
  288. public bool Flush(int millisecondsTimeout)
  289. {
  290. lock(this)
  291. {
  292. // Flush buffered logging data
  293. ...
  294. }
  295. }
  296. ]]>
  297. </code>
  298. </para>
  299. <para>
  300. The <paramref name="millisecondsTimeout"/> parameter is only relevant for appenders that process logging events asynchronously,
  301. such as <see cref="T:log4net.Appender.RemotingAppender"/>.
  302. </para>
  303. </remarks>
  304. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  305. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  306. </member>
  307. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize">
  308. <summary>
  309. Initial buffer size
  310. </summary>
  311. </member>
  312. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity">
  313. <summary>
  314. Maximum buffer size before it is recycled
  315. </summary>
  316. </member>
  317. <member name="M:log4net.Appender.AppenderSkeleton.#ctor">
  318. <summary>
  319. Default constructor
  320. </summary>
  321. <remarks>
  322. <para>Empty default constructor</para>
  323. </remarks>
  324. </member>
  325. <member name="M:log4net.Appender.AppenderSkeleton.Finalize">
  326. <summary>
  327. Finalizes this appender by calling the implementation's
  328. <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method.
  329. </summary>
  330. <remarks>
  331. <para>
  332. If this appender has not been closed then the <c>Finalize</c> method
  333. will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>.
  334. </para>
  335. </remarks>
  336. </member>
  337. <member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions">
  338. <summary>
  339. Initialize the appender based on the options set
  340. </summary>
  341. <remarks>
  342. <para>
  343. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  344. activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must
  345. be called on this object after the configuration properties have
  346. been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this
  347. object is in an undefined state and must not be used.
  348. </para>
  349. <para>
  350. If any of the configuration properties are modified then
  351. <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again.
  352. </para>
  353. </remarks>
  354. </member>
  355. <member name="M:log4net.Appender.AppenderSkeleton.Close">
  356. <summary>
  357. Closes the appender and release resources.
  358. </summary>
  359. <remarks>
  360. <para>
  361. Release any resources allocated within the appender such as file handles,
  362. network connections, etc.
  363. </para>
  364. <para>
  365. It is a programming error to append to a closed appender.
  366. </para>
  367. <para>
  368. This method cannot be overridden by subclasses. This method
  369. delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/>
  370. method which must be overridden in the subclass.
  371. </para>
  372. </remarks>
  373. </member>
  374. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)">
  375. <summary>
  376. Performs threshold checks and invokes filters before
  377. delegating actual logging to the subclasses specific
  378. <see cref="M:Append(LoggingEvent)"/> method.
  379. </summary>
  380. <param name="loggingEvent">The event to log.</param>
  381. <remarks>
  382. <para>
  383. This method cannot be overridden by derived classes. A
  384. derived class should override the <see cref="M:Append(LoggingEvent)"/> method
  385. which is called by this method.
  386. </para>
  387. <para>
  388. The implementation of this method is as follows:
  389. </para>
  390. <para>
  391. <list type="bullet">
  392. <item>
  393. <description>
  394. Checks that the severity of the <paramref name="loggingEvent"/>
  395. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  396. appender.</description>
  397. </item>
  398. <item>
  399. <description>
  400. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  401. <paramref name="loggingEvent"/>.
  402. </description>
  403. </item>
  404. <item>
  405. <description>
  406. Calls <see cref="M:PreAppendCheck()"/> and checks that
  407. it returns <c>true</c>.</description>
  408. </item>
  409. </list>
  410. </para>
  411. <para>
  412. If all of the above steps succeed then the <paramref name="loggingEvent"/>
  413. will be passed to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  414. </para>
  415. </remarks>
  416. </member>
  417. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])">
  418. <summary>
  419. Performs threshold checks and invokes filters before
  420. delegating actual logging to the subclasses specific
  421. <see cref="M:Append(LoggingEvent[])"/> method.
  422. </summary>
  423. <param name="loggingEvents">The array of events to log.</param>
  424. <remarks>
  425. <para>
  426. This method cannot be overridden by derived classes. A
  427. derived class should override the <see cref="M:Append(LoggingEvent[])"/> method
  428. which is called by this method.
  429. </para>
  430. <para>
  431. The implementation of this method is as follows:
  432. </para>
  433. <para>
  434. <list type="bullet">
  435. <item>
  436. <description>
  437. Checks that the severity of the <paramref name="loggingEvents"/>
  438. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  439. appender.</description>
  440. </item>
  441. <item>
  442. <description>
  443. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  444. <paramref name="loggingEvents"/>.
  445. </description>
  446. </item>
  447. <item>
  448. <description>
  449. Calls <see cref="M:PreAppendCheck()"/> and checks that
  450. it returns <c>true</c>.</description>
  451. </item>
  452. </list>
  453. </para>
  454. <para>
  455. If all of the above steps succeed then the <paramref name="loggingEvents"/>
  456. will be passed to the <see cref="M:Append(LoggingEvent[])"/> method.
  457. </para>
  458. </remarks>
  459. </member>
  460. <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)">
  461. <summary>
  462. Test if the logging event should we output by this appender
  463. </summary>
  464. <param name="loggingEvent">the event to test</param>
  465. <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns>
  466. <remarks>
  467. <para>
  468. This method checks the logging event against the threshold level set
  469. on this appender and also against the filters specified on this
  470. appender.
  471. </para>
  472. <para>
  473. The implementation of this method is as follows:
  474. </para>
  475. <para>
  476. <list type="bullet">
  477. <item>
  478. <description>
  479. Checks that the severity of the <paramref name="loggingEvent"/>
  480. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  481. appender.</description>
  482. </item>
  483. <item>
  484. <description>
  485. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  486. <paramref name="loggingEvent"/>.
  487. </description>
  488. </item>
  489. </list>
  490. </para>
  491. </remarks>
  492. </member>
  493. <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
  494. <summary>
  495. Adds a filter to the end of the filter chain.
  496. </summary>
  497. <param name="filter">the filter to add to this appender</param>
  498. <remarks>
  499. <para>
  500. The Filters are organized in a linked list.
  501. </para>
  502. <para>
  503. Setting this property causes the new filter to be pushed onto the
  504. back of the filter chain.
  505. </para>
  506. </remarks>
  507. </member>
  508. <member name="M:log4net.Appender.AppenderSkeleton.ClearFilters">
  509. <summary>
  510. Clears the filter list for this appender.
  511. </summary>
  512. <remarks>
  513. <para>
  514. Clears the filter list for this appender.
  515. </para>
  516. </remarks>
  517. </member>
  518. <member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)">
  519. <summary>
  520. Checks if the message level is below this appender's threshold.
  521. </summary>
  522. <param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param>
  523. <remarks>
  524. <para>
  525. If there is no threshold set, then the return value is always <c>true</c>.
  526. </para>
  527. </remarks>
  528. <returns>
  529. <c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/>
  530. requirements of this appender.
  531. </returns>
  532. </member>
  533. <member name="M:log4net.Appender.AppenderSkeleton.OnClose">
  534. <summary>
  535. Is called when the appender is closed. Derived classes should override
  536. this method if resources need to be released.
  537. </summary>
  538. <remarks>
  539. <para>
  540. Releases any resources allocated within the appender such as file handles,
  541. network connections, etc.
  542. </para>
  543. <para>
  544. It is a programming error to append to a closed appender.
  545. </para>
  546. </remarks>
  547. </member>
  548. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  549. <summary>
  550. Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method
  551. to perform actual logging.
  552. </summary>
  553. <param name="loggingEvent">The event to append.</param>
  554. <remarks>
  555. <para>
  556. A subclass must implement this method to perform
  557. logging of the <paramref name="loggingEvent"/>.
  558. </para>
  559. <para>This method will be called by <see cref="M:DoAppend(LoggingEvent)"/>
  560. if all the conditions listed for that method are met.
  561. </para>
  562. <para>
  563. To restrict the logging of events in the appender
  564. override the <see cref="M:PreAppendCheck()"/> method.
  565. </para>
  566. </remarks>
  567. </member>
  568. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])">
  569. <summary>
  570. Append a bulk array of logging events.
  571. </summary>
  572. <param name="loggingEvents">the array of logging events</param>
  573. <remarks>
  574. <para>
  575. This base class implementation calls the <see cref="M:Append(LoggingEvent)"/>
  576. method for each element in the bulk array.
  577. </para>
  578. <para>
  579. A sub class that can better process a bulk array of events should
  580. override this method in addition to <see cref="M:Append(LoggingEvent)"/>.
  581. </para>
  582. </remarks>
  583. </member>
  584. <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
  585. <summary>
  586. Called before <see cref="M:Append(LoggingEvent)"/> as a precondition.
  587. </summary>
  588. <remarks>
  589. <para>
  590. This method is called by <see cref="M:DoAppend(LoggingEvent)"/>
  591. before the call to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  592. </para>
  593. <para>
  594. This method can be overridden in a subclass to extend the checks
  595. made before the event is passed to the <see cref="M:Append(LoggingEvent)"/> method.
  596. </para>
  597. <para>
  598. A subclass should ensure that they delegate this call to
  599. this base class if it is overridden.
  600. </para>
  601. </remarks>
  602. <returns><c>true</c> if the call to <see cref="M:Append(LoggingEvent)"/> should proceed.</returns>
  603. </member>
  604. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)">
  605. <summary>
  606. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  607. </summary>
  608. <param name="loggingEvent">The event to render.</param>
  609. <returns>The event rendered as a string.</returns>
  610. <remarks>
  611. <para>
  612. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  613. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  614. set to render the <paramref name="loggingEvent"/> to
  615. a string.
  616. </para>
  617. <para>If there is exception data in the logging event and
  618. the layout does not process the exception, this method
  619. will append the exception text to the rendered string.
  620. </para>
  621. <para>
  622. Where possible use the alternative version of this method
  623. <see cref="M:RenderLoggingEvent(TextWriter,LoggingEvent)"/>.
  624. That method streams the rendering onto an existing Writer
  625. which can give better performance if the caller already has
  626. a <see cref="T:System.IO.TextWriter"/> open and ready for writing.
  627. </para>
  628. </remarks>
  629. </member>
  630. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  631. <summary>
  632. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  633. </summary>
  634. <param name="loggingEvent">The event to render.</param>
  635. <param name="writer">The TextWriter to write the formatted event to</param>
  636. <remarks>
  637. <para>
  638. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  639. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  640. set to render the <paramref name="loggingEvent"/> to
  641. a string.
  642. </para>
  643. <para>If there is exception data in the logging event and
  644. the layout does not process the exception, this method
  645. will append the exception text to the rendered string.
  646. </para>
  647. <para>
  648. Use this method in preference to <see cref="M:RenderLoggingEvent(LoggingEvent)"/>
  649. where possible. If, however, the caller needs to render the event
  650. to a string then <see cref="M:RenderLoggingEvent(LoggingEvent)"/> does
  651. provide an efficient mechanism for doing so.
  652. </para>
  653. </remarks>
  654. </member>
  655. <member name="M:log4net.Appender.AppenderSkeleton.Flush(System.Int32)">
  656. <summary>
  657. Flushes any buffered log data.
  658. </summary>
  659. <remarks>
  660. This implementation doesn't flush anything and always returns true
  661. </remarks>
  662. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  663. </member>
  664. <member name="F:log4net.Appender.AppenderSkeleton.m_layout">
  665. <summary>
  666. The layout of this appender.
  667. </summary>
  668. <remarks>
  669. See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information.
  670. </remarks>
  671. </member>
  672. <member name="F:log4net.Appender.AppenderSkeleton.m_name">
  673. <summary>
  674. The name of this appender.
  675. </summary>
  676. <remarks>
  677. See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information.
  678. </remarks>
  679. </member>
  680. <member name="F:log4net.Appender.AppenderSkeleton.m_threshold">
  681. <summary>
  682. The level threshold of this appender.
  683. </summary>
  684. <remarks>
  685. <para>
  686. There is no level threshold filtering by default.
  687. </para>
  688. <para>
  689. See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information.
  690. </para>
  691. </remarks>
  692. </member>
  693. <member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler">
  694. <summary>
  695. It is assumed and enforced that errorHandler is never null.
  696. </summary>
  697. <remarks>
  698. <para>
  699. It is assumed and enforced that errorHandler is never null.
  700. </para>
  701. <para>
  702. See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information.
  703. </para>
  704. </remarks>
  705. </member>
  706. <member name="F:log4net.Appender.AppenderSkeleton.m_headFilter">
  707. <summary>
  708. The first filter in the filter chain.
  709. </summary>
  710. <remarks>
  711. <para>
  712. Set to <c>null</c> initially.
  713. </para>
  714. <para>
  715. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  716. </para>
  717. </remarks>
  718. </member>
  719. <member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter">
  720. <summary>
  721. The last filter in the filter chain.
  722. </summary>
  723. <remarks>
  724. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  725. </remarks>
  726. </member>
  727. <member name="F:log4net.Appender.AppenderSkeleton.m_closed">
  728. <summary>
  729. Flag indicating if this appender is closed.
  730. </summary>
  731. <remarks>
  732. See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information.
  733. </remarks>
  734. </member>
  735. <member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard">
  736. <summary>
  737. The guard prevents an appender from repeatedly calling its own DoAppend method
  738. </summary>
  739. </member>
  740. <member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter">
  741. <summary>
  742. StringWriter used to render events
  743. </summary>
  744. </member>
  745. <member name="F:log4net.Appender.AppenderSkeleton.declaringType">
  746. <summary>
  747. The fully qualified type of the AppenderSkeleton class.
  748. </summary>
  749. <remarks>
  750. Used by the internal logger to record the Type of the
  751. log message.
  752. </remarks>
  753. </member>
  754. <member name="P:log4net.Appender.AppenderSkeleton.Threshold">
  755. <summary>
  756. Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender.
  757. </summary>
  758. <value>
  759. The threshold <see cref="T:log4net.Core.Level"/> of the appender.
  760. </value>
  761. <remarks>
  762. <para>
  763. All log events with lower level than the threshold level are ignored
  764. by the appender.
  765. </para>
  766. <para>
  767. In configuration files this option is specified by setting the
  768. value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level
  769. string, such as "DEBUG", "INFO" and so on.
  770. </para>
  771. </remarks>
  772. </member>
  773. <member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler">
  774. <summary>
  775. Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  776. </summary>
  777. <value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value>
  778. <remarks>
  779. <para>
  780. The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default
  781. implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property.
  782. </para>
  783. </remarks>
  784. </member>
  785. <member name="P:log4net.Appender.AppenderSkeleton.FilterHead">
  786. <summary>
  787. The filter chain.
  788. </summary>
  789. <value>The head of the filter chain filter chain.</value>
  790. <remarks>
  791. <para>
  792. Returns the head Filter. The Filters are organized in a linked list
  793. and so all Filters on this Appender are available through the result.
  794. </para>
  795. </remarks>
  796. </member>
  797. <member name="P:log4net.Appender.AppenderSkeleton.Layout">
  798. <summary>
  799. Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender.
  800. </summary>
  801. <value>The layout of the appender.</value>
  802. <remarks>
  803. <para>
  804. See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information.
  805. </para>
  806. </remarks>
  807. <seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/>
  808. </member>
  809. <member name="P:log4net.Appender.AppenderSkeleton.Name">
  810. <summary>
  811. Gets or sets the name of this appender.
  812. </summary>
  813. <value>The name of the appender.</value>
  814. <remarks>
  815. <para>
  816. The name uniquely identifies the appender.
  817. </para>
  818. </remarks>
  819. </member>
  820. <member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout">
  821. <summary>
  822. Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  823. </summary>
  824. <remarks>
  825. <para>
  826. In the rather exceptional case, where the appender
  827. implementation admits a layout but can also work without it,
  828. then the appender should return <c>true</c>.
  829. </para>
  830. <para>
  831. This default implementation always returns <c>false</c>.
  832. </para>
  833. </remarks>
  834. <returns>
  835. <c>true</c> if the appender requires a layout object, otherwise <c>false</c>.
  836. </returns>
  837. </member>
  838. <member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE">
  839. <summary>
  840. The default buffer size.
  841. </summary>
  842. <remarks>
  843. The default size of the cyclic buffer used to store events.
  844. This is set to 512 by default.
  845. </remarks>
  846. </member>
  847. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor">
  848. <summary>
  849. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
  850. </summary>
  851. <remarks>
  852. <para>
  853. Protected default constructor to allow subclassing.
  854. </para>
  855. </remarks>
  856. </member>
  857. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)">
  858. <summary>
  859. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
  860. </summary>
  861. <param name="eventMustBeFixed">the events passed through this appender must be
  862. fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param>
  863. <remarks>
  864. <para>
  865. Protected constructor to allow subclassing.
  866. </para>
  867. <para>
  868. The <paramref name="eventMustBeFixed"/> should be set if the subclass
  869. expects the events delivered to be fixed even if the
  870. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs.
  871. </para>
  872. </remarks>
  873. </member>
  874. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Int32)">
  875. <summary>
  876. Flushes any buffered log data.
  877. </summary>
  878. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  879. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  880. </member>
  881. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush">
  882. <summary>
  883. Flush the currently buffered events
  884. </summary>
  885. <remarks>
  886. <para>
  887. Flushes any events that have been buffered.
  888. </para>
  889. <para>
  890. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  891. of the buffer will NOT be flushed to the appender.
  892. </para>
  893. </remarks>
  894. </member>
  895. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)">
  896. <summary>
  897. Flush the currently buffered events
  898. </summary>
  899. <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param>
  900. <remarks>
  901. <para>
  902. Flushes events that have been buffered. If <paramref name="flushLossyBuffer"/> is
  903. <c>false</c> then events will only be flushed if this buffer is non-lossy mode.
  904. </para>
  905. <para>
  906. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  907. of the buffer will only be flushed if <paramref name="flushLossyBuffer"/> is <c>true</c>.
  908. In this case the contents of the buffer will be tested against the
  909. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered
  910. events will be discarded.
  911. </para>
  912. <para>
  913. If <paramref name="flushLossyBuffer"/> is <c>true</c> then the buffer will always
  914. be emptied by calling this method.
  915. </para>
  916. </remarks>
  917. </member>
  918. <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
  919. <summary>
  920. Initialize the appender based on the options set
  921. </summary>
  922. <remarks>
  923. <para>
  924. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  925. activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must
  926. be called on this object after the configuration properties have
  927. been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this
  928. object is in an undefined state and must not be used.
  929. </para>
  930. <para>
  931. If any of the configuration properties are modified then
  932. <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again.
  933. </para>
  934. </remarks>
  935. </member>
  936. <member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose">
  937. <summary>
  938. Close this appender instance.
  939. </summary>
  940. <remarks>
  941. <para>
  942. Close this appender instance. If this appender is marked
  943. as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
  944. the buffer must be sent when the appender is closed.
  945. </para>
  946. </remarks>
  947. </member>
  948. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  949. <summary>
  950. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  951. </summary>
  952. <param name="loggingEvent">the event to log</param>
  953. <remarks>
  954. <para>
  955. Stores the <paramref name="loggingEvent"/> in the cyclic buffer.
  956. </para>
  957. <para>
  958. The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>
  959. method) if one of the following conditions is met:
  960. </para>
  961. <list type="bullet">
  962. <item>
  963. <description>The cyclic buffer is full and this appender is
  964. marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description>
  965. </item>
  966. <item>
  967. <description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and
  968. it is triggered for the <paramref name="loggingEvent"/>
  969. specified.</description>
  970. </item>
  971. </list>
  972. <para>
  973. Before the event is stored in the buffer it is fixed
  974. (see <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/>) to ensure that
  975. any data referenced by the event will be valid when the buffer
  976. is processed.
  977. </para>
  978. </remarks>
  979. </member>
  980. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)">
  981. <summary>
  982. Sends the contents of the buffer.
  983. </summary>
  984. <param name="firstLoggingEvent">The first logging event.</param>
  985. <param name="buffer">The buffer containing the events that need to be send.</param>
  986. <remarks>
  987. <para>
  988. The subclass must override <see cref="M:SendBuffer(LoggingEvent[])"/>.
  989. </para>
  990. </remarks>
  991. </member>
  992. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])">
  993. <summary>
  994. Sends the events.
  995. </summary>
  996. <param name="events">The events that need to be send.</param>
  997. <remarks>
  998. <para>
  999. The subclass must override this method to process the buffered events.
  1000. </para>
  1001. </remarks>
  1002. </member>
  1003. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
  1004. <summary>
  1005. The size of the cyclic buffer used to hold the logging events.
  1006. </summary>
  1007. <remarks>
  1008. Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default.
  1009. </remarks>
  1010. </member>
  1011. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb">
  1012. <summary>
  1013. The cyclic buffer used to store the logging events.
  1014. </summary>
  1015. </member>
  1016. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator">
  1017. <summary>
  1018. The triggering event evaluator that causes the buffer to be sent immediately.
  1019. </summary>
  1020. <remarks>
  1021. The object that is used to determine if an event causes the entire
  1022. buffer to be sent immediately. This field can be <c>null</c>, which
  1023. indicates that event triggering is not to be done. The evaluator
  1024. can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender
  1025. has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to
  1026. <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set.
  1027. </remarks>
  1028. </member>
  1029. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy">
  1030. <summary>
  1031. Indicates if the appender should overwrite events in the cyclic buffer
  1032. when it becomes full, or if the buffer should be flushed when the
  1033. buffer is full.
  1034. </summary>
  1035. <remarks>
  1036. If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must
  1037. be set.
  1038. </remarks>
  1039. </member>
  1040. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator">
  1041. <summary>
  1042. The triggering event evaluator filters discarded events.
  1043. </summary>
  1044. <remarks>
  1045. The object that is used to determine if an event that is discarded should
  1046. really be discarded or if it should be sent to the appenders.
  1047. This field can be <c>null</c>, which indicates that all discarded events will
  1048. be discarded.
  1049. </remarks>
  1050. </member>
  1051. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags">
  1052. <summary>
  1053. Value indicating which fields in the event should be fixed
  1054. </summary>
  1055. <remarks>
  1056. By default all fields are fixed
  1057. </remarks>
  1058. </member>
  1059. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed">
  1060. <summary>
  1061. The events delivered to the subclass must be fixed.
  1062. </summary>
  1063. </member>
  1064. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy">
  1065. <summary>
  1066. Gets or sets a value that indicates whether the appender is lossy.
  1067. </summary>
  1068. <value>
  1069. <c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>.
  1070. </value>
  1071. <remarks>
  1072. <para>
  1073. This appender uses a buffer to store logging events before
  1074. delivering them. A triggering event causes the whole buffer
  1075. to be send to the remote sink. If the buffer overruns before
  1076. a triggering event then logging events could be lost. Set
  1077. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events
  1078. from being lost.
  1079. </para>
  1080. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  1081. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  1082. </remarks>
  1083. </member>
  1084. <member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize">
  1085. <summary>
  1086. Gets or sets the size of the cyclic buffer used to hold the
  1087. logging events.
  1088. </summary>
  1089. <value>
  1090. The size of the cyclic buffer used to hold the logging events.
  1091. </value>
  1092. <remarks>
  1093. <para>
  1094. The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer
  1095. representing the maximum number of logging events to collect in
  1096. a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached,
  1097. oldest events are deleted as new events are added to the
  1098. buffer. By default the size of the cyclic buffer is 512 events.
  1099. </para>
  1100. <para>
  1101. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than
  1102. or equal to 1 then no buffering will occur. The logging event
  1103. will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>
  1104. and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will
  1105. be buffered.
  1106. </para>
  1107. </remarks>
  1108. </member>
  1109. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator">
  1110. <summary>
  1111. Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the
  1112. buffer to be sent immediately.
  1113. </summary>
  1114. <value>
  1115. The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be
  1116. sent immediately.
  1117. </value>
  1118. <remarks>
  1119. <para>
  1120. The evaluator will be called for each event that is appended to this
  1121. appender. If the evaluator triggers then the current buffer will
  1122. immediately be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  1123. </para>
  1124. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  1125. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  1126. </remarks>
  1127. </member>
  1128. <member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator">
  1129. <summary>
  1130. Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  1131. </summary>
  1132. <value>
  1133. The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  1134. </value>
  1135. <remarks>
  1136. <para>
  1137. The evaluator will be called for each event that is discarded from this
  1138. appender. If the evaluator triggers then the current buffer will immediately
  1139. be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  1140. </para>
  1141. </remarks>
  1142. </member>
  1143. <member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData">
  1144. <summary>
  1145. Gets or sets a value indicating if only part of the logging event data
  1146. should be fixed.
  1147. </summary>
  1148. <value>
  1149. <c>true</c> if the appender should only fix part of the logging event
  1150. data, otherwise <c>false</c>. The default is <c>false</c>.
  1151. </value>
  1152. <remarks>
  1153. <para>
  1154. Setting this property to <c>true</c> will cause only part of the
  1155. event data to be fixed and serialized. This will improve performance.
  1156. </para>
  1157. <para>
  1158. See <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/> for more information.
  1159. </para>
  1160. </remarks>
  1161. </member>
  1162. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix">
  1163. <summary>
  1164. Gets or sets a the fields that will be fixed in the event
  1165. </summary>
  1166. <value>
  1167. The event fields that will be fixed before the event is buffered
  1168. </value>
  1169. <remarks>
  1170. <para>
  1171. The logging event needs to have certain thread specific values
  1172. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  1173. for details.
  1174. </para>
  1175. </remarks>
  1176. <seealso cref="P:log4net.Core.LoggingEvent.Fix"/>
  1177. </member>
  1178. <member name="M:log4net.Appender.AdoNetAppender.#ctor">
  1179. <summary>
  1180. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppender"/> class.
  1181. </summary>
  1182. <remarks>
  1183. Public default constructor to initialize a new instance of this class.
  1184. </remarks>
  1185. </member>
  1186. <member name="M:log4net.Appender.AdoNetAppender.ActivateOptions">
  1187. <summary>
  1188. Initialize the appender based on the options set
  1189. </summary>
  1190. <remarks>
  1191. <para>
  1192. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  1193. activation scheme. The <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> method must
  1194. be called on this object after the configuration properties have
  1195. been set. Until <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> is called this
  1196. object is in an undefined state and must not be used.
  1197. </para>
  1198. <para>
  1199. If any of the configuration properties are modified then
  1200. <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> must be called again.
  1201. </para>
  1202. </remarks>
  1203. </member>
  1204. <member name="M:log4net.Appender.AdoNetAppender.OnClose">
  1205. <summary>
  1206. Override the parent method to close the database
  1207. </summary>
  1208. <remarks>
  1209. <para>
  1210. Closes the database command and database connection.
  1211. </para>
  1212. </remarks>
  1213. </member>
  1214. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  1215. <summary>
  1216. Inserts the events into the database.
  1217. </summary>
  1218. <param name="events">The events to insert into the database.</param>
  1219. <remarks>
  1220. <para>
  1221. Insert all the events specified in the <paramref name="events"/>
  1222. array into the database.
  1223. </para>
  1224. </remarks>
  1225. </member>
  1226. <member name="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)">
  1227. <summary>
  1228. Adds a parameter to the command.
  1229. </summary>
  1230. <param name="parameter">The parameter to add to the command.</param>
  1231. <remarks>
  1232. <para>
  1233. Adds a parameter to the ordered list of command parameters.
  1234. </para>
  1235. </remarks>
  1236. </member>
  1237. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(System.Data.IDbTransaction,log4net.Core.LoggingEvent[])">
  1238. <summary>
  1239. Writes the events to the database using the transaction specified.
  1240. </summary>
  1241. <param name="dbTran">The transaction that the events will be executed under.</param>
  1242. <param name="events">The array of events to insert into the database.</param>
  1243. <remarks>
  1244. <para>
  1245. The transaction argument can be <c>null</c> if the appender has been
  1246. configured not to use transactions. See <see cref="P:log4net.Appender.AdoNetAppender.UseTransactions"/>
  1247. property for more information.
  1248. </para>
  1249. </remarks>
  1250. </member>
  1251. <member name="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)">
  1252. <summary>
  1253. Formats the log message into database statement text.
  1254. </summary>
  1255. <param name="logEvent">The event being logged.</param>
  1256. <remarks>
  1257. This method can be overridden by subclasses to provide
  1258. more control over the format of the database statement.
  1259. </remarks>
  1260. <returns>
  1261. Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>.
  1262. </returns>
  1263. </member>
  1264. <member name="M:log4net.Appender.AdoNetAppender.CreateConnection(System.Type,System.String)">
  1265. <summary>
  1266. Creates an <see cref="T:System.Data.IDbConnection"/> instance used to connect to the database.
  1267. </summary>
  1268. <remarks>
  1269. This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary).
  1270. </remarks>
  1271. <param name="connectionType">The <see cref="T:System.Type"/> of the <see cref="T:System.Data.IDbConnection"/> object.</param>
  1272. <param name="connectionString">The connectionString output from the ResolveConnectionString method.</param>
  1273. <returns>An <see cref="T:System.Data.IDbConnection"/> instance with a valid connection string.</returns>
  1274. </member>
  1275. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionString(System.String@)">
  1276. <summary>
  1277. Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey
  1278. property.
  1279. </summary>
  1280. <remarks>
  1281. ConnectiongStringName is only supported on .NET 2.0 and higher.
  1282. </remarks>
  1283. <param name="connectionStringContext">Additional information describing the connection string.</param>
  1284. <returns>A connection string used to connect to the database.</returns>
  1285. </member>
  1286. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType">
  1287. <summary>
  1288. Retrieves the class type of the ADO.NET provider.
  1289. </summary>
  1290. <remarks>
  1291. <para>
  1292. Gets the Type of the ADO.NET provider to use to connect to the
  1293. database. This method resolves the type specified in the
  1294. <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property.
  1295. </para>
  1296. <para>
  1297. Subclasses can override this method to return a different type
  1298. if necessary.
  1299. </para>
  1300. </remarks>
  1301. <returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns>
  1302. </member>
  1303. <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection">
  1304. <summary>
  1305. Connects to the database.
  1306. </summary>
  1307. </member>
  1308. <member name="M:log4net.Appender.AdoNetAppender.DiposeConnection">
  1309. <summary>
  1310. Cleanup the existing connection.
  1311. </summary>
  1312. <remarks>
  1313. Calls the IDbConnection's <see cref="M:System.Data.IDbConnection.Close"/> method.
  1314. </remarks>
  1315. </member>
  1316. <member name="F:log4net.Appender.AdoNetAppender.m_parameters">
  1317. <summary>
  1318. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  1319. </summary>
  1320. <remarks>
  1321. <para>
  1322. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  1323. </para>
  1324. </remarks>
  1325. </member>
  1326. <member name="F:log4net.Appender.AdoNetAppender.m_securityContext">
  1327. <summary>
  1328. The security context to use for privileged calls
  1329. </summary>
  1330. </member>
  1331. <member name="F:log4net.Appender.AdoNetAppender.m_dbConnection">
  1332. <summary>
  1333. The <see cref="T:System.Data.IDbConnection"/> that will be used
  1334. to insert logging events into a database.
  1335. </summary>
  1336. </member>
  1337. <member name="F:log4net.Appender.AdoNetAppender.m_connectionString">
  1338. <summary>
  1339. Database connection string.
  1340. </summary>
  1341. </member>
  1342. <member name="F:log4net.Appender.AdoNetAppender.m_appSettingsKey">
  1343. <summary>
  1344. The appSettings key from App.Config that contains the connection string.
  1345. </summary>
  1346. </member>
  1347. <member name="F:log4net.Appender.AdoNetAppender.m_connectionStringName">
  1348. <summary>
  1349. The connectionStrings key from App.Config that contains the connection string.
  1350. </summary>
  1351. </member>
  1352. <member name="F:log4net.Appender.AdoNetAppender.m_connectionType">
  1353. <summary>
  1354. String type name of the <see cref="T:System.Data.IDbConnection"/> type name.
  1355. </summary>
  1356. </member>
  1357. <member name="F:log4net.Appender.AdoNetAppender.m_commandText">
  1358. <summary>
  1359. The text of the command.
  1360. </summary>
  1361. </member>
  1362. <member name="F:log4net.Appender.AdoNetAppender.m_commandType">
  1363. <summary>
  1364. The command type.
  1365. </summary>
  1366. </member>
  1367. <member name="F:log4net.Appender.AdoNetAppender.m_useTransactions">
  1368. <summary>
  1369. Indicates whether to use transactions when writing to the database.
  1370. </summary>
  1371. </member>
  1372. <member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError">
  1373. <summary>
  1374. Indicates whether to reconnect when a connection is lost.
  1375. </summary>
  1376. </member>
  1377. <member name="F:log4net.Appender.AdoNetAppender.declaringType">
  1378. <summary>
  1379. The fully qualified type of the AdoNetAppender class.
  1380. </summary>
  1381. <remarks>
  1382. Used by the internal logger to record the Type of the
  1383. log message.
  1384. </remarks>
  1385. </member>
  1386. <member name="P:log4net.Appender.AdoNetAppender.ConnectionString">
  1387. <summary>
  1388. Gets or sets the database connection string that is used to connect to
  1389. the database.
  1390. </summary>
  1391. <value>
  1392. The database connection string used to connect to the database.
  1393. </value>
  1394. <remarks>
  1395. <para>
  1396. The connections string is specific to the connection type.
  1397. See <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> for more information.
  1398. </para>
  1399. </remarks>
  1400. <example>Connection string for MS Access via ODBC:
  1401. <code>"DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb"</code>
  1402. </example>
  1403. <example>Another connection string for MS Access via ODBC:
  1404. <code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"</code>
  1405. </example>
  1406. <example>Connection string for MS Access via OLE DB:
  1407. <code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"</code>
  1408. </example>
  1409. </member>
  1410. <member name="P:log4net.Appender.AdoNetAppender.AppSettingsKey">
  1411. <summary>
  1412. The appSettings key from App.Config that contains the connection string.
  1413. </summary>
  1414. </member>
  1415. <member name="P:log4net.Appender.AdoNetAppender.ConnectionStringName">
  1416. <summary>
  1417. The connectionStrings key from App.Config that contains the connection string.
  1418. </summary>
  1419. <remarks>
  1420. This property requires at least .NET 2.0.
  1421. </remarks>
  1422. </member>
  1423. <member name="P:log4net.Appender.AdoNetAppender.ConnectionType">
  1424. <summary>
  1425. Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection
  1426. that should be created.
  1427. </summary>
  1428. <value>
  1429. The type name of the <see cref="T:System.Data.IDbConnection"/> connection.
  1430. </value>
  1431. <remarks>
  1432. <para>
  1433. The type name of the ADO.NET provider to use.
  1434. </para>
  1435. <para>
  1436. The default is to use the OLE DB provider.
  1437. </para>
  1438. </remarks>
  1439. <example>Use the OLE DB Provider. This is the default value.
  1440. <code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1441. </example>
  1442. <example>Use the MS SQL Server Provider.
  1443. <code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1444. </example>
  1445. <example>Use the ODBC Provider.
  1446. <code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code>
  1447. This is an optional package that you can download from
  1448. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  1449. search for <b>ODBC .NET Data Provider</b>.
  1450. </example>
  1451. <example>Use the Oracle Provider.
  1452. <code>System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1453. This is an optional package that you can download from
  1454. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  1455. search for <b>.NET Managed Provider for Oracle</b>.
  1456. </example>
  1457. </member>
  1458. <member name="P:log4net.Appender.AdoNetAppender.CommandText">
  1459. <summary>
  1460. Gets or sets the command text that is used to insert logging events
  1461. into the database.
  1462. </summary>
  1463. <value>
  1464. The command text used to insert logging events into the database.
  1465. </value>
  1466. <remarks>
  1467. <para>
  1468. Either the text of the prepared statement or the
  1469. name of the stored procedure to execute to write into
  1470. the database.
  1471. </para>
  1472. <para>
  1473. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property determines if
  1474. this text is a prepared statement or a stored procedure.
  1475. </para>
  1476. <para>
  1477. If this property is not set, the command text is retrieved by invoking
  1478. <see cref="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)"/>.
  1479. </para>
  1480. </remarks>
  1481. </member>
  1482. <member name="P:log4net.Appender.AdoNetAppender.CommandType">
  1483. <summary>
  1484. Gets or sets the command type to execute.
  1485. </summary>
  1486. <value>
  1487. The command type to execute.
  1488. </value>
  1489. <remarks>
  1490. <para>
  1491. This value may be either <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify
  1492. that the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> is a prepared statement to execute,
  1493. or <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify that the
  1494. <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property is the name of a stored procedure
  1495. to execute.
  1496. </para>
  1497. <para>
  1498. The default value is <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>).
  1499. </para>
  1500. </remarks>
  1501. </member>
  1502. <member name="P:log4net.Appender.AdoNetAppender.UseTransactions">
  1503. <summary>
  1504. Should transactions be used to insert logging events in the database.
  1505. </summary>
  1506. <value>
  1507. <c>true</c> if transactions should be used to insert logging events in
  1508. the database, otherwise <c>false</c>. The default value is <c>true</c>.
  1509. </value>
  1510. <remarks>
  1511. <para>
  1512. Gets or sets a value that indicates whether transactions should be used
  1513. to insert logging events in the database.
  1514. </para>
  1515. <para>
  1516. When set a single transaction will be used to insert the buffered events
  1517. into the database. Otherwise each event will be inserted without using
  1518. an explicit transaction.
  1519. </para>
  1520. </remarks>
  1521. </member>
  1522. <member name="P:log4net.Appender.AdoNetAppender.SecurityContext">
  1523. <summary>
  1524. Gets or sets the <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  1525. </summary>
  1526. <value>
  1527. The <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  1528. </value>
  1529. <remarks>
  1530. <para>
  1531. Unless a <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> specified here for this appender
  1532. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  1533. security context to use. The default behavior is to use the security context
  1534. of the current thread.
  1535. </para>
  1536. </remarks>
  1537. </member>
  1538. <member name="P:log4net.Appender.AdoNetAppender.ReconnectOnError">
  1539. <summary>
  1540. Should this appender try to reconnect to the database on error.
  1541. </summary>
  1542. <value>
  1543. <c>true</c> if the appender should try to reconnect to the database after an
  1544. error has occurred, otherwise <c>false</c>. The default value is <c>false</c>,
  1545. i.e. not to try to reconnect.
  1546. </value>
  1547. <remarks>
  1548. <para>
  1549. The default behaviour is for the appender not to try to reconnect to the
  1550. database if an error occurs. Subsequent logging events are discarded.
  1551. </para>
  1552. <para>
  1553. To force the appender to attempt to reconnect to the database set this
  1554. property to <c>true</c>.
  1555. </para>
  1556. <note>
  1557. When the appender attempts to connect to the database there may be a
  1558. delay of up to the connection timeout specified in the connection string.
  1559. This delay will block the calling application's thread.
  1560. Until the connection can be reestablished this potential delay may occur multiple times.
  1561. </note>
  1562. </remarks>
  1563. </member>
  1564. <member name="P:log4net.Appender.AdoNetAppender.Connection">
  1565. <summary>
  1566. Gets or sets the underlying <see cref="T:System.Data.IDbConnection"/>.
  1567. </summary>
  1568. <value>
  1569. The underlying <see cref="T:System.Data.IDbConnection"/>.
  1570. </value>
  1571. <remarks>
  1572. <see cref="T:log4net.Appender.AdoNetAppender"/> creates a <see cref="T:System.Data.IDbConnection"/> to insert
  1573. logging events into a database. Classes deriving from <see cref="T:log4net.Appender.AdoNetAppender"/>
  1574. can use this property to get or set this <see cref="T:System.Data.IDbConnection"/>. Use the
  1575. underlying <see cref="T:System.Data.IDbConnection"/> returned from <see cref="P:log4net.Appender.AdoNetAppender.Connection"/> if
  1576. you require access beyond that which <see cref="T:log4net.Appender.AdoNetAppender"/> provides.
  1577. </remarks>
  1578. </member>
  1579. <member name="T:log4net.Appender.AdoNetAppenderParameter">
  1580. <summary>
  1581. Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>.
  1582. </summary>
  1583. <remarks>
  1584. <para>
  1585. This class provides the basic database parameter properties
  1586. as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface.
  1587. </para>
  1588. <para>This type can be subclassed to provide database specific
  1589. functionality. The two methods that are called externally are
  1590. <see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>.
  1591. </para>
  1592. </remarks>
  1593. </member>
  1594. <member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor">
  1595. <summary>
  1596. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> class.
  1597. </summary>
  1598. <remarks>
  1599. Default constructor for the AdoNetAppenderParameter class.
  1600. </remarks>
  1601. </member>
  1602. <member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)">
  1603. <summary>
  1604. Prepare the specified database command object.
  1605. </summary>
  1606. <param name="command">The command to prepare.</param>
  1607. <remarks>
  1608. <para>
  1609. Prepares the database command object by adding
  1610. this parameter to its collection of parameters.
  1611. </para>
  1612. </remarks>
  1613. </member>
  1614. <member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)">
  1615. <summary>
  1616. Renders the logging event and set the parameter value in the command.
  1617. </summary>
  1618. <param name="command">The command containing the parameter.</param>
  1619. <param name="loggingEvent">The event to be rendered.</param>
  1620. <remarks>
  1621. <para>
  1622. Renders the logging event using this parameters layout
  1623. object. Sets the value of the parameter on the command object.
  1624. </para>
  1625. </remarks>
  1626. </member>
  1627. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName">
  1628. <summary>
  1629. The name of this parameter.
  1630. </summary>
  1631. </member>
  1632. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType">
  1633. <summary>
  1634. The database type for this parameter.
  1635. </summary>
  1636. </member>
  1637. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType">
  1638. <summary>
  1639. Flag to infer type rather than use the DbType
  1640. </summary>
  1641. </member>
  1642. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision">
  1643. <summary>
  1644. The precision for this parameter.
  1645. </summary>
  1646. </member>
  1647. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale">
  1648. <summary>
  1649. The scale for this parameter.
  1650. </summary>
  1651. </member>
  1652. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_size">
  1653. <summary>
  1654. The size for this parameter.
  1655. </summary>
  1656. </member>
  1657. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout">
  1658. <summary>
  1659. The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the
  1660. logging event into an object for this parameter.
  1661. </summary>
  1662. </member>
  1663. <member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName">
  1664. <summary>
  1665. Gets or sets the name of this parameter.
  1666. </summary>
  1667. <value>
  1668. The name of this parameter.
  1669. </value>
  1670. <remarks>
  1671. <para>
  1672. The name of this parameter. The parameter name
  1673. must match up to a named parameter to the SQL stored procedure
  1674. or prepared statement.
  1675. </para>
  1676. </remarks>
  1677. </member>
  1678. <member name="P:log4net.Appender.AdoNetAppenderParameter.DbType">
  1679. <summary>
  1680. Gets or sets the database type for this parameter.
  1681. </summary>
  1682. <value>
  1683. The database type for this parameter.
  1684. </value>
  1685. <remarks>
  1686. <para>
  1687. The database type for this parameter. This property should
  1688. be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/>
  1689. enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>.
  1690. </para>
  1691. <para>
  1692. This property is optional. If not specified the ADO.NET provider
  1693. will attempt to infer the type from the value.
  1694. </para>
  1695. </remarks>
  1696. <seealso cref="P:System.Data.IDataParameter.DbType"/>
  1697. </member>
  1698. <member name="P:log4net.Appender.AdoNetAppenderParameter.Precision">
  1699. <summary>
  1700. Gets or sets the precision for this parameter.
  1701. </summary>
  1702. <value>
  1703. The precision for this parameter.
  1704. </value>
  1705. <remarks>
  1706. <para>
  1707. The maximum number of digits used to represent the Value.
  1708. </para>
  1709. <para>
  1710. This property is optional. If not specified the ADO.NET provider
  1711. will attempt to infer the precision from the value.
  1712. </para>
  1713. </remarks>
  1714. <seealso cref="P:System.Data.IDbDataParameter.Precision"/>
  1715. </member>
  1716. <member name="P:log4net.Appender.AdoNetAppenderParameter.Scale">
  1717. <summary>
  1718. Gets or sets the scale for this parameter.
  1719. </summary>
  1720. <value>
  1721. The scale for this parameter.
  1722. </value>
  1723. <remarks>
  1724. <para>
  1725. The number of decimal places to which Value is resolved.
  1726. </para>
  1727. <para>
  1728. This property is optional. If not specified the ADO.NET provider
  1729. will attempt to infer the scale from the value.
  1730. </para>
  1731. </remarks>
  1732. <seealso cref="P:System.Data.IDbDataParameter.Scale"/>
  1733. </member>
  1734. <member name="P:log4net.Appender.AdoNetAppenderParameter.Size">
  1735. <summary>
  1736. Gets or sets the size for this parameter.
  1737. </summary>
  1738. <value>
  1739. The size for this parameter.
  1740. </value>
  1741. <remarks>
  1742. <para>
  1743. The maximum size, in bytes, of the data within the column.
  1744. </para>
  1745. <para>
  1746. This property is optional. If not specified the ADO.NET provider
  1747. will attempt to infer the size from the value.
  1748. </para>
  1749. <para>
  1750. For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case.
  1751. </para>
  1752. </remarks>
  1753. <seealso cref="P:System.Data.IDbDataParameter.Size"/>
  1754. </member>
  1755. <member name="P:log4net.Appender.AdoNetAppenderParameter.Layout">
  1756. <summary>
  1757. Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to
  1758. render the logging event into an object for this
  1759. parameter.
  1760. </summary>
  1761. <value>
  1762. The <see cref="T:log4net.Layout.IRawLayout"/> used to render the
  1763. logging event into an object for this parameter.
  1764. </value>
  1765. <remarks>
  1766. <para>
  1767. The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this
  1768. parameter.
  1769. </para>
  1770. <para>
  1771. The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt
  1772. any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/>
  1773. for use in the property.
  1774. </para>
  1775. </remarks>
  1776. </member>
  1777. <member name="T:log4net.Appender.AnsiColorTerminalAppender">
  1778. <summary>
  1779. Appends logging events to the terminal using ANSI color escape sequences.
  1780. </summary>
  1781. <remarks>
  1782. <para>
  1783. AnsiColorTerminalAppender appends log events to the standard output stream
  1784. or the error output stream using a layout specified by the
  1785. user. It also allows the color of a specific level of message to be set.
  1786. </para>
  1787. <note>
  1788. This appender expects the terminal to understand the VT100 control set
  1789. in order to interpret the color codes. If the terminal or console does not
  1790. understand the control codes the behavior is not defined.
  1791. </note>
  1792. <para>
  1793. By default, all output is written to the console's standard output stream.
  1794. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the
  1795. error stream.
  1796. </para>
  1797. <para>
  1798. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  1799. <c>System.Console.Error</c> that is set at the time the event is appended.
  1800. Therefore it is possible to programmatically redirect the output of this appender
  1801. (for example NUnit does this to capture program output). While this is the desired
  1802. behavior of this appender it may have security implications in your application.
  1803. </para>
  1804. <para>
  1805. When configuring the ANSI colored terminal appender, a mapping should be
  1806. specified to map a logging level to a color. For example:
  1807. </para>
  1808. <code lang="XML" escaped="true">
  1809. <mapping>
  1810. <level value="ERROR"/>
  1811. <foreColor value="White"/>
  1812. <backColor value="Red"/>
  1813. <attributes value="Bright,Underscore"/>
  1814. </mapping>
  1815. <mapping>
  1816. <level value="DEBUG"/>
  1817. <backColor value="Green"/>
  1818. </mapping>
  1819. </code>
  1820. <para>
  1821. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  1822. of the following values:
  1823. <list type="bullet">
  1824. <item><term>Blue</term><description></description></item>
  1825. <item><term>Green</term><description></description></item>
  1826. <item><term>Red</term><description></description></item>
  1827. <item><term>White</term><description></description></item>
  1828. <item><term>Yellow</term><description></description></item>
  1829. <item><term>Purple</term><description></description></item>
  1830. <item><term>Cyan</term><description></description></item>
  1831. </list>
  1832. These color values cannot be combined together to make new colors.
  1833. </para>
  1834. <para>
  1835. The attributes can be any combination of the following:
  1836. <list type="bullet">
  1837. <item><term>Bright</term><description>foreground is brighter</description></item>
  1838. <item><term>Dim</term><description>foreground is dimmer</description></item>
  1839. <item><term>Underscore</term><description>message is underlined</description></item>
  1840. <item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item>
  1841. <item><term>Reverse</term><description>foreground and background are reversed</description></item>
  1842. <item><term>Hidden</term><description>output is hidden</description></item>
  1843. <item><term>Strikethrough</term><description>message has a line through it</description></item>
  1844. </list>
  1845. While any of these attributes may be combined together not all combinations
  1846. work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes
  1847. no sense.
  1848. </para>
  1849. </remarks>
  1850. <author>Patrick Wagstrom</author>
  1851. <author>Nicko Cadell</author>
  1852. </member>
  1853. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut">
  1854. <summary>
  1855. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1856. standard output stream.
  1857. </summary>
  1858. <remarks>
  1859. <para>
  1860. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1861. standard output stream.
  1862. </para>
  1863. </remarks>
  1864. </member>
  1865. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError">
  1866. <summary>
  1867. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1868. standard error output stream.
  1869. </summary>
  1870. <remarks>
  1871. <para>
  1872. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1873. standard error output stream.
  1874. </para>
  1875. </remarks>
  1876. </member>
  1877. <member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes">
  1878. <summary>
  1879. Ansi code to reset terminal
  1880. </summary>
  1881. </member>
  1882. <member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor">
  1883. <summary>
  1884. Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class.
  1885. </summary>
  1886. <remarks>
  1887. The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class is set up to write
  1888. to the standard output stream.
  1889. </remarks>
  1890. </member>
  1891. <member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)">
  1892. <summary>
  1893. Add a mapping of level to color
  1894. </summary>
  1895. <param name="mapping">The mapping to add</param>
  1896. <remarks>
  1897. <para>
  1898. Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender.
  1899. Each mapping defines the foreground and background colours
  1900. for a level.
  1901. </para>
  1902. </remarks>
  1903. </member>
  1904. <member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)">
  1905. <summary>
  1906. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  1907. </summary>
  1908. <param name="loggingEvent">The event to log.</param>
  1909. <remarks>
  1910. <para>
  1911. Writes the event to the console.
  1912. </para>
  1913. <para>
  1914. The format of the output will depend on the appender's layout.
  1915. </para>
  1916. </remarks>
  1917. </member>
  1918. <member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions">
  1919. <summary>
  1920. Initialize the options for this appender
  1921. </summary>
  1922. <remarks>
  1923. <para>
  1924. Initialize the level to color mappings set on this appender.
  1925. </para>
  1926. </remarks>
  1927. </member>
  1928. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream">
  1929. <summary>
  1930. Flag to write output to the error stream rather than the standard output stream
  1931. </summary>
  1932. </member>
  1933. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping">
  1934. <summary>
  1935. Mapping from level object to color value
  1936. </summary>
  1937. </member>
  1938. <member name="P:log4net.Appender.AnsiColorTerminalAppender.Target">
  1939. <summary>
  1940. Target is the value of the console output stream.
  1941. </summary>
  1942. <value>
  1943. Target is the value of the console output stream.
  1944. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  1945. </value>
  1946. <remarks>
  1947. <para>
  1948. Target is the value of the console output stream.
  1949. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  1950. </para>
  1951. </remarks>
  1952. </member>
  1953. <member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout">
  1954. <summary>
  1955. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  1956. </summary>
  1957. <value><c>true</c></value>
  1958. <remarks>
  1959. <para>
  1960. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  1961. </para>
  1962. </remarks>
  1963. </member>
  1964. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes">
  1965. <summary>
  1966. The enum of possible display attributes
  1967. </summary>
  1968. <remarks>
  1969. <para>
  1970. The following flags can be combined together to
  1971. form the ANSI color attributes.
  1972. </para>
  1973. </remarks>
  1974. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
  1975. </member>
  1976. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright">
  1977. <summary>
  1978. text is bright
  1979. </summary>
  1980. </member>
  1981. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim">
  1982. <summary>
  1983. text is dim
  1984. </summary>
  1985. </member>
  1986. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore">
  1987. <summary>
  1988. text is underlined
  1989. </summary>
  1990. </member>
  1991. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink">
  1992. <summary>
  1993. text is blinking
  1994. </summary>
  1995. <remarks>
  1996. Not all terminals support this attribute
  1997. </remarks>
  1998. </member>
  1999. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse">
  2000. <summary>
  2001. text and background colors are reversed
  2002. </summary>
  2003. </member>
  2004. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden">
  2005. <summary>
  2006. text is hidden
  2007. </summary>
  2008. </member>
  2009. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough">
  2010. <summary>
  2011. text is displayed with a strikethrough
  2012. </summary>
  2013. </member>
  2014. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Light">
  2015. <summary>
  2016. text color is light
  2017. </summary>
  2018. </member>
  2019. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor">
  2020. <summary>
  2021. The enum of possible foreground or background color values for
  2022. use with the color mapping method
  2023. </summary>
  2024. <remarks>
  2025. <para>
  2026. The output can be in one for the following ANSI colors.
  2027. </para>
  2028. </remarks>
  2029. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
  2030. </member>
  2031. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black">
  2032. <summary>
  2033. color is black
  2034. </summary>
  2035. </member>
  2036. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red">
  2037. <summary>
  2038. color is red
  2039. </summary>
  2040. </member>
  2041. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green">
  2042. <summary>
  2043. color is green
  2044. </summary>
  2045. </member>
  2046. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow">
  2047. <summary>
  2048. color is yellow
  2049. </summary>
  2050. </member>
  2051. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue">
  2052. <summary>
  2053. color is blue
  2054. </summary>
  2055. </member>
  2056. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta">
  2057. <summary>
  2058. color is magenta
  2059. </summary>
  2060. </member>
  2061. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan">
  2062. <summary>
  2063. color is cyan
  2064. </summary>
  2065. </member>
  2066. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White">
  2067. <summary>
  2068. color is white
  2069. </summary>
  2070. </member>
  2071. <member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors">
  2072. <summary>
  2073. A class to act as a mapping between the level that a logging call is made at and
  2074. the color it should be displayed as.
  2075. </summary>
  2076. <remarks>
  2077. <para>
  2078. Defines the mapping between a level and the color it should be displayed in.
  2079. </para>
  2080. </remarks>
  2081. </member>
  2082. <member name="T:log4net.Util.LevelMappingEntry">
  2083. <summary>
  2084. An entry in the <see cref="T:log4net.Util.LevelMapping"/>
  2085. </summary>
  2086. <remarks>
  2087. <para>
  2088. This is an abstract base class for types that are stored in the
  2089. <see cref="T:log4net.Util.LevelMapping"/> object.
  2090. </para>
  2091. </remarks>
  2092. <author>Nicko Cadell</author>
  2093. </member>
  2094. <member name="M:log4net.Util.LevelMappingEntry.#ctor">
  2095. <summary>
  2096. Default protected constructor
  2097. </summary>
  2098. <remarks>
  2099. <para>
  2100. Default protected constructor
  2101. </para>
  2102. </remarks>
  2103. </member>
  2104. <member name="M:log4net.Util.LevelMappingEntry.ActivateOptions">
  2105. <summary>
  2106. Initialize any options defined on this entry
  2107. </summary>
  2108. <remarks>
  2109. <para>
  2110. Should be overridden by any classes that need to initialise based on their options
  2111. </para>
  2112. </remarks>
  2113. </member>
  2114. <member name="P:log4net.Util.LevelMappingEntry.Level">
  2115. <summary>
  2116. The level that is the key for this mapping
  2117. </summary>
  2118. <value>
  2119. The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping
  2120. </value>
  2121. <remarks>
  2122. <para>
  2123. Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this
  2124. mapping subclass.
  2125. </para>
  2126. </remarks>
  2127. </member>
  2128. <member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions">
  2129. <summary>
  2130. Initialize the options for the object
  2131. </summary>
  2132. <remarks>
  2133. <para>
  2134. Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together
  2135. and append the attributes.
  2136. </para>
  2137. </remarks>
  2138. </member>
  2139. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor">
  2140. <summary>
  2141. The mapped foreground color for the specified level
  2142. </summary>
  2143. <remarks>
  2144. <para>
  2145. Required property.
  2146. The mapped foreground color for the specified level
  2147. </para>
  2148. </remarks>
  2149. </member>
  2150. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor">
  2151. <summary>
  2152. The mapped background color for the specified level
  2153. </summary>
  2154. <remarks>
  2155. <para>
  2156. Required property.
  2157. The mapped background color for the specified level
  2158. </para>
  2159. </remarks>
  2160. </member>
  2161. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes">
  2162. <summary>
  2163. The color attributes for the specified level
  2164. </summary>
  2165. <remarks>
  2166. <para>
  2167. Required property.
  2168. The color attributes for the specified level
  2169. </para>
  2170. </remarks>
  2171. </member>
  2172. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor">
  2173. <summary>
  2174. The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and
  2175. <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color.
  2176. </summary>
  2177. </member>
  2178. <member name="T:log4net.Appender.AppenderCollection">
  2179. <summary>
  2180. A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects.
  2181. </summary>
  2182. <author>Nicko Cadell</author>
  2183. </member>
  2184. <member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)">
  2185. <summary>
  2186. Creates a read-only wrapper for a <c>AppenderCollection</c> instance.
  2187. </summary>
  2188. <param name="list">list to create a readonly wrapper arround</param>
  2189. <returns>
  2190. An <c>AppenderCollection</c> wrapper that is read-only.
  2191. </returns>
  2192. </member>
  2193. <member name="F:log4net.Appender.AppenderCollection.EmptyCollection">
  2194. <summary>
  2195. An empty readonly static AppenderCollection
  2196. </summary>
  2197. </member>
  2198. <member name="M:log4net.Appender.AppenderCollection.#ctor">
  2199. <summary>
  2200. Initializes a new instance of the <c>AppenderCollection</c> class
  2201. that is empty and has the default initial capacity.
  2202. </summary>
  2203. </member>
  2204. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)">
  2205. <summary>
  2206. Initializes a new instance of the <c>AppenderCollection</c> class
  2207. that has the specified initial capacity.
  2208. </summary>
  2209. <param name="capacity">
  2210. The number of elements that the new <c>AppenderCollection</c> is initially capable of storing.
  2211. </param>
  2212. </member>
  2213. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)">
  2214. <summary>
  2215. Initializes a new instance of the <c>AppenderCollection</c> class
  2216. that contains elements copied from the specified <c>AppenderCollection</c>.
  2217. </summary>
  2218. <param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param>
  2219. </member>
  2220. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])">
  2221. <summary>
  2222. Initializes a new instance of the <c>AppenderCollection</c> class
  2223. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array.
  2224. </summary>
  2225. <param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param>
  2226. </member>
  2227. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)">
  2228. <summary>
  2229. Initializes a new instance of the <c>AppenderCollection</c> class
  2230. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection.
  2231. </summary>
  2232. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param>
  2233. </member>
  2234. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)">
  2235. <summary>
  2236. Allow subclasses to avoid our default constructors
  2237. </summary>
  2238. <param name="tag"></param>
  2239. <exclude/>
  2240. </member>
  2241. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])">
  2242. <summary>
  2243. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  2244. <see cref="T:log4net.Appender.IAppender"/> array.
  2245. </summary>
  2246. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  2247. </member>
  2248. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)">
  2249. <summary>
  2250. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  2251. <see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array.
  2252. </summary>
  2253. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  2254. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  2255. </member>
  2256. <member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)">
  2257. <summary>
  2258. Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>.
  2259. </summary>
  2260. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param>
  2261. <returns>The index at which the value has been added.</returns>
  2262. </member>
  2263. <member name="M:log4net.Appender.AppenderCollection.Clear">
  2264. <summary>
  2265. Removes all elements from the <c>AppenderCollection</c>.
  2266. </summary>
  2267. </member>
  2268. <member name="M:log4net.Appender.AppenderCollection.Clone">
  2269. <summary>
  2270. Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>.
  2271. </summary>
  2272. <returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns>
  2273. </member>
  2274. <member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)">
  2275. <summary>
  2276. Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>.
  2277. </summary>
  2278. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param>
  2279. <returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns>
  2280. </member>
  2281. <member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)">
  2282. <summary>
  2283. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/>
  2284. in the <c>AppenderCollection</c>.
  2285. </summary>
  2286. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param>
  2287. <returns>
  2288. The zero-based index of the first occurrence of <paramref name="item"/>
  2289. in the entire <c>AppenderCollection</c>, if found; otherwise, -1.
  2290. </returns>
  2291. </member>
  2292. <member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)">
  2293. <summary>
  2294. Inserts an element into the <c>AppenderCollection</c> at the specified index.
  2295. </summary>
  2296. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  2297. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param>
  2298. <exception cref="T:System.ArgumentOutOfRangeException">
  2299. <para><paramref name="index"/> is less than zero</para>
  2300. <para>-or-</para>
  2301. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2302. </exception>
  2303. </member>
  2304. <member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)">
  2305. <summary>
  2306. Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>.
  2307. </summary>
  2308. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param>
  2309. <exception cref="T:System.ArgumentException">
  2310. The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>.
  2311. </exception>
  2312. </member>
  2313. <member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)">
  2314. <summary>
  2315. Removes the element at the specified index of the <c>AppenderCollection</c>.
  2316. </summary>
  2317. <param name="index">The zero-based index of the element to remove.</param>
  2318. <exception cref="T:System.ArgumentOutOfRangeException">
  2319. <para><paramref name="index"/> is less than zero</para>
  2320. <para>-or-</para>
  2321. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2322. </exception>
  2323. </member>
  2324. <member name="M:log4net.Appender.AppenderCollection.GetEnumerator">
  2325. <summary>
  2326. Returns an enumerator that can iterate through the <c>AppenderCollection</c>.
  2327. </summary>
  2328. <returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns>
  2329. </member>
  2330. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)">
  2331. <summary>
  2332. Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>.
  2333. </summary>
  2334. <param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param>
  2335. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2336. </member>
  2337. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])">
  2338. <summary>
  2339. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>.
  2340. </summary>
  2341. <param name="x">The <see cref="T:log4net.Appender.IAppender"/> array whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
  2342. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2343. </member>
  2344. <member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)">
  2345. <summary>
  2346. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>.
  2347. </summary>
  2348. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
  2349. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2350. </member>
  2351. <member name="M:log4net.Appender.AppenderCollection.TrimToSize">
  2352. <summary>
  2353. Sets the capacity to the actual number of elements.
  2354. </summary>
  2355. </member>
  2356. <member name="M:log4net.Appender.AppenderCollection.ToArray">
  2357. <summary>
  2358. Return the collection elements as an array
  2359. </summary>
  2360. <returns>the array</returns>
  2361. </member>
  2362. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)">
  2363. <exception cref="T:System.ArgumentOutOfRangeException">
  2364. <para><paramref name="i"/> is less than zero</para>
  2365. <para>-or-</para>
  2366. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2367. </exception>
  2368. </member>
  2369. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)">
  2370. <exception cref="T:System.ArgumentOutOfRangeException">
  2371. <para><paramref name="i"/> is less than zero</para>
  2372. <para>-or-</para>
  2373. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2374. </exception>
  2375. </member>
  2376. <member name="P:log4net.Appender.AppenderCollection.Count">
  2377. <summary>
  2378. Gets the number of elements actually contained in the <c>AppenderCollection</c>.
  2379. </summary>
  2380. </member>
  2381. <member name="P:log4net.Appender.AppenderCollection.IsSynchronized">
  2382. <summary>
  2383. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  2384. </summary>
  2385. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  2386. </member>
  2387. <member name="P:log4net.Appender.AppenderCollection.SyncRoot">
  2388. <summary>
  2389. Gets an object that can be used to synchronize access to the collection.
  2390. </summary>
  2391. </member>
  2392. <member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)">
  2393. <summary>
  2394. Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index.
  2395. </summary>
  2396. <param name="index">The zero-based index of the element to get or set.</param>
  2397. <exception cref="T:System.ArgumentOutOfRangeException">
  2398. <para><paramref name="index"/> is less than zero</para>
  2399. <para>-or-</para>
  2400. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2401. </exception>
  2402. </member>
  2403. <member name="P:log4net.Appender.AppenderCollection.IsFixedSize">
  2404. <summary>
  2405. Gets a value indicating whether the collection has a fixed size.
  2406. </summary>
  2407. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  2408. </member>
  2409. <member name="P:log4net.Appender.AppenderCollection.IsReadOnly">
  2410. <summary>
  2411. Gets a value indicating whether the IList is read-only.
  2412. </summary>
  2413. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  2414. </member>
  2415. <member name="P:log4net.Appender.AppenderCollection.Capacity">
  2416. <summary>
  2417. Gets or sets the number of elements the <c>AppenderCollection</c> can contain.
  2418. </summary>
  2419. </member>
  2420. <member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator">
  2421. <summary>
  2422. Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  2423. </summary>
  2424. <exclude/>
  2425. </member>
  2426. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext">
  2427. <summary>
  2428. Advances the enumerator to the next element in the collection.
  2429. </summary>
  2430. <returns>
  2431. <c>true</c> if the enumerator was successfully advanced to the next element;
  2432. <c>false</c> if the enumerator has passed the end of the collection.
  2433. </returns>
  2434. <exception cref="T:System.InvalidOperationException">
  2435. The collection was modified after the enumerator was created.
  2436. </exception>
  2437. </member>
  2438. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset">
  2439. <summary>
  2440. Sets the enumerator to its initial position, before the first element in the collection.
  2441. </summary>
  2442. </member>
  2443. <member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current">
  2444. <summary>
  2445. Gets the current element in the collection.
  2446. </summary>
  2447. </member>
  2448. <member name="T:log4net.Appender.AppenderCollection.Tag">
  2449. <summary>
  2450. Type visible only to our subclasses
  2451. Used to access protected constructor
  2452. </summary>
  2453. <exclude/>
  2454. </member>
  2455. <member name="F:log4net.Appender.AppenderCollection.Tag.Default">
  2456. <summary>
  2457. A value
  2458. </summary>
  2459. </member>
  2460. <member name="T:log4net.Appender.AppenderCollection.Enumerator">
  2461. <summary>
  2462. Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  2463. </summary>
  2464. <exclude/>
  2465. </member>
  2466. <member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)">
  2467. <summary>
  2468. Initializes a new instance of the <c>Enumerator</c> class.
  2469. </summary>
  2470. <param name="tc"></param>
  2471. </member>
  2472. <member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext">
  2473. <summary>
  2474. Advances the enumerator to the next element in the collection.
  2475. </summary>
  2476. <returns>
  2477. <c>true</c> if the enumerator was successfully advanced to the next element;
  2478. <c>false</c> if the enumerator has passed the end of the collection.
  2479. </returns>
  2480. <exception cref="T:System.InvalidOperationException">
  2481. The collection was modified after the enumerator was created.
  2482. </exception>
  2483. </member>
  2484. <member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset">
  2485. <summary>
  2486. Sets the enumerator to its initial position, before the first element in the collection.
  2487. </summary>
  2488. </member>
  2489. <member name="P:log4net.Appender.AppenderCollection.Enumerator.Current">
  2490. <summary>
  2491. Gets the current element in the collection.
  2492. </summary>
  2493. </member>
  2494. <member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection">
  2495. <exclude/>
  2496. </member>
  2497. <member name="T:log4net.Appender.AspNetTraceAppender">
  2498. <summary>
  2499. <para>
  2500. Appends log events to the ASP.NET <see cref="T:System.Web.TraceContext"/> system.
  2501. </para>
  2502. </summary>
  2503. <remarks>
  2504. <para>
  2505. Diagnostic information and tracing messages that you specify are appended to the output
  2506. of the page that is sent to the requesting browser. Optionally, you can view this information
  2507. from a separate trace viewer (Trace.axd) that displays trace information for every page in a
  2508. given application.
  2509. </para>
  2510. <para>
  2511. Trace statements are processed and displayed only when tracing is enabled. You can control
  2512. whether tracing is displayed to a page, to the trace viewer, or both.
  2513. </para>
  2514. <para>
  2515. The logging event is passed to the <see cref="M:TraceContext.Write(string)"/> or
  2516. <see cref="M:TraceContext.Warn(string)"/> method depending on the level of the logging event.
  2517. The event's logger name is the default value for the category parameter of the Write/Warn method.
  2518. </para>
  2519. </remarks>
  2520. <author>Nicko Cadell</author>
  2521. <author>Gert Driesen</author>
  2522. <author>Ron Grabowski</author>
  2523. </member>
  2524. <member name="M:log4net.Appender.AspNetTraceAppender.#ctor">
  2525. <summary>
  2526. Initializes a new instance of the <see cref="T:log4net.Appender.AspNetTraceAppender"/> class.
  2527. </summary>
  2528. <remarks>
  2529. <para>
  2530. Default constructor.
  2531. </para>
  2532. </remarks>
  2533. </member>
  2534. <member name="M:log4net.Appender.AspNetTraceAppender.Append(log4net.Core.LoggingEvent)">
  2535. <summary>
  2536. Write the logging event to the ASP.NET trace
  2537. </summary>
  2538. <param name="loggingEvent">the event to log</param>
  2539. <remarks>
  2540. <para>
  2541. Write the logging event to the ASP.NET trace
  2542. <c>HttpContext.Current.Trace</c>
  2543. (<see cref="T:System.Web.TraceContext"/>).
  2544. </para>
  2545. </remarks>
  2546. </member>
  2547. <member name="F:log4net.Appender.AspNetTraceAppender.m_category">
  2548. <summary>
  2549. Defaults to %logger
  2550. </summary>
  2551. </member>
  2552. <member name="P:log4net.Appender.AspNetTraceAppender.RequiresLayout">
  2553. <summary>
  2554. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2555. </summary>
  2556. <value><c>true</c></value>
  2557. <remarks>
  2558. <para>
  2559. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2560. </para>
  2561. </remarks>
  2562. </member>
  2563. <member name="P:log4net.Appender.AspNetTraceAppender.Category">
  2564. <summary>
  2565. The category parameter sent to the Trace method.
  2566. </summary>
  2567. <remarks>
  2568. <para>
  2569. Defaults to %logger which will use the logger name of the current
  2570. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  2571. </para>
  2572. <para>
  2573. </para>
  2574. </remarks>
  2575. </member>
  2576. <member name="T:log4net.Appender.BufferingForwardingAppender">
  2577. <summary>
  2578. Buffers events and then forwards them to attached appenders.
  2579. </summary>
  2580. <remarks>
  2581. <para>
  2582. The events are buffered in this appender until conditions are
  2583. met to allow the appender to deliver the events to the attached
  2584. appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the
  2585. conditions that cause the buffer to be sent.
  2586. </para>
  2587. <para>The forwarding appender can be used to specify different
  2588. thresholds and filters for the same appender at different locations
  2589. within the hierarchy.
  2590. </para>
  2591. </remarks>
  2592. <author>Nicko Cadell</author>
  2593. <author>Gert Driesen</author>
  2594. </member>
  2595. <member name="T:log4net.Core.IAppenderAttachable">
  2596. <summary>
  2597. Interface for attaching appenders to objects.
  2598. </summary>
  2599. <remarks>
  2600. <para>
  2601. Interface for attaching, removing and retrieving appenders.
  2602. </para>
  2603. </remarks>
  2604. <author>Nicko Cadell</author>
  2605. <author>Gert Driesen</author>
  2606. </member>
  2607. <member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)">
  2608. <summary>
  2609. Attaches an appender.
  2610. </summary>
  2611. <param name="appender">The appender to add.</param>
  2612. <remarks>
  2613. <para>
  2614. Add the specified appender. The implementation may
  2615. choose to allow or deny duplicate appenders.
  2616. </para>
  2617. </remarks>
  2618. </member>
  2619. <member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)">
  2620. <summary>
  2621. Gets an attached appender with the specified name.
  2622. </summary>
  2623. <param name="name">The name of the appender to get.</param>
  2624. <returns>
  2625. The appender with the name specified, or <c>null</c> if no appender with the
  2626. specified name is found.
  2627. </returns>
  2628. <remarks>
  2629. <para>
  2630. Returns an attached appender with the <paramref name="name"/> specified.
  2631. If no appender with the specified name is found <c>null</c> will be
  2632. returned.
  2633. </para>
  2634. </remarks>
  2635. </member>
  2636. <member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders">
  2637. <summary>
  2638. Removes all attached appenders.
  2639. </summary>
  2640. <remarks>
  2641. <para>
  2642. Removes and closes all attached appenders
  2643. </para>
  2644. </remarks>
  2645. </member>
  2646. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)">
  2647. <summary>
  2648. Removes the specified appender from the list of attached appenders.
  2649. </summary>
  2650. <param name="appender">The appender to remove.</param>
  2651. <returns>The appender removed from the list</returns>
  2652. <remarks>
  2653. <para>
  2654. The appender removed is not closed.
  2655. If you are discarding the appender you must call
  2656. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2657. </para>
  2658. </remarks>
  2659. </member>
  2660. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)">
  2661. <summary>
  2662. Removes the appender with the specified name from the list of appenders.
  2663. </summary>
  2664. <param name="name">The name of the appender to remove.</param>
  2665. <returns>The appender removed from the list</returns>
  2666. <remarks>
  2667. <para>
  2668. The appender removed is not closed.
  2669. If you are discarding the appender you must call
  2670. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2671. </para>
  2672. </remarks>
  2673. </member>
  2674. <member name="P:log4net.Core.IAppenderAttachable.Appenders">
  2675. <summary>
  2676. Gets all attached appenders.
  2677. </summary>
  2678. <value>
  2679. A collection of attached appenders.
  2680. </value>
  2681. <remarks>
  2682. <para>
  2683. Gets a collection of attached appenders.
  2684. If there are no attached appenders the
  2685. implementation should return an empty
  2686. collection rather than <c>null</c>.
  2687. </para>
  2688. </remarks>
  2689. </member>
  2690. <member name="M:log4net.Appender.BufferingForwardingAppender.#ctor">
  2691. <summary>
  2692. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender"/> class.
  2693. </summary>
  2694. <remarks>
  2695. <para>
  2696. Default constructor.
  2697. </para>
  2698. </remarks>
  2699. </member>
  2700. <member name="M:log4net.Appender.BufferingForwardingAppender.OnClose">
  2701. <summary>
  2702. Closes the appender and releases resources.
  2703. </summary>
  2704. <remarks>
  2705. <para>
  2706. Releases any resources allocated within the appender such as file handles,
  2707. network connections, etc.
  2708. </para>
  2709. <para>
  2710. It is a programming error to append to a closed appender.
  2711. </para>
  2712. </remarks>
  2713. </member>
  2714. <member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  2715. <summary>
  2716. Send the events.
  2717. </summary>
  2718. <param name="events">The events that need to be send.</param>
  2719. <remarks>
  2720. <para>
  2721. Forwards the events to the attached appenders.
  2722. </para>
  2723. </remarks>
  2724. </member>
  2725. <member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  2726. <summary>
  2727. Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
  2728. instance.
  2729. </summary>
  2730. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
  2731. <remarks>
  2732. <para>
  2733. If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
  2734. appenders, then it won't be added again.
  2735. </para>
  2736. </remarks>
  2737. </member>
  2738. <member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)">
  2739. <summary>
  2740. Looks for the appender with the specified name.
  2741. </summary>
  2742. <param name="name">The name of the appender to lookup.</param>
  2743. <returns>
  2744. The appender with the specified name, or <c>null</c>.
  2745. </returns>
  2746. <remarks>
  2747. <para>
  2748. Get the named appender attached to this buffering appender.
  2749. </para>
  2750. </remarks>
  2751. </member>
  2752. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders">
  2753. <summary>
  2754. Removes all previously added appenders from this appender.
  2755. </summary>
  2756. <remarks>
  2757. <para>
  2758. This is useful when re-reading configuration information.
  2759. </para>
  2760. </remarks>
  2761. </member>
  2762. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  2763. <summary>
  2764. Removes the specified appender from the list of appenders.
  2765. </summary>
  2766. <param name="appender">The appender to remove.</param>
  2767. <returns>The appender removed from the list</returns>
  2768. <remarks>
  2769. The appender removed is not closed.
  2770. If you are discarding the appender you must call
  2771. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2772. </remarks>
  2773. </member>
  2774. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)">
  2775. <summary>
  2776. Removes the appender with the specified name from the list of appenders.
  2777. </summary>
  2778. <param name="name">The name of the appender to remove.</param>
  2779. <returns>The appender removed from the list</returns>
  2780. <remarks>
  2781. The appender removed is not closed.
  2782. If you are discarding the appender you must call
  2783. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2784. </remarks>
  2785. </member>
  2786. <member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl">
  2787. <summary>
  2788. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  2789. </summary>
  2790. </member>
  2791. <member name="P:log4net.Appender.BufferingForwardingAppender.Appenders">
  2792. <summary>
  2793. Gets the appenders contained in this appender as an
  2794. <see cref="T:System.Collections.ICollection"/>.
  2795. </summary>
  2796. <remarks>
  2797. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  2798. is returned.
  2799. </remarks>
  2800. <returns>
  2801. A collection of the appenders in this appender.
  2802. </returns>
  2803. </member>
  2804. <member name="T:log4net.Appender.ColoredConsoleAppender">
  2805. <summary>
  2806. Appends logging events to the console.
  2807. </summary>
  2808. <remarks>
  2809. <para>
  2810. ColoredConsoleAppender appends log events to the standard output stream
  2811. or the error output stream using a layout specified by the
  2812. user. It also allows the color of a specific type of message to be set.
  2813. </para>
  2814. <para>
  2815. By default, all output is written to the console's standard output stream.
  2816. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> property can be set to direct the output to the
  2817. error stream.
  2818. </para>
  2819. <para>
  2820. NOTE: This appender writes directly to the application's attached console
  2821. not to the <c>System.Console.Out</c> or <c>System.Console.Error</c> <c>TextWriter</c>.
  2822. The <c>System.Console.Out</c> and <c>System.Console.Error</c> streams can be
  2823. programmatically redirected (for example NUnit does this to capture program output).
  2824. This appender will ignore these redirections because it needs to use Win32
  2825. API calls to colorize the output. To respect these redirections the <see cref="T:log4net.Appender.ConsoleAppender"/>
  2826. must be used.
  2827. </para>
  2828. <para>
  2829. When configuring the colored console appender, mapping should be
  2830. specified to map a logging level to a color. For example:
  2831. </para>
  2832. <code lang="XML" escaped="true">
  2833. <mapping>
  2834. <level value="ERROR"/>
  2835. <foreColor value="White"/>
  2836. <backColor value="Red, HighIntensity"/>
  2837. </mapping>
  2838. <mapping>
  2839. <level value="DEBUG"/>
  2840. <backColor value="Green"/>
  2841. </mapping>
  2842. </code>
  2843. <para>
  2844. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  2845. combination of the following values:
  2846. <list type="bullet">
  2847. <item><term>Blue</term><description></description></item>
  2848. <item><term>Green</term><description></description></item>
  2849. <item><term>Red</term><description></description></item>
  2850. <item><term>White</term><description></description></item>
  2851. <item><term>Yellow</term><description></description></item>
  2852. <item><term>Purple</term><description></description></item>
  2853. <item><term>Cyan</term><description></description></item>
  2854. <item><term>HighIntensity</term><description></description></item>
  2855. </list>
  2856. </para>
  2857. </remarks>
  2858. <author>Rick Hobbs</author>
  2859. <author>Nicko Cadell</author>
  2860. </member>
  2861. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleOut">
  2862. <summary>
  2863. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2864. standard output stream.
  2865. </summary>
  2866. <remarks>
  2867. <para>
  2868. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2869. standard output stream.
  2870. </para>
  2871. </remarks>
  2872. </member>
  2873. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleError">
  2874. <summary>
  2875. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2876. standard error output stream.
  2877. </summary>
  2878. <remarks>
  2879. <para>
  2880. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2881. standard error output stream.
  2882. </para>
  2883. </remarks>
  2884. </member>
  2885. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor">
  2886. <summary>
  2887. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class.
  2888. </summary>
  2889. <remarks>
  2890. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
  2891. to the standard output stream.
  2892. </remarks>
  2893. </member>
  2894. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout)">
  2895. <summary>
  2896. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
  2897. with the specified layout.
  2898. </summary>
  2899. <param name="layout">the layout to use for this appender</param>
  2900. <remarks>
  2901. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
  2902. to the standard output stream.
  2903. </remarks>
  2904. </member>
  2905. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  2906. <summary>
  2907. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
  2908. with the specified layout.
  2909. </summary>
  2910. <param name="layout">the layout to use for this appender</param>
  2911. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  2912. <remarks>
  2913. When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
  2914. the standard error output stream. Otherwise, output is written to the standard
  2915. output stream.
  2916. </remarks>
  2917. </member>
  2918. <member name="M:log4net.Appender.ColoredConsoleAppender.AddMapping(log4net.Appender.ColoredConsoleAppender.LevelColors)">
  2919. <summary>
  2920. Add a mapping of level to color - done by the config file
  2921. </summary>
  2922. <param name="mapping">The mapping to add</param>
  2923. <remarks>
  2924. <para>
  2925. Add a <see cref="T:log4net.Appender.ColoredConsoleAppender.LevelColors"/> mapping to this appender.
  2926. Each mapping defines the foreground and background colors
  2927. for a level.
  2928. </para>
  2929. </remarks>
  2930. </member>
  2931. <member name="M:log4net.Appender.ColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  2932. <summary>
  2933. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  2934. </summary>
  2935. <param name="loggingEvent">The event to log.</param>
  2936. <remarks>
  2937. <para>
  2938. Writes the event to the console.
  2939. </para>
  2940. <para>
  2941. The format of the output will depend on the appender's layout.
  2942. </para>
  2943. </remarks>
  2944. </member>
  2945. <member name="M:log4net.Appender.ColoredConsoleAppender.ActivateOptions">
  2946. <summary>
  2947. Initialize the options for this appender
  2948. </summary>
  2949. <remarks>
  2950. <para>
  2951. Initialize the level to color mappings set on this appender.
  2952. </para>
  2953. </remarks>
  2954. </member>
  2955. <member name="F:log4net.Appender.ColoredConsoleAppender.m_writeToErrorStream">
  2956. <summary>
  2957. Flag to write output to the error stream rather than the standard output stream
  2958. </summary>
  2959. </member>
  2960. <member name="F:log4net.Appender.ColoredConsoleAppender.m_levelMapping">
  2961. <summary>
  2962. Mapping from level object to color value
  2963. </summary>
  2964. </member>
  2965. <member name="F:log4net.Appender.ColoredConsoleAppender.m_consoleOutputWriter">
  2966. <summary>
  2967. The console output stream writer to write to
  2968. </summary>
  2969. <remarks>
  2970. <para>
  2971. This writer is not thread safe.
  2972. </para>
  2973. </remarks>
  2974. </member>
  2975. <member name="P:log4net.Appender.ColoredConsoleAppender.Target">
  2976. <summary>
  2977. Target is the value of the console output stream.
  2978. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2979. </summary>
  2980. <value>
  2981. Target is the value of the console output stream.
  2982. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2983. </value>
  2984. <remarks>
  2985. <para>
  2986. Target is the value of the console output stream.
  2987. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2988. </para>
  2989. </remarks>
  2990. </member>
  2991. <member name="P:log4net.Appender.ColoredConsoleAppender.RequiresLayout">
  2992. <summary>
  2993. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2994. </summary>
  2995. <value><c>true</c></value>
  2996. <remarks>
  2997. <para>
  2998. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2999. </para>
  3000. </remarks>
  3001. </member>
  3002. <member name="T:log4net.Appender.ColoredConsoleAppender.Colors">
  3003. <summary>
  3004. The enum of possible color values for use with the color mapping method
  3005. </summary>
  3006. <remarks>
  3007. <para>
  3008. The following flags can be combined together to
  3009. form the colors.
  3010. </para>
  3011. </remarks>
  3012. <seealso cref="T:log4net.Appender.ColoredConsoleAppender"/>
  3013. </member>
  3014. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Blue">
  3015. <summary>
  3016. color is blue
  3017. </summary>
  3018. </member>
  3019. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Green">
  3020. <summary>
  3021. color is green
  3022. </summary>
  3023. </member>
  3024. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Red">
  3025. <summary>
  3026. color is red
  3027. </summary>
  3028. </member>
  3029. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.White">
  3030. <summary>
  3031. color is white
  3032. </summary>
  3033. </member>
  3034. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Yellow">
  3035. <summary>
  3036. color is yellow
  3037. </summary>
  3038. </member>
  3039. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Purple">
  3040. <summary>
  3041. color is purple
  3042. </summary>
  3043. </member>
  3044. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Cyan">
  3045. <summary>
  3046. color is cyan
  3047. </summary>
  3048. </member>
  3049. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.HighIntensity">
  3050. <summary>
  3051. color is intensified
  3052. </summary>
  3053. </member>
  3054. <member name="T:log4net.Appender.ColoredConsoleAppender.LevelColors">
  3055. <summary>
  3056. A class to act as a mapping between the level that a logging call is made at and
  3057. the color it should be displayed as.
  3058. </summary>
  3059. <remarks>
  3060. <para>
  3061. Defines the mapping between a level and the color it should be displayed in.
  3062. </para>
  3063. </remarks>
  3064. </member>
  3065. <member name="M:log4net.Appender.ColoredConsoleAppender.LevelColors.ActivateOptions">
  3066. <summary>
  3067. Initialize the options for the object
  3068. </summary>
  3069. <remarks>
  3070. <para>
  3071. Combine the <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> together.
  3072. </para>
  3073. </remarks>
  3074. </member>
  3075. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor">
  3076. <summary>
  3077. The mapped foreground color for the specified level
  3078. </summary>
  3079. <remarks>
  3080. <para>
  3081. Required property.
  3082. The mapped foreground color for the specified level.
  3083. </para>
  3084. </remarks>
  3085. </member>
  3086. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor">
  3087. <summary>
  3088. The mapped background color for the specified level
  3089. </summary>
  3090. <remarks>
  3091. <para>
  3092. Required property.
  3093. The mapped background color for the specified level.
  3094. </para>
  3095. </remarks>
  3096. </member>
  3097. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.CombinedColor">
  3098. <summary>
  3099. The combined <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> suitable for
  3100. setting the console color.
  3101. </summary>
  3102. </member>
  3103. <member name="T:log4net.Appender.ConsoleAppender">
  3104. <summary>
  3105. Appends logging events to the console.
  3106. </summary>
  3107. <remarks>
  3108. <para>
  3109. ConsoleAppender appends log events to the standard output stream
  3110. or the error output stream using a layout specified by the
  3111. user.
  3112. </para>
  3113. <para>
  3114. By default, all output is written to the console's standard output stream.
  3115. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
  3116. error stream.
  3117. </para>
  3118. <para>
  3119. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  3120. <c>System.Console.Error</c> that is set at the time the event is appended.
  3121. Therefore it is possible to programmatically redirect the output of this appender
  3122. (for example NUnit does this to capture program output). While this is the desired
  3123. behavior of this appender it may have security implications in your application.
  3124. </para>
  3125. </remarks>
  3126. <author>Nicko Cadell</author>
  3127. <author>Gert Driesen</author>
  3128. </member>
  3129. <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
  3130. <summary>
  3131. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3132. standard output stream.
  3133. </summary>
  3134. <remarks>
  3135. <para>
  3136. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3137. standard output stream.
  3138. </para>
  3139. </remarks>
  3140. </member>
  3141. <member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
  3142. <summary>
  3143. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3144. standard error output stream.
  3145. </summary>
  3146. <remarks>
  3147. <para>
  3148. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3149. standard error output stream.
  3150. </para>
  3151. </remarks>
  3152. </member>
  3153. <member name="M:log4net.Appender.ConsoleAppender.#ctor">
  3154. <summary>
  3155. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class.
  3156. </summary>
  3157. <remarks>
  3158. The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
  3159. to the standard output stream.
  3160. </remarks>
  3161. </member>
  3162. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
  3163. <summary>
  3164. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
  3165. with the specified layout.
  3166. </summary>
  3167. <param name="layout">the layout to use for this appender</param>
  3168. <remarks>
  3169. The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
  3170. to the standard output stream.
  3171. </remarks>
  3172. </member>
  3173. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  3174. <summary>
  3175. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
  3176. with the specified layout.
  3177. </summary>
  3178. <param name="layout">the layout to use for this appender</param>
  3179. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  3180. <remarks>
  3181. When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
  3182. the standard error output stream. Otherwise, output is written to the standard
  3183. output stream.
  3184. </remarks>
  3185. </member>
  3186. <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
  3187. <summary>
  3188. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  3189. </summary>
  3190. <param name="loggingEvent">The event to log.</param>
  3191. <remarks>
  3192. <para>
  3193. Writes the event to the console.
  3194. </para>
  3195. <para>
  3196. The format of the output will depend on the appender's layout.
  3197. </para>
  3198. </remarks>
  3199. </member>
  3200. <member name="P:log4net.Appender.ConsoleAppender.Target">
  3201. <summary>
  3202. Target is the value of the console output stream.
  3203. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3204. </summary>
  3205. <value>
  3206. Target is the value of the console output stream.
  3207. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3208. </value>
  3209. <remarks>
  3210. <para>
  3211. Target is the value of the console output stream.
  3212. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3213. </para>
  3214. </remarks>
  3215. </member>
  3216. <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
  3217. <summary>
  3218. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3219. </summary>
  3220. <value><c>true</c></value>
  3221. <remarks>
  3222. <para>
  3223. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3224. </para>
  3225. </remarks>
  3226. </member>
  3227. <member name="T:log4net.Appender.DebugAppender">
  3228. <summary>
  3229. Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
  3230. </summary>
  3231. <remarks>
  3232. <para>
  3233. The application configuration file can be used to control what listeners
  3234. are actually used. See the MSDN documentation for the
  3235. <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
  3236. debug system.
  3237. </para>
  3238. <para>
  3239. Events are written using the <see cref="M:System.Diagnostics.Debug.Write(string,string)"/>
  3240. method. The event's logger name is passed as the value for the category name to the Write method.
  3241. </para>
  3242. </remarks>
  3243. <author>Nicko Cadell</author>
  3244. </member>
  3245. <member name="M:log4net.Appender.DebugAppender.#ctor">
  3246. <summary>
  3247. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>.
  3248. </summary>
  3249. <remarks>
  3250. <para>
  3251. Default constructor.
  3252. </para>
  3253. </remarks>
  3254. </member>
  3255. <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
  3256. <summary>
  3257. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>
  3258. with a specified layout.
  3259. </summary>
  3260. <param name="layout">The layout to use with this appender.</param>
  3261. <remarks>
  3262. <para>
  3263. Obsolete constructor.
  3264. </para>
  3265. </remarks>
  3266. </member>
  3267. <member name="M:log4net.Appender.DebugAppender.Flush(System.Int32)">
  3268. <summary>
  3269. Flushes any buffered log data.
  3270. </summary>
  3271. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  3272. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  3273. </member>
  3274. <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
  3275. <summary>
  3276. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  3277. </summary>
  3278. <param name="loggingEvent">The event to log.</param>
  3279. <remarks>
  3280. <para>
  3281. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  3282. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/>
  3283. is called.
  3284. </para>
  3285. </remarks>
  3286. </member>
  3287. <member name="F:log4net.Appender.DebugAppender.m_immediateFlush">
  3288. <summary>
  3289. Immediate flush means that the underlying writer or output stream
  3290. will be flushed at the end of each append operation.
  3291. </summary>
  3292. <remarks>
  3293. <para>
  3294. Immediate flush is slower but ensures that each append request is
  3295. actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to
  3296. <c>false</c>, then there is a good chance that the last few
  3297. logs events are not actually written to persistent media if and
  3298. when the application crashes.
  3299. </para>
  3300. <para>
  3301. The default value is <c>true</c>.</para>
  3302. </remarks>
  3303. </member>
  3304. <member name="P:log4net.Appender.DebugAppender.ImmediateFlush">
  3305. <summary>
  3306. Gets or sets a value that indicates whether the appender will
  3307. flush at the end of each write.
  3308. </summary>
  3309. <remarks>
  3310. <para>The default behavior is to flush at the end of each
  3311. write. If the option is set to<c>false</c>, then the underlying
  3312. stream can defer writing to physical medium to a later time.
  3313. </para>
  3314. <para>
  3315. Avoiding the flush operation at the end of each append results
  3316. in a performance gain of 10 to 20 percent. However, there is safety
  3317. trade-off involved in skipping flushing. Indeed, when flushing is
  3318. skipped, then it is likely that the last few log events will not
  3319. be recorded on disk when the application exits. This is a high
  3320. price to pay even for a 20% performance gain.
  3321. </para>
  3322. </remarks>
  3323. </member>
  3324. <member name="P:log4net.Appender.DebugAppender.RequiresLayout">
  3325. <summary>
  3326. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3327. </summary>
  3328. <value><c>true</c></value>
  3329. <remarks>
  3330. <para>
  3331. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3332. </para>
  3333. </remarks>
  3334. </member>
  3335. <member name="T:log4net.Appender.EventLogAppender">
  3336. <summary>
  3337. Writes events to the system event log.
  3338. </summary>
  3339. <remarks>
  3340. <para>
  3341. The appender will fail if you try to write using an event source that doesn't exist unless it is running with local administrator privileges.
  3342. See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog
  3343. </para>
  3344. <para>
  3345. The <c>EventID</c> of the event log entry can be
  3346. set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3347. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3348. </para>
  3349. <para>
  3350. The <c>Category</c> of the event log entry can be
  3351. set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3352. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3353. </para>
  3354. <para>
  3355. There is a limit of 32K characters for an event log message
  3356. </para>
  3357. <para>
  3358. When configuring the EventLogAppender a mapping can be
  3359. specified to map a logging level to an event log entry type. For example:
  3360. </para>
  3361. <code lang="XML">
  3362. &lt;mapping&gt;
  3363. &lt;level value="ERROR" /&gt;
  3364. &lt;eventLogEntryType value="Error" /&gt;
  3365. &lt;/mapping&gt;
  3366. &lt;mapping&gt;
  3367. &lt;level value="DEBUG" /&gt;
  3368. &lt;eventLogEntryType value="Information" /&gt;
  3369. &lt;/mapping&gt;
  3370. </code>
  3371. <para>
  3372. The Level is the standard log4net logging level and eventLogEntryType can be any value
  3373. from the <see cref="T:System.Diagnostics.EventLogEntryType"/> enum, i.e.:
  3374. <list type="bullet">
  3375. <item><term>Error</term><description>an error event</description></item>
  3376. <item><term>Warning</term><description>a warning event</description></item>
  3377. <item><term>Information</term><description>an informational event</description></item>
  3378. </list>
  3379. </para>
  3380. </remarks>
  3381. <author>Aspi Havewala</author>
  3382. <author>Douglas de la Torre</author>
  3383. <author>Nicko Cadell</author>
  3384. <author>Gert Driesen</author>
  3385. <author>Thomas Voss</author>
  3386. </member>
  3387. <member name="M:log4net.Appender.EventLogAppender.#ctor">
  3388. <summary>
  3389. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class.
  3390. </summary>
  3391. <remarks>
  3392. <para>
  3393. Default constructor.
  3394. </para>
  3395. </remarks>
  3396. </member>
  3397. <member name="M:log4net.Appender.EventLogAppender.#ctor(log4net.Layout.ILayout)">
  3398. <summary>
  3399. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class
  3400. with the specified <see cref="T:log4net.Layout.ILayout"/>.
  3401. </summary>
  3402. <param name="layout">The <see cref="T:log4net.Layout.ILayout"/> to use with this appender.</param>
  3403. <remarks>
  3404. <para>
  3405. Obsolete constructor.
  3406. </para>
  3407. </remarks>
  3408. </member>
  3409. <member name="M:log4net.Appender.EventLogAppender.AddMapping(log4net.Appender.EventLogAppender.Level2EventLogEntryType)">
  3410. <summary>
  3411. Add a mapping of level to <see cref="T:System.Diagnostics.EventLogEntryType"/> - done by the config file
  3412. </summary>
  3413. <param name="mapping">The mapping to add</param>
  3414. <remarks>
  3415. <para>
  3416. Add a <see cref="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"/> mapping to this appender.
  3417. Each mapping defines the event log entry type for a level.
  3418. </para>
  3419. </remarks>
  3420. </member>
  3421. <member name="M:log4net.Appender.EventLogAppender.ActivateOptions">
  3422. <summary>
  3423. Initialize the appender based on the options set
  3424. </summary>
  3425. <remarks>
  3426. <para>
  3427. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3428. activation scheme. The <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> method must
  3429. be called on this object after the configuration properties have
  3430. been set. Until <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> is called this
  3431. object is in an undefined state and must not be used.
  3432. </para>
  3433. <para>
  3434. If any of the configuration properties are modified then
  3435. <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> must be called again.
  3436. </para>
  3437. </remarks>
  3438. </member>
  3439. <member name="M:log4net.Appender.EventLogAppender.CreateEventSource(System.String,System.String,System.String)">
  3440. <summary>
  3441. Create an event log source
  3442. </summary>
  3443. <remarks>
  3444. Uses different API calls under NET_2_0
  3445. </remarks>
  3446. </member>
  3447. <member name="M:log4net.Appender.EventLogAppender.Append(log4net.Core.LoggingEvent)">
  3448. <summary>
  3449. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3450. method.
  3451. </summary>
  3452. <param name="loggingEvent">the event to log</param>
  3453. <remarks>
  3454. <para>Writes the event to the system event log using the
  3455. <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>.</para>
  3456. <para>If the event has an <c>EventID</c> property (see <see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3457. set then this integer will be used as the event log event id.</para>
  3458. <para>
  3459. There is a limit of 32K characters for an event log message
  3460. </para>
  3461. </remarks>
  3462. </member>
  3463. <member name="M:log4net.Appender.EventLogAppender.GetEntryType(log4net.Core.Level)">
  3464. <summary>
  3465. Get the equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/>
  3466. </summary>
  3467. <param name="level">the Level to convert to an EventLogEntryType</param>
  3468. <returns>The equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/></returns>
  3469. <remarks>
  3470. Because there are fewer applicable <see cref="T:System.Diagnostics.EventLogEntryType"/>
  3471. values to use in logging levels than there are in the
  3472. <see cref="T:log4net.Core.Level"/> this is a one way mapping. There is
  3473. a loss of information during the conversion.
  3474. </remarks>
  3475. </member>
  3476. <member name="F:log4net.Appender.EventLogAppender.m_logName">
  3477. <summary>
  3478. The log name is the section in the event logs where the messages
  3479. are stored.
  3480. </summary>
  3481. </member>
  3482. <member name="F:log4net.Appender.EventLogAppender.m_applicationName">
  3483. <summary>
  3484. Name of the application to use when logging. This appears in the
  3485. application column of the event log named by <see cref="F:log4net.Appender.EventLogAppender.m_logName"/>.
  3486. </summary>
  3487. </member>
  3488. <member name="F:log4net.Appender.EventLogAppender.m_machineName">
  3489. <summary>
  3490. The name of the machine which holds the event log. This is
  3491. currently only allowed to be '.' i.e. the current machine.
  3492. </summary>
  3493. </member>
  3494. <member name="F:log4net.Appender.EventLogAppender.m_levelMapping">
  3495. <summary>
  3496. Mapping from level object to EventLogEntryType
  3497. </summary>
  3498. </member>
  3499. <member name="F:log4net.Appender.EventLogAppender.m_securityContext">
  3500. <summary>
  3501. The security context to use for privileged calls
  3502. </summary>
  3503. </member>
  3504. <member name="F:log4net.Appender.EventLogAppender.m_eventId">
  3505. <summary>
  3506. The event ID to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3507. </summary>
  3508. </member>
  3509. <member name="F:log4net.Appender.EventLogAppender.m_category">
  3510. <summary>
  3511. The event category to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3512. </summary>
  3513. </member>
  3514. <member name="F:log4net.Appender.EventLogAppender.declaringType">
  3515. <summary>
  3516. The fully qualified type of the EventLogAppender class.
  3517. </summary>
  3518. <remarks>
  3519. Used by the internal logger to record the Type of the
  3520. log message.
  3521. </remarks>
  3522. </member>
  3523. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_DEFAULT">
  3524. <summary>
  3525. The maximum size supported by default.
  3526. </summary>
  3527. <remarks>
  3528. http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx
  3529. The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766
  3530. may leave space for a two byte null terminator of #0#0). The 32766 max
  3531. length is what the .NET 4.0 source code checks for, but this is WRONG!
  3532. Strings with a length > 31839 on Windows Vista or higher can CORRUPT
  3533. the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent()
  3534. for the use of the 32766 max size.
  3535. </remarks>
  3536. </member>
  3537. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_VISTA_OR_NEWER">
  3538. <summary>
  3539. The maximum size supported by a windows operating system that is vista
  3540. or newer.
  3541. </summary>
  3542. <remarks>
  3543. See ReportEvent API:
  3544. http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx
  3545. ReportEvent's lpStrings parameter:
  3546. "A pointer to a buffer containing an array of
  3547. null-terminated strings that are merged into the message before Event Viewer
  3548. displays the string to the user. This parameter must be a valid pointer
  3549. (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters."
  3550. Going beyond the size of 31839 will (at some point) corrupt the event log on Windows
  3551. Vista or higher! It may succeed for a while...but you will eventually run into the
  3552. error: "System.ComponentModel.Win32Exception : A device attached to the system is
  3553. not functioning", and the event log will then be corrupt (I was able to corrupt
  3554. an event log using a length of 31877 on Windows 7).
  3555. The max size for Windows Vista or higher is documented here:
  3556. http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx.
  3557. Going over this size may succeed a few times but the buffer will overrun and
  3558. eventually corrupt the log (based on testing).
  3559. The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API.
  3560. The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a
  3561. terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the
  3562. buffer, given enough time).
  3563. </remarks>
  3564. </member>
  3565. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE">
  3566. <summary>
  3567. The maximum size that the operating system supports for
  3568. a event log message.
  3569. </summary>
  3570. <remarks>
  3571. Used to determine the maximum string length that can be written
  3572. to the operating system event log and eventually truncate a string
  3573. that exceeds the limits.
  3574. </remarks>
  3575. </member>
  3576. <member name="M:log4net.Appender.EventLogAppender.GetMaxEventLogMessageSize">
  3577. <summary>
  3578. This method determines the maximum event log message size allowed for
  3579. the current environment.
  3580. </summary>
  3581. <returns></returns>
  3582. </member>
  3583. <member name="P:log4net.Appender.EventLogAppender.LogName">
  3584. <summary>
  3585. The name of the log where messages will be stored.
  3586. </summary>
  3587. <value>
  3588. The string name of the log where messages will be stored.
  3589. </value>
  3590. <remarks>
  3591. <para>This is the name of the log as it appears in the Event Viewer
  3592. tree. The default value is to log into the <c>Application</c>
  3593. log, this is where most applications write their events. However
  3594. if you need a separate log for your application (or applications)
  3595. then you should set the <see cref="P:log4net.Appender.EventLogAppender.LogName"/> appropriately.</para>
  3596. <para>This should not be used to distinguish your event log messages
  3597. from those of other applications, the <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>
  3598. property should be used to distinguish events. This property should be
  3599. used to group together events into a single log.
  3600. </para>
  3601. </remarks>
  3602. </member>
  3603. <member name="P:log4net.Appender.EventLogAppender.ApplicationName">
  3604. <summary>
  3605. Property used to set the Application name. This appears in the
  3606. event logs when logging.
  3607. </summary>
  3608. <value>
  3609. The string used to distinguish events from different sources.
  3610. </value>
  3611. <remarks>
  3612. Sets the event log source property.
  3613. </remarks>
  3614. </member>
  3615. <member name="P:log4net.Appender.EventLogAppender.MachineName">
  3616. <summary>
  3617. This property is used to return the name of the computer to use
  3618. when accessing the event logs. Currently, this is the current
  3619. computer, denoted by a dot "."
  3620. </summary>
  3621. <value>
  3622. The string name of the machine holding the event log that
  3623. will be logged into.
  3624. </value>
  3625. <remarks>
  3626. This property cannot be changed. It is currently set to '.'
  3627. i.e. the local machine. This may be changed in future.
  3628. </remarks>
  3629. </member>
  3630. <member name="P:log4net.Appender.EventLogAppender.SecurityContext">
  3631. <summary>
  3632. Gets or sets the <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3633. </summary>
  3634. <value>
  3635. The <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3636. </value>
  3637. <remarks>
  3638. <para>
  3639. The system security context used to write to the EventLog.
  3640. </para>
  3641. <para>
  3642. Unless a <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> specified here for this appender
  3643. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  3644. security context to use. The default behavior is to use the security context
  3645. of the current thread.
  3646. </para>
  3647. </remarks>
  3648. </member>
  3649. <member name="P:log4net.Appender.EventLogAppender.EventId">
  3650. <summary>
  3651. Gets or sets the <c>EventId</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3652. </summary>
  3653. <remarks>
  3654. <para>
  3655. The <c>EventID</c> of the event log entry will normally be
  3656. set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3657. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3658. This property provides the fallback value which defaults to 0.
  3659. </para>
  3660. </remarks>
  3661. </member>
  3662. <member name="P:log4net.Appender.EventLogAppender.Category">
  3663. <summary>
  3664. Gets or sets the <c>Category</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3665. </summary>
  3666. <remarks>
  3667. <para>
  3668. The <c>Category</c> of the event log entry will normally be
  3669. set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3670. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3671. This property provides the fallback value which defaults to 0.
  3672. </para>
  3673. </remarks>
  3674. </member>
  3675. <member name="P:log4net.Appender.EventLogAppender.RequiresLayout">
  3676. <summary>
  3677. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3678. </summary>
  3679. <value><c>true</c></value>
  3680. <remarks>
  3681. <para>
  3682. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3683. </para>
  3684. </remarks>
  3685. </member>
  3686. <member name="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType">
  3687. <summary>
  3688. A class to act as a mapping between the level that a logging call is made at and
  3689. the color it should be displayed as.
  3690. </summary>
  3691. <remarks>
  3692. <para>
  3693. Defines the mapping between a level and its event log entry type.
  3694. </para>
  3695. </remarks>
  3696. </member>
  3697. <member name="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType">
  3698. <summary>
  3699. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3700. </summary>
  3701. <remarks>
  3702. <para>
  3703. Required property.
  3704. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3705. </para>
  3706. </remarks>
  3707. </member>
  3708. <member name="T:log4net.Appender.FileAppender">
  3709. <summary>
  3710. Appends logging events to a file.
  3711. </summary>
  3712. <remarks>
  3713. <para>
  3714. Logging events are sent to the file specified by
  3715. the <see cref="P:log4net.Appender.FileAppender.File"/> property.
  3716. </para>
  3717. <para>
  3718. The file can be opened in either append or overwrite mode
  3719. by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property.
  3720. If the file path is relative it is taken as relative from
  3721. the application base directory. The file encoding can be
  3722. specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property.
  3723. </para>
  3724. <para>
  3725. The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  3726. values will be written each time the file is opened and closed
  3727. respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/>
  3728. then the file may contain multiple copies of the header and footer.
  3729. </para>
  3730. <para>
  3731. This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/>
  3732. is called. This will typically be during configuration.
  3733. If the file cannot be opened for writing the appender will attempt
  3734. to open the file again each time a message is logged to the appender.
  3735. If the file cannot be opened for writing when a message is logged then
  3736. the message will be discarded by this appender.
  3737. </para>
  3738. <para>
  3739. The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via
  3740. the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property.
  3741. The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>
  3742. is to obtain an exclusive write lock on the file until this appender is closed.
  3743. The alternative models only hold a
  3744. write lock while the appender is writing a logging event (<see cref="T:log4net.Appender.FileAppender.MinimalLock"/>)
  3745. or synchronize by using a named system wide Mutex (<see cref="T:log4net.Appender.FileAppender.InterProcessLock"/>).
  3746. </para>
  3747. <para>
  3748. All locking strategies have issues and you should seriously consider using a different strategy that
  3749. avoids having multiple processes logging to the same file.
  3750. </para>
  3751. </remarks>
  3752. <author>Nicko Cadell</author>
  3753. <author>Gert Driesen</author>
  3754. <author>Rodrigo B. de Oliveira</author>
  3755. <author>Douglas de la Torre</author>
  3756. <author>Niall Daley</author>
  3757. </member>
  3758. <member name="T:log4net.Appender.TextWriterAppender">
  3759. <summary>
  3760. Sends logging events to a <see cref="T:System.IO.TextWriter"/>.
  3761. </summary>
  3762. <remarks>
  3763. <para>
  3764. An Appender that writes to a <see cref="T:System.IO.TextWriter"/>.
  3765. </para>
  3766. <para>
  3767. This appender may be used stand alone if initialized with an appropriate
  3768. writer, however it is typically used as a base class for an appender that
  3769. can open a <see cref="T:System.IO.TextWriter"/> to write to.
  3770. </para>
  3771. </remarks>
  3772. <author>Nicko Cadell</author>
  3773. <author>Gert Driesen</author>
  3774. <author>Douglas de la Torre</author>
  3775. </member>
  3776. <member name="M:log4net.Appender.TextWriterAppender.#ctor">
  3777. <summary>
  3778. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class.
  3779. </summary>
  3780. <remarks>
  3781. <para>
  3782. Default constructor.
  3783. </para>
  3784. </remarks>
  3785. </member>
  3786. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)">
  3787. <summary>
  3788. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and
  3789. sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized
  3790. with the specified <see cref="T:System.IO.Stream"/>.
  3791. </summary>
  3792. <param name="layout">The layout to use with this appender.</param>
  3793. <param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param>
  3794. <remarks>
  3795. <para>
  3796. Obsolete constructor.
  3797. </para>
  3798. </remarks>
  3799. </member>
  3800. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)">
  3801. <summary>
  3802. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and sets
  3803. the output destination to the specified <see cref="T:System.IO.StreamWriter"/>.
  3804. </summary>
  3805. <param name="layout">The layout to use with this appender</param>
  3806. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to output to</param>
  3807. <remarks>
  3808. The <see cref="T:System.IO.TextWriter"/> must have been previously opened.
  3809. </remarks>
  3810. <remarks>
  3811. <para>
  3812. Obsolete constructor.
  3813. </para>
  3814. </remarks>
  3815. </member>
  3816. <member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck">
  3817. <summary>
  3818. This method determines if there is a sense in attempting to append.
  3819. </summary>
  3820. <remarks>
  3821. <para>
  3822. This method checks if an output target has been set and if a
  3823. layout has been set.
  3824. </para>
  3825. </remarks>
  3826. <returns><c>false</c> if any of the preconditions fail.</returns>
  3827. </member>
  3828. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)">
  3829. <summary>
  3830. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3831. method.
  3832. </summary>
  3833. <param name="loggingEvent">The event to log.</param>
  3834. <remarks>
  3835. <para>
  3836. Writes a log statement to the output stream if the output stream exists
  3837. and is writable.
  3838. </para>
  3839. <para>
  3840. The format of the output will depend on the appender's layout.
  3841. </para>
  3842. </remarks>
  3843. </member>
  3844. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])">
  3845. <summary>
  3846. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  3847. method.
  3848. </summary>
  3849. <param name="loggingEvents">The array of events to log.</param>
  3850. <remarks>
  3851. <para>
  3852. This method writes all the bulk logged events to the output writer
  3853. before flushing the stream.
  3854. </para>
  3855. </remarks>
  3856. </member>
  3857. <member name="M:log4net.Appender.TextWriterAppender.OnClose">
  3858. <summary>
  3859. Close this appender instance. The underlying stream or writer is also closed.
  3860. </summary>
  3861. <remarks>
  3862. Closed appenders cannot be reused.
  3863. </remarks>
  3864. </member>
  3865. <member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter">
  3866. <summary>
  3867. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3868. </summary>
  3869. <remarks>
  3870. <para>
  3871. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3872. </para>
  3873. </remarks>
  3874. </member>
  3875. <member name="M:log4net.Appender.TextWriterAppender.CloseWriter">
  3876. <summary>
  3877. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3878. </summary>
  3879. <remarks>
  3880. <para>
  3881. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3882. </para>
  3883. </remarks>
  3884. </member>
  3885. <member name="M:log4net.Appender.TextWriterAppender.Reset">
  3886. <summary>
  3887. Clears internal references to the underlying <see cref="T:System.IO.TextWriter"/>
  3888. and other variables.
  3889. </summary>
  3890. <remarks>
  3891. <para>
  3892. Subclasses can override this method for an alternate closing behavior.
  3893. </para>
  3894. </remarks>
  3895. </member>
  3896. <member name="M:log4net.Appender.TextWriterAppender.WriteFooter">
  3897. <summary>
  3898. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3899. </summary>
  3900. <remarks>
  3901. <para>
  3902. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3903. </para>
  3904. </remarks>
  3905. </member>
  3906. <member name="M:log4net.Appender.TextWriterAppender.WriteHeader">
  3907. <summary>
  3908. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3909. </summary>
  3910. <remarks>
  3911. <para>
  3912. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3913. </para>
  3914. </remarks>
  3915. </member>
  3916. <member name="M:log4net.Appender.TextWriterAppender.PrepareWriter">
  3917. <summary>
  3918. Called to allow a subclass to lazily initialize the writer
  3919. </summary>
  3920. <remarks>
  3921. <para>
  3922. This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or
  3923. <see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to
  3924. attempt to initialize the writer multiple times.
  3925. </para>
  3926. </remarks>
  3927. </member>
  3928. <member name="F:log4net.Appender.TextWriterAppender.m_qtw">
  3929. <summary>
  3930. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  3931. will be written to.
  3932. </summary>
  3933. </member>
  3934. <member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush">
  3935. <summary>
  3936. Immediate flush means that the underlying <see cref="T:System.IO.TextWriter"/>
  3937. or output stream will be flushed at the end of each append operation.
  3938. </summary>
  3939. <remarks>
  3940. <para>
  3941. Immediate flush is slower but ensures that each append request is
  3942. actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to
  3943. <c>false</c>, then there is a good chance that the last few
  3944. logging events are not actually persisted if and when the application
  3945. crashes.
  3946. </para>
  3947. <para>
  3948. The default value is <c>true</c>.
  3949. </para>
  3950. </remarks>
  3951. </member>
  3952. <member name="F:log4net.Appender.TextWriterAppender.declaringType">
  3953. <summary>
  3954. The fully qualified type of the TextWriterAppender class.
  3955. </summary>
  3956. <remarks>
  3957. Used by the internal logger to record the Type of the
  3958. log message.
  3959. </remarks>
  3960. </member>
  3961. <member name="M:log4net.Appender.TextWriterAppender.Flush(System.Int32)">
  3962. <summary>
  3963. Flushes any buffered log data.
  3964. </summary>
  3965. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  3966. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  3967. </member>
  3968. <member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush">
  3969. <summary>
  3970. Gets or set whether the appender will flush at the end
  3971. of each append operation.
  3972. </summary>
  3973. <value>
  3974. <para>
  3975. The default behavior is to flush at the end of each
  3976. append operation.
  3977. </para>
  3978. <para>
  3979. If this option is set to <c>false</c>, then the underlying
  3980. stream can defer persisting the logging event to a later
  3981. time.
  3982. </para>
  3983. </value>
  3984. <remarks>
  3985. Avoiding the flush operation at the end of each append results in
  3986. a performance gain of 10 to 20 percent. However, there is safety
  3987. trade-off involved in skipping flushing. Indeed, when flushing is
  3988. skipped, then it is likely that the last few log events will not
  3989. be recorded on disk when the application exits. This is a high
  3990. price to pay even for a 20% performance gain.
  3991. </remarks>
  3992. </member>
  3993. <member name="P:log4net.Appender.TextWriterAppender.Writer">
  3994. <summary>
  3995. Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go.
  3996. </summary>
  3997. <remarks>
  3998. <para>
  3999. The specified <see cref="T:System.IO.TextWriter"/> must be open and writable.
  4000. </para>
  4001. <para>
  4002. The <see cref="T:System.IO.TextWriter"/> will be closed when the appender
  4003. instance is closed.
  4004. </para>
  4005. <para>
  4006. <b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail.
  4007. </para>
  4008. </remarks>
  4009. </member>
  4010. <member name="P:log4net.Appender.TextWriterAppender.ErrorHandler">
  4011. <summary>
  4012. Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying
  4013. <see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender.
  4014. </summary>
  4015. <value>
  4016. The <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  4017. </value>
  4018. </member>
  4019. <member name="P:log4net.Appender.TextWriterAppender.RequiresLayout">
  4020. <summary>
  4021. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4022. </summary>
  4023. <value><c>true</c></value>
  4024. <remarks>
  4025. <para>
  4026. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4027. </para>
  4028. </remarks>
  4029. </member>
  4030. <member name="P:log4net.Appender.TextWriterAppender.QuietWriter">
  4031. <summary>
  4032. Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  4033. will be written to.
  4034. </summary>
  4035. <value>
  4036. The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written.
  4037. </value>
  4038. <remarks>
  4039. <para>
  4040. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  4041. will be written to.
  4042. </para>
  4043. </remarks>
  4044. </member>
  4045. <member name="M:log4net.Appender.FileAppender.#ctor">
  4046. <summary>
  4047. Default constructor
  4048. </summary>
  4049. <remarks>
  4050. <para>
  4051. Default constructor
  4052. </para>
  4053. </remarks>
  4054. </member>
  4055. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)">
  4056. <summary>
  4057. Construct a new appender using the layout, file and append mode.
  4058. </summary>
  4059. <param name="layout">the layout to use with this appender</param>
  4060. <param name="filename">the full path to the file to write to</param>
  4061. <param name="append">flag to indicate if the file should be appended to</param>
  4062. <remarks>
  4063. <para>
  4064. Obsolete constructor.
  4065. </para>
  4066. </remarks>
  4067. </member>
  4068. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)">
  4069. <summary>
  4070. Construct a new appender using the layout and file specified.
  4071. The file will be appended to.
  4072. </summary>
  4073. <param name="layout">the layout to use with this appender</param>
  4074. <param name="filename">the full path to the file to write to</param>
  4075. <remarks>
  4076. <para>
  4077. Obsolete constructor.
  4078. </para>
  4079. </remarks>
  4080. </member>
  4081. <member name="M:log4net.Appender.FileAppender.ActivateOptions">
  4082. <summary>
  4083. Activate the options on the file appender.
  4084. </summary>
  4085. <remarks>
  4086. <para>
  4087. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  4088. activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must
  4089. be called on this object after the configuration properties have
  4090. been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this
  4091. object is in an undefined state and must not be used.
  4092. </para>
  4093. <para>
  4094. If any of the configuration properties are modified then
  4095. <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again.
  4096. </para>
  4097. <para>
  4098. This will cause the file to be opened.
  4099. </para>
  4100. </remarks>
  4101. </member>
  4102. <member name="M:log4net.Appender.FileAppender.Reset">
  4103. <summary>
  4104. Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>.
  4105. </summary>
  4106. <remarks>
  4107. <para>
  4108. Resets the filename and the file stream.
  4109. </para>
  4110. </remarks>
  4111. </member>
  4112. <member name="M:log4net.Appender.FileAppender.OnClose">
  4113. <summary>
  4114. Close this appender instance. The underlying stream or writer is also closed.
  4115. </summary>
  4116. </member>
  4117. <member name="M:log4net.Appender.FileAppender.PrepareWriter">
  4118. <summary>
  4119. Called to initialize the file writer
  4120. </summary>
  4121. <remarks>
  4122. <para>
  4123. Will be called for each logged message until the file is
  4124. successfully opened.
  4125. </para>
  4126. </remarks>
  4127. </member>
  4128. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)">
  4129. <summary>
  4130. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  4131. method.
  4132. </summary>
  4133. <param name="loggingEvent">The event to log.</param>
  4134. <remarks>
  4135. <para>
  4136. Writes a log statement to the output stream if the output stream exists
  4137. and is writable.
  4138. </para>
  4139. <para>
  4140. The format of the output will depend on the appender's layout.
  4141. </para>
  4142. </remarks>
  4143. </member>
  4144. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])">
  4145. <summary>
  4146. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  4147. method.
  4148. </summary>
  4149. <param name="loggingEvents">The array of events to log.</param>
  4150. <remarks>
  4151. <para>
  4152. Acquires the output file locks once before writing all the events to
  4153. the stream.
  4154. </para>
  4155. </remarks>
  4156. </member>
  4157. <member name="M:log4net.Appender.FileAppender.WriteFooter">
  4158. <summary>
  4159. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  4160. </summary>
  4161. <remarks>
  4162. <para>
  4163. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  4164. </para>
  4165. </remarks>
  4166. </member>
  4167. <member name="M:log4net.Appender.FileAppender.WriteHeader">
  4168. <summary>
  4169. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  4170. </summary>
  4171. <remarks>
  4172. <para>
  4173. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  4174. </para>
  4175. </remarks>
  4176. </member>
  4177. <member name="M:log4net.Appender.FileAppender.CloseWriter">
  4178. <summary>
  4179. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  4180. </summary>
  4181. <remarks>
  4182. <para>
  4183. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  4184. </para>
  4185. </remarks>
  4186. </member>
  4187. <member name="M:log4net.Appender.FileAppender.CloseFile">
  4188. <summary>
  4189. Closes the previously opened file.
  4190. </summary>
  4191. <remarks>
  4192. <para>
  4193. Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then
  4194. closes the file.
  4195. </para>
  4196. </remarks>
  4197. </member>
  4198. <member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)">
  4199. <summary>
  4200. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  4201. </summary>
  4202. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  4203. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  4204. <remarks>
  4205. <para>
  4206. Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception.
  4207. Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>.
  4208. </para>
  4209. </remarks>
  4210. </member>
  4211. <member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)">
  4212. <summary>
  4213. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  4214. </summary>
  4215. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  4216. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  4217. <remarks>
  4218. <para>
  4219. If there was already an opened file, then the previous file
  4220. is closed first.
  4221. </para>
  4222. <para>
  4223. This method will ensure that the directory structure
  4224. for the <paramref name="fileName"/> specified exists.
  4225. </para>
  4226. </remarks>
  4227. </member>
  4228. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)">
  4229. <summary>
  4230. Sets the quiet writer used for file output
  4231. </summary>
  4232. <param name="fileStream">the file stream that has been opened for writing</param>
  4233. <remarks>
  4234. <para>
  4235. This implementation of <see cref="M:SetQWForFiles(Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/>
  4236. over the <paramref name="fileStream"/> and passes it to the
  4237. <see cref="M:SetQWForFiles(TextWriter)"/> method.
  4238. </para>
  4239. <para>
  4240. This method can be overridden by sub classes that want to wrap the
  4241. <see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output
  4242. data using a <c>System.Security.Cryptography.CryptoStream</c>.
  4243. </para>
  4244. </remarks>
  4245. </member>
  4246. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)">
  4247. <summary>
  4248. Sets the quiet writer being used.
  4249. </summary>
  4250. <param name="writer">the writer over the file stream that has been opened for writing</param>
  4251. <remarks>
  4252. <para>
  4253. This method can be overridden by sub classes that want to
  4254. wrap the <see cref="T:System.IO.TextWriter"/> in some way.
  4255. </para>
  4256. </remarks>
  4257. </member>
  4258. <member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)">
  4259. <summary>
  4260. Convert a path into a fully qualified path.
  4261. </summary>
  4262. <param name="path">The path to convert.</param>
  4263. <returns>The fully qualified path.</returns>
  4264. <remarks>
  4265. <para>
  4266. Converts the path specified to a fully
  4267. qualified path. If the path is relative it is
  4268. taken as relative from the application base
  4269. directory.
  4270. </para>
  4271. </remarks>
  4272. </member>
  4273. <member name="F:log4net.Appender.FileAppender.m_appendToFile">
  4274. <summary>
  4275. Flag to indicate if we should append to the file
  4276. or overwrite the file. The default is to append.
  4277. </summary>
  4278. </member>
  4279. <member name="F:log4net.Appender.FileAppender.m_fileName">
  4280. <summary>
  4281. The name of the log file.
  4282. </summary>
  4283. </member>
  4284. <member name="F:log4net.Appender.FileAppender.m_encoding">
  4285. <summary>
  4286. The encoding to use for the file stream.
  4287. </summary>
  4288. </member>
  4289. <member name="F:log4net.Appender.FileAppender.m_securityContext">
  4290. <summary>
  4291. The security context to use for privileged calls
  4292. </summary>
  4293. </member>
  4294. <member name="F:log4net.Appender.FileAppender.m_stream">
  4295. <summary>
  4296. The stream to log to. Has added locking semantics
  4297. </summary>
  4298. </member>
  4299. <member name="F:log4net.Appender.FileAppender.m_lockingModel">
  4300. <summary>
  4301. The locking model to use
  4302. </summary>
  4303. </member>
  4304. <member name="F:log4net.Appender.FileAppender.declaringType">
  4305. <summary>
  4306. The fully qualified type of the FileAppender class.
  4307. </summary>
  4308. <remarks>
  4309. Used by the internal logger to record the Type of the
  4310. log message.
  4311. </remarks>
  4312. </member>
  4313. <member name="P:log4net.Appender.FileAppender.File">
  4314. <summary>
  4315. Gets or sets the path to the file that logging will be written to.
  4316. </summary>
  4317. <value>
  4318. The path to the file that logging will be written to.
  4319. </value>
  4320. <remarks>
  4321. <para>
  4322. If the path is relative it is taken as relative from
  4323. the application base directory.
  4324. </para>
  4325. </remarks>
  4326. </member>
  4327. <member name="P:log4net.Appender.FileAppender.AppendToFile">
  4328. <summary>
  4329. Gets or sets a flag that indicates whether the file should be
  4330. appended to or overwritten.
  4331. </summary>
  4332. <value>
  4333. Indicates whether the file should be appended to or overwritten.
  4334. </value>
  4335. <remarks>
  4336. <para>
  4337. If the value is set to false then the file will be overwritten, if
  4338. it is set to true then the file will be appended to.
  4339. </para>
  4340. The default value is true.
  4341. </remarks>
  4342. </member>
  4343. <member name="P:log4net.Appender.FileAppender.Encoding">
  4344. <summary>
  4345. Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  4346. </summary>
  4347. <value>
  4348. The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  4349. </value>
  4350. <remarks>
  4351. <para>
  4352. The default encoding set is <see cref="P:System.Text.Encoding.Default"/>
  4353. which is the encoding for the system's current ANSI code page.
  4354. </para>
  4355. </remarks>
  4356. </member>
  4357. <member name="P:log4net.Appender.FileAppender.SecurityContext">
  4358. <summary>
  4359. Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  4360. </summary>
  4361. <value>
  4362. The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  4363. </value>
  4364. <remarks>
  4365. <para>
  4366. Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender
  4367. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  4368. security context to use. The default behavior is to use the security context
  4369. of the current thread.
  4370. </para>
  4371. </remarks>
  4372. </member>
  4373. <member name="P:log4net.Appender.FileAppender.LockingModel">
  4374. <summary>
  4375. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  4376. </summary>
  4377. <value>
  4378. The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file.
  4379. </value>
  4380. <remarks>
  4381. <para>
  4382. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  4383. </para>
  4384. <para>
  4385. There are three built in locking models, <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>, <see cref="T:log4net.Appender.FileAppender.MinimalLock"/> and <see cref="T:log4net.Appender.FileAppender.InterProcessLock"/> .
  4386. The first locks the file from the start of logging to the end, the
  4387. second locks only for the minimal amount of time when logging each message
  4388. and the last synchronizes processes using a named system wide Mutex.
  4389. </para>
  4390. <para>
  4391. The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>.
  4392. </para>
  4393. </remarks>
  4394. </member>
  4395. <member name="T:log4net.Appender.FileAppender.LockingStream">
  4396. <summary>
  4397. Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/>
  4398. to manage access to an underlying resource.
  4399. </summary>
  4400. </member>
  4401. <member name="M:log4net.Appender.FileAppender.LockingStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
  4402. <summary>
  4403. True asynchronous writes are not supported, the implementation forces a synchronous write.
  4404. </summary>
  4405. </member>
  4406. <member name="T:log4net.Core.LogException">
  4407. <summary>
  4408. Exception base type for log4net.
  4409. </summary>
  4410. <remarks>
  4411. <para>
  4412. This type extends <see cref="T:System.ApplicationException"/>. It
  4413. does not add any new functionality but does differentiate the
  4414. type of exception being thrown.
  4415. </para>
  4416. </remarks>
  4417. <author>Nicko Cadell</author>
  4418. <author>Gert Driesen</author>
  4419. </member>
  4420. <member name="M:log4net.Core.LogException.#ctor">
  4421. <summary>
  4422. Constructor
  4423. </summary>
  4424. <remarks>
  4425. <para>
  4426. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class.
  4427. </para>
  4428. </remarks>
  4429. </member>
  4430. <member name="M:log4net.Core.LogException.#ctor(System.String)">
  4431. <summary>
  4432. Constructor
  4433. </summary>
  4434. <param name="message">A message to include with the exception.</param>
  4435. <remarks>
  4436. <para>
  4437. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class with
  4438. the specified message.
  4439. </para>
  4440. </remarks>
  4441. </member>
  4442. <member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)">
  4443. <summary>
  4444. Constructor
  4445. </summary>
  4446. <param name="message">A message to include with the exception.</param>
  4447. <param name="innerException">A nested exception to include.</param>
  4448. <remarks>
  4449. <para>
  4450. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
  4451. with the specified message and inner exception.
  4452. </para>
  4453. </remarks>
  4454. </member>
  4455. <member name="M:log4net.Core.LogException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4456. <summary>
  4457. Serialization constructor
  4458. </summary>
  4459. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
  4460. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  4461. <remarks>
  4462. <para>
  4463. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
  4464. with serialized data.
  4465. </para>
  4466. </remarks>
  4467. </member>
  4468. <member name="T:log4net.Appender.FileAppender.LockingModelBase">
  4469. <summary>
  4470. Locking model base class
  4471. </summary>
  4472. <remarks>
  4473. <para>
  4474. Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers.
  4475. </para>
  4476. </remarks>
  4477. </member>
  4478. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4479. <summary>
  4480. Open the output file
  4481. </summary>
  4482. <param name="filename">The filename to use</param>
  4483. <param name="append">Whether to append to the file, or overwrite</param>
  4484. <param name="encoding">The encoding to use</param>
  4485. <remarks>
  4486. <para>
  4487. Open the file specified and prepare for logging.
  4488. No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called.
  4489. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>,
  4490. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>.
  4491. </para>
  4492. </remarks>
  4493. </member>
  4494. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile">
  4495. <summary>
  4496. Close the file
  4497. </summary>
  4498. <remarks>
  4499. <para>
  4500. Close the file. No further writes will be made.
  4501. </para>
  4502. </remarks>
  4503. </member>
  4504. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ActivateOptions">
  4505. <summary>
  4506. Initializes all resources used by this locking model.
  4507. </summary>
  4508. </member>
  4509. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OnClose">
  4510. <summary>
  4511. Disposes all resources that were initialized by this locking model.
  4512. </summary>
  4513. </member>
  4514. <member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock">
  4515. <summary>
  4516. Acquire the lock on the file
  4517. </summary>
  4518. <returns>A stream that is ready to be written to.</returns>
  4519. <remarks>
  4520. <para>
  4521. Acquire the lock on the file in preparation for writing to it.
  4522. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/>
  4523. must be called to release the lock on the output file.
  4524. </para>
  4525. </remarks>
  4526. </member>
  4527. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock">
  4528. <summary>
  4529. Release the lock on the file
  4530. </summary>
  4531. <remarks>
  4532. <para>
  4533. Release the lock on the file. No further writes will be made to the
  4534. stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again.
  4535. </para>
  4536. </remarks>
  4537. </member>
  4538. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CreateStream(System.String,System.Boolean,System.IO.FileShare)">
  4539. <summary>
  4540. Helper method that creates a FileStream under CurrentAppender's SecurityContext.
  4541. </summary>
  4542. <remarks>
  4543. <para>
  4544. Typically called during OpenFile or AcquireLock.
  4545. </para>
  4546. <para>
  4547. If the directory portion of the <paramref name="filename"/> does not exist, it is created
  4548. via Directory.CreateDirecctory.
  4549. </para>
  4550. </remarks>
  4551. <param name="filename"></param>
  4552. <param name="append"></param>
  4553. <param name="fileShare"></param>
  4554. <returns></returns>
  4555. </member>
  4556. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseStream(System.IO.Stream)">
  4557. <summary>
  4558. Helper method to close <paramref name="stream"/> under CurrentAppender's SecurityContext.
  4559. </summary>
  4560. <remarks>
  4561. Does not set <paramref name="stream"/> to null.
  4562. </remarks>
  4563. <param name="stream"></param>
  4564. </member>
  4565. <member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender">
  4566. <summary>
  4567. Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  4568. </summary>
  4569. <value>
  4570. The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  4571. </value>
  4572. <remarks>
  4573. <para>
  4574. The file appender this locking model is attached to and working on
  4575. behalf of.
  4576. </para>
  4577. <para>
  4578. The file appender is used to locate the security context and the error handler to use.
  4579. </para>
  4580. <para>
  4581. The value of this property will be set before <see cref="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)"/> is
  4582. called.
  4583. </para>
  4584. </remarks>
  4585. </member>
  4586. <member name="T:log4net.Appender.FileAppender.ExclusiveLock">
  4587. <summary>
  4588. Hold an exclusive lock on the output file
  4589. </summary>
  4590. <remarks>
  4591. <para>
  4592. Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called.
  4593. Maintains an exclusive lock on the file during this time.
  4594. </para>
  4595. </remarks>
  4596. </member>
  4597. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4598. <summary>
  4599. Open the file specified and prepare for logging.
  4600. </summary>
  4601. <param name="filename">The filename to use</param>
  4602. <param name="append">Whether to append to the file, or overwrite</param>
  4603. <param name="encoding">The encoding to use</param>
  4604. <remarks>
  4605. <para>
  4606. Open the file specified and prepare for logging.
  4607. No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called.
  4608. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>,
  4609. <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>.
  4610. </para>
  4611. </remarks>
  4612. </member>
  4613. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile">
  4614. <summary>
  4615. Close the file
  4616. </summary>
  4617. <remarks>
  4618. <para>
  4619. Close the file. No further writes will be made.
  4620. </para>
  4621. </remarks>
  4622. </member>
  4623. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock">
  4624. <summary>
  4625. Acquire the lock on the file
  4626. </summary>
  4627. <returns>A stream that is ready to be written to.</returns>
  4628. <remarks>
  4629. <para>
  4630. Does nothing. The lock is already taken
  4631. </para>
  4632. </remarks>
  4633. </member>
  4634. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock">
  4635. <summary>
  4636. Release the lock on the file
  4637. </summary>
  4638. <remarks>
  4639. <para>
  4640. Does nothing. The lock will be released when the file is closed.
  4641. </para>
  4642. </remarks>
  4643. </member>
  4644. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ActivateOptions">
  4645. <summary>
  4646. Initializes all resources used by this locking model.
  4647. </summary>
  4648. </member>
  4649. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OnClose">
  4650. <summary>
  4651. Disposes all resources that were initialized by this locking model.
  4652. </summary>
  4653. </member>
  4654. <member name="T:log4net.Appender.FileAppender.MinimalLock">
  4655. <summary>
  4656. Acquires the file lock for each write
  4657. </summary>
  4658. <remarks>
  4659. <para>
  4660. Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle,
  4661. thus holding the lock for the minimal amount of time. This method of locking
  4662. is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows
  4663. other processes to move/delete the log file whilst logging continues.
  4664. </para>
  4665. </remarks>
  4666. </member>
  4667. <member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4668. <summary>
  4669. Prepares to open the file when the first message is logged.
  4670. </summary>
  4671. <param name="filename">The filename to use</param>
  4672. <param name="append">Whether to append to the file, or overwrite</param>
  4673. <param name="encoding">The encoding to use</param>
  4674. <remarks>
  4675. <para>
  4676. Open the file specified and prepare for logging.
  4677. No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called.
  4678. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>,
  4679. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>.
  4680. </para>
  4681. </remarks>
  4682. </member>
  4683. <member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile">
  4684. <summary>
  4685. Close the file
  4686. </summary>
  4687. <remarks>
  4688. <para>
  4689. Close the file. No further writes will be made.
  4690. </para>
  4691. </remarks>
  4692. </member>
  4693. <member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock">
  4694. <summary>
  4695. Acquire the lock on the file
  4696. </summary>
  4697. <returns>A stream that is ready to be written to.</returns>
  4698. <remarks>
  4699. <para>
  4700. Acquire the lock on the file in preparation for writing to it.
  4701. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/>
  4702. must be called to release the lock on the output file.
  4703. </para>
  4704. </remarks>
  4705. </member>
  4706. <member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock">
  4707. <summary>
  4708. Release the lock on the file
  4709. </summary>
  4710. <remarks>
  4711. <para>
  4712. Release the lock on the file. No further writes will be made to the
  4713. stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again.
  4714. </para>
  4715. </remarks>
  4716. </member>
  4717. <member name="M:log4net.Appender.FileAppender.MinimalLock.ActivateOptions">
  4718. <summary>
  4719. Initializes all resources used by this locking model.
  4720. </summary>
  4721. </member>
  4722. <member name="M:log4net.Appender.FileAppender.MinimalLock.OnClose">
  4723. <summary>
  4724. Disposes all resources that were initialized by this locking model.
  4725. </summary>
  4726. </member>
  4727. <member name="T:log4net.Appender.FileAppender.InterProcessLock">
  4728. <summary>
  4729. Provides cross-process file locking.
  4730. </summary>
  4731. <author>Ron Grabowski</author>
  4732. <author>Steve Wranovsky</author>
  4733. </member>
  4734. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4735. <summary>
  4736. Open the file specified and prepare for logging.
  4737. </summary>
  4738. <param name="filename">The filename to use</param>
  4739. <param name="append">Whether to append to the file, or overwrite</param>
  4740. <param name="encoding">The encoding to use</param>
  4741. <remarks>
  4742. <para>
  4743. Open the file specified and prepare for logging.
  4744. No writes will be made until <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/> is called.
  4745. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/>,
  4746. -<see cref="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile"/>.
  4747. </para>
  4748. </remarks>
  4749. </member>
  4750. <member name="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile">
  4751. <summary>
  4752. Close the file
  4753. </summary>
  4754. <remarks>
  4755. <para>
  4756. Close the file. No further writes will be made.
  4757. </para>
  4758. </remarks>
  4759. </member>
  4760. <member name="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock">
  4761. <summary>
  4762. Acquire the lock on the file
  4763. </summary>
  4764. <returns>A stream that is ready to be written to.</returns>
  4765. <remarks>
  4766. <para>
  4767. Does nothing. The lock is already taken
  4768. </para>
  4769. </remarks>
  4770. </member>
  4771. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock">
  4772. <summary>
  4773. Releases the lock and allows others to acquire a lock.
  4774. </summary>
  4775. </member>
  4776. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ActivateOptions">
  4777. <summary>
  4778. Initializes all resources used by this locking model.
  4779. </summary>
  4780. </member>
  4781. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OnClose">
  4782. <summary>
  4783. Disposes all resources that were initialized by this locking model.
  4784. </summary>
  4785. </member>
  4786. <member name="T:log4net.Appender.ForwardingAppender">
  4787. <summary>
  4788. This appender forwards logging events to attached appenders.
  4789. </summary>
  4790. <remarks>
  4791. <para>
  4792. The forwarding appender can be used to specify different thresholds
  4793. and filters for the same appender at different locations within the hierarchy.
  4794. </para>
  4795. </remarks>
  4796. <author>Nicko Cadell</author>
  4797. <author>Gert Driesen</author>
  4798. </member>
  4799. <member name="M:log4net.Appender.ForwardingAppender.#ctor">
  4800. <summary>
  4801. Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender"/> class.
  4802. </summary>
  4803. <remarks>
  4804. <para>
  4805. Default constructor.
  4806. </para>
  4807. </remarks>
  4808. </member>
  4809. <member name="M:log4net.Appender.ForwardingAppender.OnClose">
  4810. <summary>
  4811. Closes the appender and releases resources.
  4812. </summary>
  4813. <remarks>
  4814. <para>
  4815. Releases any resources allocated within the appender such as file handles,
  4816. network connections, etc.
  4817. </para>
  4818. <para>
  4819. It is a programming error to append to a closed appender.
  4820. </para>
  4821. </remarks>
  4822. </member>
  4823. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)">
  4824. <summary>
  4825. Forward the logging event to the attached appenders
  4826. </summary>
  4827. <param name="loggingEvent">The event to log.</param>
  4828. <remarks>
  4829. <para>
  4830. Delivers the logging event to all the attached appenders.
  4831. </para>
  4832. </remarks>
  4833. </member>
  4834. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])">
  4835. <summary>
  4836. Forward the logging events to the attached appenders
  4837. </summary>
  4838. <param name="loggingEvents">The array of events to log.</param>
  4839. <remarks>
  4840. <para>
  4841. Delivers the logging events to all the attached appenders.
  4842. </para>
  4843. </remarks>
  4844. </member>
  4845. <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  4846. <summary>
  4847. Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
  4848. instance.
  4849. </summary>
  4850. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
  4851. <remarks>
  4852. <para>
  4853. If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
  4854. appenders, then it won't be added again.
  4855. </para>
  4856. </remarks>
  4857. </member>
  4858. <member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)">
  4859. <summary>
  4860. Looks for the appender with the specified name.
  4861. </summary>
  4862. <param name="name">The name of the appender to lookup.</param>
  4863. <returns>
  4864. The appender with the specified name, or <c>null</c>.
  4865. </returns>
  4866. <remarks>
  4867. <para>
  4868. Get the named appender attached to this appender.
  4869. </para>
  4870. </remarks>
  4871. </member>
  4872. <member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders">
  4873. <summary>
  4874. Removes all previously added appenders from this appender.
  4875. </summary>
  4876. <remarks>
  4877. <para>
  4878. This is useful when re-reading configuration information.
  4879. </para>
  4880. </remarks>
  4881. </member>
  4882. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  4883. <summary>
  4884. Removes the specified appender from the list of appenders.
  4885. </summary>
  4886. <param name="appender">The appender to remove.</param>
  4887. <returns>The appender removed from the list</returns>
  4888. <remarks>
  4889. The appender removed is not closed.
  4890. If you are discarding the appender you must call
  4891. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4892. </remarks>
  4893. </member>
  4894. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)">
  4895. <summary>
  4896. Removes the appender with the specified name from the list of appenders.
  4897. </summary>
  4898. <param name="name">The name of the appender to remove.</param>
  4899. <returns>The appender removed from the list</returns>
  4900. <remarks>
  4901. The appender removed is not closed.
  4902. If you are discarding the appender you must call
  4903. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4904. </remarks>
  4905. </member>
  4906. <member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl">
  4907. <summary>
  4908. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  4909. </summary>
  4910. </member>
  4911. <member name="P:log4net.Appender.ForwardingAppender.Appenders">
  4912. <summary>
  4913. Gets the appenders contained in this appender as an
  4914. <see cref="T:System.Collections.ICollection"/>.
  4915. </summary>
  4916. <remarks>
  4917. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  4918. is returned.
  4919. </remarks>
  4920. <returns>
  4921. A collection of the appenders in this appender.
  4922. </returns>
  4923. </member>
  4924. <member name="T:log4net.Appender.LocalSyslogAppender">
  4925. <summary>
  4926. Logs events to a local syslog service.
  4927. </summary>
  4928. <remarks>
  4929. <note>
  4930. This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>.
  4931. If these functions are not available on the local system then this appender will not work!
  4932. </note>
  4933. <para>
  4934. The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and
  4935. POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service.
  4936. </para>
  4937. <para>
  4938. This appender talks to a local syslog service. If you need to log to a remote syslog
  4939. daemon and you cannot configure your local syslog service to do this you may be
  4940. able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP.
  4941. </para>
  4942. <para>
  4943. Syslog messages must have a facility and and a severity. The severity
  4944. is derived from the Level of the logging event.
  4945. The facility must be chosen from the set of defined syslog
  4946. <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  4947. and cannot be extended.
  4948. </para>
  4949. <para>
  4950. An identifier is specified with each log message. This can be specified
  4951. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  4952. as the tag) must not contain white space. The default value for the
  4953. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  4954. </para>
  4955. </remarks>
  4956. <author>Rob Lyon</author>
  4957. <author>Nicko Cadell</author>
  4958. </member>
  4959. <member name="M:log4net.Appender.LocalSyslogAppender.#ctor">
  4960. <summary>
  4961. Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class.
  4962. </summary>
  4963. <remarks>
  4964. This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class is set up to write
  4965. to a local syslog service.
  4966. </remarks>
  4967. </member>
  4968. <member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)">
  4969. <summary>
  4970. Add a mapping of level to severity
  4971. </summary>
  4972. <param name="mapping">The mapping to add</param>
  4973. <remarks>
  4974. <para>
  4975. Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender.
  4976. </para>
  4977. </remarks>
  4978. </member>
  4979. <member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions">
  4980. <summary>
  4981. Initialize the appender based on the options set.
  4982. </summary>
  4983. <remarks>
  4984. <para>
  4985. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  4986. activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must
  4987. be called on this object after the configuration properties have
  4988. been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this
  4989. object is in an undefined state and must not be used.
  4990. </para>
  4991. <para>
  4992. If any of the configuration properties are modified then
  4993. <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again.
  4994. </para>
  4995. </remarks>
  4996. </member>
  4997. <member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)">
  4998. <summary>
  4999. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5000. </summary>
  5001. <param name="loggingEvent">The event to log.</param>
  5002. <remarks>
  5003. <para>
  5004. Writes the event to a remote syslog daemon.
  5005. </para>
  5006. <para>
  5007. The format of the output will depend on the appender's layout.
  5008. </para>
  5009. </remarks>
  5010. </member>
  5011. <member name="M:log4net.Appender.LocalSyslogAppender.OnClose">
  5012. <summary>
  5013. Close the syslog when the appender is closed
  5014. </summary>
  5015. <remarks>
  5016. <para>
  5017. Close the syslog when the appender is closed
  5018. </para>
  5019. </remarks>
  5020. </member>
  5021. <member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)">
  5022. <summary>
  5023. Translates a log4net level to a syslog severity.
  5024. </summary>
  5025. <param name="level">A log4net level.</param>
  5026. <returns>A syslog severity.</returns>
  5027. <remarks>
  5028. <para>
  5029. Translates a log4net level to a syslog severity.
  5030. </para>
  5031. </remarks>
  5032. </member>
  5033. <member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)">
  5034. <summary>
  5035. Generate a syslog priority.
  5036. </summary>
  5037. <param name="facility">The syslog facility.</param>
  5038. <param name="severity">The syslog severity.</param>
  5039. <returns>A syslog priority.</returns>
  5040. </member>
  5041. <member name="F:log4net.Appender.LocalSyslogAppender.m_facility">
  5042. <summary>
  5043. The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  5044. </summary>
  5045. </member>
  5046. <member name="F:log4net.Appender.LocalSyslogAppender.m_identity">
  5047. <summary>
  5048. The message identity
  5049. </summary>
  5050. </member>
  5051. <member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity">
  5052. <summary>
  5053. Marshaled handle to the identity string. We have to hold on to the
  5054. string as the <c>openlog</c> and <c>syslog</c> APIs just hold the
  5055. pointer to the ident and dereference it for each log message.
  5056. </summary>
  5057. </member>
  5058. <member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping">
  5059. <summary>
  5060. Mapping from level object to syslog severity
  5061. </summary>
  5062. </member>
  5063. <member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)">
  5064. <summary>
  5065. Open connection to system logger.
  5066. </summary>
  5067. </member>
  5068. <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)">
  5069. <summary>
  5070. Generate a log message.
  5071. </summary>
  5072. <remarks>
  5073. <para>
  5074. The libc syslog method takes a format string and a variable argument list similar
  5075. to the classic printf function. As this type of vararg list is not supported
  5076. by C# we need to specify the arguments explicitly. Here we have specified the
  5077. format string with a single message argument. The caller must set the format
  5078. string to <c>"%s"</c>.
  5079. </para>
  5080. </remarks>
  5081. </member>
  5082. <member name="M:log4net.Appender.LocalSyslogAppender.closelog">
  5083. <summary>
  5084. Close descriptor used to write to system logger.
  5085. </summary>
  5086. </member>
  5087. <member name="P:log4net.Appender.LocalSyslogAppender.Identity">
  5088. <summary>
  5089. Message identity
  5090. </summary>
  5091. <remarks>
  5092. <para>
  5093. An identifier is specified with each log message. This can be specified
  5094. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  5095. as the tag) must not contain white space. The default value for the
  5096. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  5097. </para>
  5098. </remarks>
  5099. </member>
  5100. <member name="P:log4net.Appender.LocalSyslogAppender.Facility">
  5101. <summary>
  5102. Syslog facility
  5103. </summary>
  5104. <remarks>
  5105. Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of
  5106. facilities is predefined and cannot be extended. The default value
  5107. is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  5108. </remarks>
  5109. </member>
  5110. <member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout">
  5111. <summary>
  5112. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  5113. </summary>
  5114. <value><c>true</c></value>
  5115. <remarks>
  5116. <para>
  5117. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  5118. </para>
  5119. </remarks>
  5120. </member>
  5121. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity">
  5122. <summary>
  5123. syslog severities
  5124. </summary>
  5125. <remarks>
  5126. <para>
  5127. The log4net Level maps to a syslog severity using the
  5128. <see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/>
  5129. class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>.
  5130. </para>
  5131. </remarks>
  5132. </member>
  5133. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency">
  5134. <summary>
  5135. system is unusable
  5136. </summary>
  5137. </member>
  5138. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert">
  5139. <summary>
  5140. action must be taken immediately
  5141. </summary>
  5142. </member>
  5143. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical">
  5144. <summary>
  5145. critical conditions
  5146. </summary>
  5147. </member>
  5148. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error">
  5149. <summary>
  5150. error conditions
  5151. </summary>
  5152. </member>
  5153. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning">
  5154. <summary>
  5155. warning conditions
  5156. </summary>
  5157. </member>
  5158. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice">
  5159. <summary>
  5160. normal but significant condition
  5161. </summary>
  5162. </member>
  5163. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational">
  5164. <summary>
  5165. informational
  5166. </summary>
  5167. </member>
  5168. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug">
  5169. <summary>
  5170. debug-level messages
  5171. </summary>
  5172. </member>
  5173. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility">
  5174. <summary>
  5175. syslog facilities
  5176. </summary>
  5177. <remarks>
  5178. <para>
  5179. The syslog facility defines which subsystem the logging comes from.
  5180. This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property.
  5181. </para>
  5182. </remarks>
  5183. </member>
  5184. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel">
  5185. <summary>
  5186. kernel messages
  5187. </summary>
  5188. </member>
  5189. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User">
  5190. <summary>
  5191. random user-level messages
  5192. </summary>
  5193. </member>
  5194. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail">
  5195. <summary>
  5196. mail system
  5197. </summary>
  5198. </member>
  5199. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons">
  5200. <summary>
  5201. system daemons
  5202. </summary>
  5203. </member>
  5204. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization">
  5205. <summary>
  5206. security/authorization messages
  5207. </summary>
  5208. </member>
  5209. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog">
  5210. <summary>
  5211. messages generated internally by syslogd
  5212. </summary>
  5213. </member>
  5214. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer">
  5215. <summary>
  5216. line printer subsystem
  5217. </summary>
  5218. </member>
  5219. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News">
  5220. <summary>
  5221. network news subsystem
  5222. </summary>
  5223. </member>
  5224. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp">
  5225. <summary>
  5226. UUCP subsystem
  5227. </summary>
  5228. </member>
  5229. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock">
  5230. <summary>
  5231. clock (cron/at) daemon
  5232. </summary>
  5233. </member>
  5234. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2">
  5235. <summary>
  5236. security/authorization messages (private)
  5237. </summary>
  5238. </member>
  5239. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp">
  5240. <summary>
  5241. ftp daemon
  5242. </summary>
  5243. </member>
  5244. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp">
  5245. <summary>
  5246. NTP subsystem
  5247. </summary>
  5248. </member>
  5249. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit">
  5250. <summary>
  5251. log audit
  5252. </summary>
  5253. </member>
  5254. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert">
  5255. <summary>
  5256. log alert
  5257. </summary>
  5258. </member>
  5259. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2">
  5260. <summary>
  5261. clock daemon
  5262. </summary>
  5263. </member>
  5264. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0">
  5265. <summary>
  5266. reserved for local use
  5267. </summary>
  5268. </member>
  5269. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1">
  5270. <summary>
  5271. reserved for local use
  5272. </summary>
  5273. </member>
  5274. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2">
  5275. <summary>
  5276. reserved for local use
  5277. </summary>
  5278. </member>
  5279. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3">
  5280. <summary>
  5281. reserved for local use
  5282. </summary>
  5283. </member>
  5284. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4">
  5285. <summary>
  5286. reserved for local use
  5287. </summary>
  5288. </member>
  5289. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5">
  5290. <summary>
  5291. reserved for local use
  5292. </summary>
  5293. </member>
  5294. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6">
  5295. <summary>
  5296. reserved for local use
  5297. </summary>
  5298. </member>
  5299. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7">
  5300. <summary>
  5301. reserved for local use
  5302. </summary>
  5303. </member>
  5304. <member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity">
  5305. <summary>
  5306. A class to act as a mapping between the level that a logging call is made at and
  5307. the syslog severity that is should be logged at.
  5308. </summary>
  5309. <remarks>
  5310. <para>
  5311. A class to act as a mapping between the level that a logging call is made at and
  5312. the syslog severity that is should be logged at.
  5313. </para>
  5314. </remarks>
  5315. </member>
  5316. <member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity">
  5317. <summary>
  5318. The mapped syslog severity for the specified level
  5319. </summary>
  5320. <remarks>
  5321. <para>
  5322. Required property.
  5323. The mapped syslog severity for the specified level
  5324. </para>
  5325. </remarks>
  5326. </member>
  5327. <member name="T:log4net.Appender.ManagedColoredConsoleAppender">
  5328. <summary>
  5329. Appends colorful logging events to the console, using the .NET 2
  5330. built-in capabilities.
  5331. </summary>
  5332. <remarks>
  5333. <para>
  5334. ManagedColoredConsoleAppender appends log events to the standard output stream
  5335. or the error output stream using a layout specified by the
  5336. user. It also allows the color of a specific type of message to be set.
  5337. </para>
  5338. <para>
  5339. By default, all output is written to the console's standard output stream.
  5340. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> property can be set to direct the output to the
  5341. error stream.
  5342. </para>
  5343. <para>
  5344. When configuring the colored console appender, mappings should be
  5345. specified to map logging levels to colors. For example:
  5346. </para>
  5347. <code lang="XML" escaped="true">
  5348. <mapping>
  5349. <level value="ERROR"/>
  5350. <foreColor value="DarkRed"/>
  5351. <backColor value="White"/>
  5352. </mapping>
  5353. <mapping>
  5354. <level value="WARN"/>
  5355. <foreColor value="Yellow"/>
  5356. </mapping>
  5357. <mapping>
  5358. <level value="INFO"/>
  5359. <foreColor value="White"/>
  5360. </mapping>
  5361. <mapping>
  5362. <level value="DEBUG"/>
  5363. <foreColor value="Blue"/>
  5364. </mapping>
  5365. </code>
  5366. <para>
  5367. The Level is the standard log4net logging level while
  5368. ForeColor and BackColor are the values of <see cref="T:System.ConsoleColor"/>
  5369. enumeration.
  5370. </para>
  5371. <para>
  5372. Based on the ColoredConsoleAppender
  5373. </para>
  5374. </remarks>
  5375. <author>Rick Hobbs</author>
  5376. <author>Nicko Cadell</author>
  5377. <author>Pavlos Touboulidis</author>
  5378. </member>
  5379. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleOut">
  5380. <summary>
  5381. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  5382. standard output stream.
  5383. </summary>
  5384. <remarks>
  5385. <para>
  5386. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  5387. standard output stream.
  5388. </para>
  5389. </remarks>
  5390. </member>
  5391. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleError">
  5392. <summary>
  5393. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  5394. standard error output stream.
  5395. </summary>
  5396. <remarks>
  5397. <para>
  5398. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  5399. standard error output stream.
  5400. </para>
  5401. </remarks>
  5402. </member>
  5403. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.#ctor">
  5404. <summary>
  5405. Initializes a new instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender"/> class.
  5406. </summary>
  5407. <remarks>
  5408. The instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender"/> class is set up to write
  5409. to the standard output stream.
  5410. </remarks>
  5411. </member>
  5412. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.AddMapping(log4net.Appender.ManagedColoredConsoleAppender.LevelColors)">
  5413. <summary>
  5414. Add a mapping of level to color - done by the config file
  5415. </summary>
  5416. <param name="mapping">The mapping to add</param>
  5417. <remarks>
  5418. <para>
  5419. Add a <see cref="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors"/> mapping to this appender.
  5420. Each mapping defines the foreground and background colors
  5421. for a level.
  5422. </para>
  5423. </remarks>
  5424. </member>
  5425. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  5426. <summary>
  5427. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  5428. </summary>
  5429. <param name="loggingEvent">The event to log.</param>
  5430. <remarks>
  5431. <para>
  5432. Writes the event to the console.
  5433. </para>
  5434. <para>
  5435. The format of the output will depend on the appender's layout.
  5436. </para>
  5437. </remarks>
  5438. </member>
  5439. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.ActivateOptions">
  5440. <summary>
  5441. Initialize the options for this appender
  5442. </summary>
  5443. <remarks>
  5444. <para>
  5445. Initialize the level to color mappings set on this appender.
  5446. </para>
  5447. </remarks>
  5448. </member>
  5449. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_writeToErrorStream">
  5450. <summary>
  5451. Flag to write output to the error stream rather than the standard output stream
  5452. </summary>
  5453. </member>
  5454. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_levelMapping">
  5455. <summary>
  5456. Mapping from level object to color value
  5457. </summary>
  5458. </member>
  5459. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.Target">
  5460. <summary>
  5461. Target is the value of the console output stream.
  5462. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  5463. </summary>
  5464. <value>
  5465. Target is the value of the console output stream.
  5466. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  5467. </value>
  5468. <remarks>
  5469. <para>
  5470. Target is the value of the console output stream.
  5471. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  5472. </para>
  5473. </remarks>
  5474. </member>
  5475. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.RequiresLayout">
  5476. <summary>
  5477. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5478. </summary>
  5479. <value><c>true</c></value>
  5480. <remarks>
  5481. <para>
  5482. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5483. </para>
  5484. </remarks>
  5485. </member>
  5486. <member name="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors">
  5487. <summary>
  5488. A class to act as a mapping between the level that a logging call is made at and
  5489. the color it should be displayed as.
  5490. </summary>
  5491. <remarks>
  5492. <para>
  5493. Defines the mapping between a level and the color it should be displayed in.
  5494. </para>
  5495. </remarks>
  5496. </member>
  5497. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.ForeColor">
  5498. <summary>
  5499. The mapped foreground color for the specified level
  5500. </summary>
  5501. <remarks>
  5502. <para>
  5503. Required property.
  5504. The mapped foreground color for the specified level.
  5505. </para>
  5506. </remarks>
  5507. </member>
  5508. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.BackColor">
  5509. <summary>
  5510. The mapped background color for the specified level
  5511. </summary>
  5512. <remarks>
  5513. <para>
  5514. Required property.
  5515. The mapped background color for the specified level.
  5516. </para>
  5517. </remarks>
  5518. </member>
  5519. <member name="T:log4net.Appender.MemoryAppender">
  5520. <summary>
  5521. Stores logging events in an array.
  5522. </summary>
  5523. <remarks>
  5524. <para>
  5525. The memory appender stores all the logging events
  5526. that are appended in an in-memory array.
  5527. </para>
  5528. <para>
  5529. Use the <see cref="M:PopAllEvents()"/> method to get
  5530. and clear the current list of events that have been appended.
  5531. </para>
  5532. <para>
  5533. Use the <see cref="M:GetEvents()"/> method to get the current
  5534. list of events that have been appended. Note there is a
  5535. race-condition when calling <see cref="M:GetEvents()"/> and
  5536. <see cref="M:Clear()"/> in pairs, you better use <see
  5537. mref="M:PopAllEvents()"/> in that case.
  5538. </para>
  5539. <para>
  5540. Use the <see cref="M:Clear()"/> method to clear the
  5541. current list of events. Note there is a
  5542. race-condition when calling <see cref="M:GetEvents()"/> and
  5543. <see cref="M:Clear()"/> in pairs, you better use <see
  5544. mref="M:PopAllEvents()"/> in that case.
  5545. </para>
  5546. </remarks>
  5547. <author>Julian Biddle</author>
  5548. <author>Nicko Cadell</author>
  5549. <author>Gert Driesen</author>
  5550. </member>
  5551. <member name="M:log4net.Appender.MemoryAppender.#ctor">
  5552. <summary>
  5553. Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender"/> class.
  5554. </summary>
  5555. <remarks>
  5556. <para>
  5557. Default constructor.
  5558. </para>
  5559. </remarks>
  5560. </member>
  5561. <member name="M:log4net.Appender.MemoryAppender.GetEvents">
  5562. <summary>
  5563. Gets the events that have been logged.
  5564. </summary>
  5565. <returns>The events that have been logged</returns>
  5566. <remarks>
  5567. <para>
  5568. Gets the events that have been logged.
  5569. </para>
  5570. </remarks>
  5571. </member>
  5572. <member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)">
  5573. <summary>
  5574. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5575. </summary>
  5576. <param name="loggingEvent">the event to log</param>
  5577. <remarks>
  5578. <para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
  5579. </remarks>
  5580. </member>
  5581. <member name="M:log4net.Appender.MemoryAppender.Clear">
  5582. <summary>
  5583. Clear the list of events
  5584. </summary>
  5585. <remarks>
  5586. Clear the list of events
  5587. </remarks>
  5588. </member>
  5589. <member name="M:log4net.Appender.MemoryAppender.PopAllEvents">
  5590. <summary>
  5591. Gets the events that have been logged and clears the list of events.
  5592. </summary>
  5593. <returns>The events that have been logged</returns>
  5594. <remarks>
  5595. <para>
  5596. Gets the events that have been logged and clears the list of events.
  5597. </para>
  5598. </remarks>
  5599. </member>
  5600. <member name="F:log4net.Appender.MemoryAppender.m_eventsList">
  5601. <summary>
  5602. The list of events that have been appended.
  5603. </summary>
  5604. </member>
  5605. <member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
  5606. <summary>
  5607. Value indicating which fields in the event should be fixed
  5608. </summary>
  5609. <remarks>
  5610. By default all fields are fixed
  5611. </remarks>
  5612. </member>
  5613. <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
  5614. <summary>
  5615. Gets or sets a value indicating whether only part of the logging event
  5616. data should be fixed.
  5617. </summary>
  5618. <value>
  5619. <c>true</c> if the appender should only fix part of the logging event
  5620. data, otherwise <c>false</c>. The default is <c>false</c>.
  5621. </value>
  5622. <remarks>
  5623. <para>
  5624. Setting this property to <c>true</c> will cause only part of the event
  5625. data to be fixed and stored in the appender, hereby improving performance.
  5626. </para>
  5627. <para>
  5628. See <see cref="M:LoggingEvent.FixVolatileData(bool)"/> for more information.
  5629. </para>
  5630. </remarks>
  5631. </member>
  5632. <member name="P:log4net.Appender.MemoryAppender.Fix">
  5633. <summary>
  5634. Gets or sets the fields that will be fixed in the event
  5635. </summary>
  5636. <remarks>
  5637. <para>
  5638. The logging event needs to have certain thread specific values
  5639. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  5640. for details.
  5641. </para>
  5642. </remarks>
  5643. </member>
  5644. <member name="T:log4net.Appender.NetSendAppender">
  5645. <summary>
  5646. Logs entries by sending network messages using the
  5647. <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/> native function.
  5648. </summary>
  5649. <remarks>
  5650. <para>
  5651. You can send messages only to names that are active
  5652. on the network. If you send the message to a user name,
  5653. that user must be logged on and running the Messenger
  5654. service to receive the message.
  5655. </para>
  5656. <para>
  5657. The receiver will get a top most window displaying the
  5658. messages one at a time, therefore this appender should
  5659. not be used to deliver a high volume of messages.
  5660. </para>
  5661. <para>
  5662. The following table lists some possible uses for this appender :
  5663. </para>
  5664. <para>
  5665. <list type="table">
  5666. <listheader>
  5667. <term>Action</term>
  5668. <description>Property Value(s)</description>
  5669. </listheader>
  5670. <item>
  5671. <term>Send a message to a user account on the local machine</term>
  5672. <description>
  5673. <para>
  5674. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine&gt;
  5675. </para>
  5676. <para>
  5677. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5678. </para>
  5679. </description>
  5680. </item>
  5681. <item>
  5682. <term>Send a message to a user account on a remote machine</term>
  5683. <description>
  5684. <para>
  5685. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the remote machine&gt;
  5686. </para>
  5687. <para>
  5688. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5689. </para>
  5690. </description>
  5691. </item>
  5692. <item>
  5693. <term>Send a message to a domain user account</term>
  5694. <description>
  5695. <para>
  5696. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of a domain controller | uninitialized&gt;
  5697. </para>
  5698. <para>
  5699. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5700. </para>
  5701. </description>
  5702. </item>
  5703. <item>
  5704. <term>Send a message to all the names in a workgroup or domain</term>
  5705. <description>
  5706. <para>
  5707. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;workgroup name | domain name&gt;*
  5708. </para>
  5709. </description>
  5710. </item>
  5711. <item>
  5712. <term>Send a message from the local machine to a remote machine</term>
  5713. <description>
  5714. <para>
  5715. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine | uninitialized&gt;
  5716. </para>
  5717. <para>
  5718. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;name of the remote machine&gt;
  5719. </para>
  5720. </description>
  5721. </item>
  5722. </list>
  5723. </para>
  5724. <para>
  5725. <b>Note :</b> security restrictions apply for sending
  5726. network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/>
  5727. for more information.
  5728. </para>
  5729. </remarks>
  5730. <example>
  5731. <para>
  5732. An example configuration section to log information
  5733. using this appender from the local machine, named
  5734. LOCAL_PC, to machine OPERATOR_PC :
  5735. </para>
  5736. <code lang="XML" escaped="true">
  5737. <appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender">
  5738. <server value="LOCAL_PC"/>
  5739. <recipient value="OPERATOR_PC"/>
  5740. <layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n"/>
  5741. </appender>
  5742. </code>
  5743. </example>
  5744. <author>Nicko Cadell</author>
  5745. <author>Gert Driesen</author>
  5746. </member>
  5747. <member name="F:log4net.Appender.NetSendAppender.m_server">
  5748. <summary>
  5749. The DNS or NetBIOS name of the server on which the function is to execute.
  5750. </summary>
  5751. </member>
  5752. <member name="F:log4net.Appender.NetSendAppender.m_sender">
  5753. <summary>
  5754. The sender of the network message.
  5755. </summary>
  5756. </member>
  5757. <member name="F:log4net.Appender.NetSendAppender.m_recipient">
  5758. <summary>
  5759. The message alias to which the message should be sent.
  5760. </summary>
  5761. </member>
  5762. <member name="F:log4net.Appender.NetSendAppender.m_securityContext">
  5763. <summary>
  5764. The security context to use for privileged calls
  5765. </summary>
  5766. </member>
  5767. <member name="M:log4net.Appender.NetSendAppender.#ctor">
  5768. <summary>
  5769. Initializes the appender.
  5770. </summary>
  5771. <remarks>
  5772. The default constructor initializes all fields to their default values.
  5773. </remarks>
  5774. </member>
  5775. <member name="M:log4net.Appender.NetSendAppender.ActivateOptions">
  5776. <summary>
  5777. Initialize the appender based on the options set.
  5778. </summary>
  5779. <remarks>
  5780. <para>
  5781. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5782. activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must
  5783. be called on this object after the configuration properties have
  5784. been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this
  5785. object is in an undefined state and must not be used.
  5786. </para>
  5787. <para>
  5788. If any of the configuration properties are modified then
  5789. <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again.
  5790. </para>
  5791. <para>
  5792. The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was specified.
  5793. </para>
  5794. </remarks>
  5795. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was not specified.</exception>
  5796. </member>
  5797. <member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)">
  5798. <summary>
  5799. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5800. </summary>
  5801. <param name="loggingEvent">The event to log.</param>
  5802. <remarks>
  5803. <para>
  5804. Sends the event using a network message.
  5805. </para>
  5806. </remarks>
  5807. </member>
  5808. <member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)">
  5809. <summary>
  5810. Sends a buffer of information to a registered message alias.
  5811. </summary>
  5812. <param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param>
  5813. <param name="msgName">The message alias to which the message buffer should be sent</param>
  5814. <param name="fromName">The originator of the message.</param>
  5815. <param name="buffer">The message text.</param>
  5816. <param name="bufferSize">The length, in bytes, of the message text.</param>
  5817. <remarks>
  5818. <para>
  5819. The following restrictions apply for sending network messages:
  5820. </para>
  5821. <para>
  5822. <list type="table">
  5823. <listheader>
  5824. <term>Platform</term>
  5825. <description>Requirements</description>
  5826. </listheader>
  5827. <item>
  5828. <term>Windows NT</term>
  5829. <description>
  5830. <para>
  5831. No special group membership is required to send a network message.
  5832. </para>
  5833. <para>
  5834. Admin, Accounts, Print, or Server Operator group membership is required to
  5835. successfully send a network message on a remote server.
  5836. </para>
  5837. </description>
  5838. </item>
  5839. <item>
  5840. <term>Windows 2000 or later</term>
  5841. <description>
  5842. <para>
  5843. If you send a message on a domain controller that is running Active Directory,
  5844. access is allowed or denied based on the access control list (ACL) for the securable
  5845. object. The default ACL permits only Domain Admins and Account Operators to send a network message.
  5846. </para>
  5847. <para>
  5848. On a member server or workstation, only Administrators and Server Operators can send a network message.
  5849. </para>
  5850. </description>
  5851. </item>
  5852. </list>
  5853. </para>
  5854. <para>
  5855. 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>.
  5856. </para>
  5857. </remarks>
  5858. <returns>
  5859. <para>
  5860. If the function succeeds, the return value is zero.
  5861. </para>
  5862. </returns>
  5863. </member>
  5864. <member name="P:log4net.Appender.NetSendAppender.Sender">
  5865. <summary>
  5866. Gets or sets the sender of the message.
  5867. </summary>
  5868. <value>
  5869. The sender of the message.
  5870. </value>
  5871. <remarks>
  5872. If this property is not specified, the message is sent from the local computer.
  5873. </remarks>
  5874. </member>
  5875. <member name="P:log4net.Appender.NetSendAppender.Recipient">
  5876. <summary>
  5877. Gets or sets the message alias to which the message should be sent.
  5878. </summary>
  5879. <value>
  5880. The recipient of the message.
  5881. </value>
  5882. <remarks>
  5883. This property should always be specified in order to send a message.
  5884. </remarks>
  5885. </member>
  5886. <member name="P:log4net.Appender.NetSendAppender.Server">
  5887. <summary>
  5888. Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute.
  5889. </summary>
  5890. <value>
  5891. DNS or NetBIOS name of the remote server on which the function is to execute.
  5892. </value>
  5893. <remarks>
  5894. <para>
  5895. For Windows NT 4.0 and earlier, the string should begin with \\.
  5896. </para>
  5897. <para>
  5898. If this property is not specified, the local computer is used.
  5899. </para>
  5900. </remarks>
  5901. </member>
  5902. <member name="P:log4net.Appender.NetSendAppender.SecurityContext">
  5903. <summary>
  5904. Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5905. </summary>
  5906. <value>
  5907. The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5908. </value>
  5909. <remarks>
  5910. <para>
  5911. Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender
  5912. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  5913. security context to use. The default behavior is to use the security context
  5914. of the current thread.
  5915. </para>
  5916. </remarks>
  5917. </member>
  5918. <member name="P:log4net.Appender.NetSendAppender.RequiresLayout">
  5919. <summary>
  5920. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5921. </summary>
  5922. <value><c>true</c></value>
  5923. <remarks>
  5924. <para>
  5925. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5926. </para>
  5927. </remarks>
  5928. </member>
  5929. <member name="T:log4net.Appender.OutputDebugStringAppender">
  5930. <summary>
  5931. Appends log events to the OutputDebugString system.
  5932. </summary>
  5933. <remarks>
  5934. <para>
  5935. OutputDebugStringAppender appends log events to the
  5936. OutputDebugString system.
  5937. </para>
  5938. <para>
  5939. The string is passed to the native <c>OutputDebugString</c>
  5940. function.
  5941. </para>
  5942. </remarks>
  5943. <author>Nicko Cadell</author>
  5944. <author>Gert Driesen</author>
  5945. </member>
  5946. <member name="M:log4net.Appender.OutputDebugStringAppender.#ctor">
  5947. <summary>
  5948. Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender"/> class.
  5949. </summary>
  5950. <remarks>
  5951. <para>
  5952. Default constructor.
  5953. </para>
  5954. </remarks>
  5955. </member>
  5956. <member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)">
  5957. <summary>
  5958. Write the logging event to the output debug string API
  5959. </summary>
  5960. <param name="loggingEvent">the event to log</param>
  5961. <remarks>
  5962. <para>
  5963. Write the logging event to the output debug string API
  5964. </para>
  5965. </remarks>
  5966. </member>
  5967. <member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)">
  5968. <summary>
  5969. Stub for OutputDebugString native method
  5970. </summary>
  5971. <param name="message">the string to output</param>
  5972. <remarks>
  5973. <para>
  5974. Stub for OutputDebugString native method
  5975. </para>
  5976. </remarks>
  5977. </member>
  5978. <member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout">
  5979. <summary>
  5980. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5981. </summary>
  5982. <value><c>true</c></value>
  5983. <remarks>
  5984. <para>
  5985. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5986. </para>
  5987. </remarks>
  5988. </member>
  5989. <member name="T:log4net.Appender.RemoteSyslogAppender">
  5990. <summary>
  5991. Logs events to a remote syslog daemon.
  5992. </summary>
  5993. <remarks>
  5994. <para>
  5995. The BSD syslog protocol is used to remotely log to
  5996. a syslog daemon. The syslogd listens for for messages
  5997. on UDP port 514.
  5998. </para>
  5999. <para>
  6000. The syslog UDP protocol is not authenticated. Most syslog daemons
  6001. do not accept remote log messages because of the security implications.
  6002. You may be able to use the LocalSyslogAppender to talk to a local
  6003. syslog service.
  6004. </para>
  6005. <para>
  6006. There is an RFC 3164 that claims to document the BSD Syslog Protocol.
  6007. This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html.
  6008. This appender generates what the RFC calls an "Original Device Message",
  6009. i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation
  6010. this format of message will be accepted by all current syslog daemon
  6011. implementations. The daemon will attach the current time and the source
  6012. hostname or IP address to any messages received.
  6013. </para>
  6014. <para>
  6015. Syslog messages must have a facility and and a severity. The severity
  6016. is derived from the Level of the logging event.
  6017. The facility must be chosen from the set of defined syslog
  6018. <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  6019. and cannot be extended.
  6020. </para>
  6021. <para>
  6022. An identifier is specified with each log message. This can be specified
  6023. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  6024. as the tag) must not contain white space. The default value for the
  6025. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  6026. </para>
  6027. </remarks>
  6028. <author>Rob Lyon</author>
  6029. <author>Nicko Cadell</author>
  6030. </member>
  6031. <member name="T:log4net.Appender.UdpAppender">
  6032. <summary>
  6033. Sends logging events as connectionless UDP datagrams to a remote host or a
  6034. multicast group using an <see cref="T:System.Net.Sockets.UdpClient"/>.
  6035. </summary>
  6036. <remarks>
  6037. <para>
  6038. UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
  6039. </para>
  6040. <para>
  6041. To view the logging results, a custom application can be developed that listens for logging
  6042. events.
  6043. </para>
  6044. <para>
  6045. When decoding events send via this appender remember to use the same encoding
  6046. to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
  6047. property to specify the encoding to use.
  6048. </para>
  6049. </remarks>
  6050. <example>
  6051. This example shows how to log receive logging events that are sent
  6052. on IP address 244.0.0.1 and port 8080 to the console. The event is
  6053. encoded in the packet as a unicode string and it is decoded as such.
  6054. <code lang="C#">
  6055. IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
  6056. UdpClient udpClient;
  6057. byte[] buffer;
  6058. string loggingEvent;
  6059. try
  6060. {
  6061. udpClient = new UdpClient(8080);
  6062. while(true)
  6063. {
  6064. buffer = udpClient.Receive(ref remoteEndPoint);
  6065. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
  6066. Console.WriteLine(loggingEvent);
  6067. }
  6068. }
  6069. catch(Exception e)
  6070. {
  6071. Console.WriteLine(e.ToString());
  6072. }
  6073. </code>
  6074. <code lang="Visual Basic">
  6075. Dim remoteEndPoint as IPEndPoint
  6076. Dim udpClient as UdpClient
  6077. Dim buffer as Byte()
  6078. Dim loggingEvent as String
  6079. Try
  6080. remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
  6081. udpClient = new UdpClient(8080)
  6082. While True
  6083. buffer = udpClient.Receive(ByRef remoteEndPoint)
  6084. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
  6085. Console.WriteLine(loggingEvent)
  6086. Wend
  6087. Catch e As Exception
  6088. Console.WriteLine(e.ToString())
  6089. End Try
  6090. </code>
  6091. <para>
  6092. An example configuration section to log information using this appender to the
  6093. IP 224.0.0.1 on port 8080:
  6094. </para>
  6095. <code lang="XML" escaped="true">
  6096. <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
  6097. <remoteAddress value="224.0.0.1"/>
  6098. <remotePort value="8080"/>
  6099. <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline"/>
  6100. </appender>
  6101. </code>
  6102. </example>
  6103. <author>Gert Driesen</author>
  6104. <author>Nicko Cadell</author>
  6105. </member>
  6106. <member name="M:log4net.Appender.UdpAppender.#ctor">
  6107. <summary>
  6108. Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender"/> class.
  6109. </summary>
  6110. <remarks>
  6111. The default constructor initializes all fields to their default values.
  6112. </remarks>
  6113. </member>
  6114. <member name="M:log4net.Appender.UdpAppender.ActivateOptions">
  6115. <summary>
  6116. Initialize the appender based on the options set.
  6117. </summary>
  6118. <remarks>
  6119. <para>
  6120. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6121. activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must
  6122. be called on this object after the configuration properties have
  6123. been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this
  6124. object is in an undefined state and must not be used.
  6125. </para>
  6126. <para>
  6127. If any of the configuration properties are modified then
  6128. <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again.
  6129. </para>
  6130. <para>
  6131. The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was specified or
  6132. an invalid remote or local TCP port number was specified.
  6133. </para>
  6134. </remarks>
  6135. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was not specified.</exception>
  6136. <exception cref="T:System.ArgumentOutOfRangeException">The TCP port number assigned to <see cref="P:log4net.Appender.UdpAppender.LocalPort"/> or <see cref="P:log4net.Appender.UdpAppender.RemotePort"/> is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
  6137. </member>
  6138. <member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)">
  6139. <summary>
  6140. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  6141. </summary>
  6142. <param name="loggingEvent">The event to log.</param>
  6143. <remarks>
  6144. <para>
  6145. Sends the event using an UDP datagram.
  6146. </para>
  6147. <para>
  6148. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  6149. </para>
  6150. </remarks>
  6151. </member>
  6152. <member name="M:log4net.Appender.UdpAppender.OnClose">
  6153. <summary>
  6154. Closes the UDP connection and releases all resources associated with
  6155. this <see cref="T:log4net.Appender.UdpAppender"/> instance.
  6156. </summary>
  6157. <remarks>
  6158. <para>
  6159. Disables the underlying <see cref="T:System.Net.Sockets.UdpClient"/> and releases all managed
  6160. and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender"/>.
  6161. </para>
  6162. </remarks>
  6163. </member>
  6164. <member name="M:log4net.Appender.UdpAppender.InitializeClientConnection">
  6165. <summary>
  6166. Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient"/> connection.
  6167. </summary>
  6168. <remarks>
  6169. <para>
  6170. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the
  6171. port number from which you intend to communicate.
  6172. </para>
  6173. <para>
  6174. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  6175. </para>
  6176. </remarks>
  6177. </member>
  6178. <member name="F:log4net.Appender.UdpAppender.m_remoteAddress">
  6179. <summary>
  6180. The IP address of the remote host or multicast group to which
  6181. the logging event will be sent.
  6182. </summary>
  6183. </member>
  6184. <member name="F:log4net.Appender.UdpAppender.m_remotePort">
  6185. <summary>
  6186. The TCP port number of the remote host or multicast group to
  6187. which the logging event will be sent.
  6188. </summary>
  6189. </member>
  6190. <member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint">
  6191. <summary>
  6192. The cached remote endpoint to which the logging events will be sent.
  6193. </summary>
  6194. </member>
  6195. <member name="F:log4net.Appender.UdpAppender.m_localPort">
  6196. <summary>
  6197. The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  6198. </summary>
  6199. </member>
  6200. <member name="F:log4net.Appender.UdpAppender.m_client">
  6201. <summary>
  6202. The <see cref="T:System.Net.Sockets.UdpClient"/> instance that will be used for sending the
  6203. logging events.
  6204. </summary>
  6205. </member>
  6206. <member name="F:log4net.Appender.UdpAppender.m_encoding">
  6207. <summary>
  6208. The encoding to use for the packet.
  6209. </summary>
  6210. </member>
  6211. <member name="P:log4net.Appender.UdpAppender.RemoteAddress">
  6212. <summary>
  6213. Gets or sets the IP address of the remote host or multicast group to which
  6214. the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
  6215. </summary>
  6216. <value>
  6217. The IP address of the remote host or multicast group to which the logging event
  6218. will be sent.
  6219. </value>
  6220. <remarks>
  6221. <para>
  6222. Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to
  6223. 239.255.255.255). Multicast packets can pass across different networks through routers, so
  6224. it is possible to use multicasts in an Internet scenario as long as your network provider
  6225. supports multicasting.
  6226. </para>
  6227. <para>
  6228. Hosts that want to receive particular multicast messages must register their interest by joining
  6229. the multicast group. Multicast messages are not sent to networks where no host has joined
  6230. the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate
  6231. them from normal host addresses, allowing nodes to easily detect if a message is of interest.
  6232. </para>
  6233. <para>
  6234. Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below:
  6235. </para>
  6236. <para>
  6237. <list type="table">
  6238. <listheader>
  6239. <term>IP Address</term>
  6240. <description>Description</description>
  6241. </listheader>
  6242. <item>
  6243. <term>224.0.0.1</term>
  6244. <description>
  6245. <para>
  6246. Sends a message to all system on the subnet.
  6247. </para>
  6248. </description>
  6249. </item>
  6250. <item>
  6251. <term>224.0.0.2</term>
  6252. <description>
  6253. <para>
  6254. Sends a message to all routers on the subnet.
  6255. </para>
  6256. </description>
  6257. </item>
  6258. <item>
  6259. <term>224.0.0.12</term>
  6260. <description>
  6261. <para>
  6262. The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet.
  6263. </para>
  6264. </description>
  6265. </item>
  6266. </list>
  6267. </para>
  6268. <para>
  6269. A complete list of actually reserved multicast addresses and their owners in the ranges
  6270. defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>.
  6271. </para>
  6272. <para>
  6273. The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative
  6274. addresses. These addresses can be reused with other local groups. Routers are typically
  6275. configured with filters to prevent multicast traffic in this range from flowing outside
  6276. of the local network.
  6277. </para>
  6278. </remarks>
  6279. </member>
  6280. <member name="P:log4net.Appender.UdpAppender.RemotePort">
  6281. <summary>
  6282. Gets or sets the TCP port number of the remote host or multicast group to which
  6283. the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
  6284. </summary>
  6285. <value>
  6286. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  6287. indicating the TCP port number of the remote host or multicast group to which the logging event
  6288. will be sent.
  6289. </value>
  6290. <remarks>
  6291. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will send messages to this TCP port number
  6292. on the remote host or multicast group.
  6293. </remarks>
  6294. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
  6295. </member>
  6296. <member name="P:log4net.Appender.UdpAppender.LocalPort">
  6297. <summary>
  6298. Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  6299. </summary>
  6300. <value>
  6301. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  6302. indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  6303. </value>
  6304. <remarks>
  6305. <para>
  6306. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will bind to this port for sending messages.
  6307. </para>
  6308. <para>
  6309. Setting the value to 0 (the default) will cause the udp client not to bind to
  6310. a local port.
  6311. </para>
  6312. </remarks>
  6313. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
  6314. </member>
  6315. <member name="P:log4net.Appender.UdpAppender.Encoding">
  6316. <summary>
  6317. Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6318. </summary>
  6319. <value>
  6320. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6321. </value>
  6322. <remarks>
  6323. <para>
  6324. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6325. </para>
  6326. </remarks>
  6327. </member>
  6328. <member name="P:log4net.Appender.UdpAppender.Client">
  6329. <summary>
  6330. Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
  6331. </summary>
  6332. <value>
  6333. The underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
  6334. </value>
  6335. <remarks>
  6336. <see cref="T:log4net.Appender.UdpAppender"/> creates a <see cref="T:System.Net.Sockets.UdpClient"/> to send logging events
  6337. over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender"/> can use this
  6338. property to get or set this <see cref="T:System.Net.Sockets.UdpClient"/>. Use the underlying <see cref="T:System.Net.Sockets.UdpClient"/>
  6339. returned from <see cref="P:log4net.Appender.UdpAppender.Client"/> if you require access beyond that which
  6340. <see cref="T:log4net.Appender.UdpAppender"/> provides.
  6341. </remarks>
  6342. </member>
  6343. <member name="P:log4net.Appender.UdpAppender.RemoteEndPoint">
  6344. <summary>
  6345. Gets or sets the cached remote endpoint to which the logging events should be sent.
  6346. </summary>
  6347. <value>
  6348. The cached remote endpoint to which the logging events will be sent.
  6349. </value>
  6350. <remarks>
  6351. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method will initialize the remote endpoint
  6352. with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/>
  6353. properties.
  6354. </remarks>
  6355. </member>
  6356. <member name="P:log4net.Appender.UdpAppender.RequiresLayout">
  6357. <summary>
  6358. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6359. </summary>
  6360. <value><c>true</c></value>
  6361. <remarks>
  6362. <para>
  6363. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6364. </para>
  6365. </remarks>
  6366. </member>
  6367. <member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort">
  6368. <summary>
  6369. Syslog port 514
  6370. </summary>
  6371. </member>
  6372. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferSize">
  6373. <summary>
  6374. Initial buffer size
  6375. </summary>
  6376. </member>
  6377. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferMaxCapacity">
  6378. <summary>
  6379. Maximum buffer size before it is recycled
  6380. </summary>
  6381. </member>
  6382. <member name="M:log4net.Appender.RemoteSyslogAppender.#ctor">
  6383. <summary>
  6384. Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class.
  6385. </summary>
  6386. <remarks>
  6387. This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class is set up to write
  6388. to a remote syslog daemon.
  6389. </remarks>
  6390. </member>
  6391. <member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)">
  6392. <summary>
  6393. Add a mapping of level to severity
  6394. </summary>
  6395. <param name="mapping">The mapping to add</param>
  6396. <remarks>
  6397. <para>
  6398. Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender.
  6399. </para>
  6400. </remarks>
  6401. </member>
  6402. <member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)">
  6403. <summary>
  6404. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  6405. </summary>
  6406. <param name="loggingEvent">The event to log.</param>
  6407. <remarks>
  6408. <para>
  6409. Writes the event to a remote syslog daemon.
  6410. </para>
  6411. <para>
  6412. The format of the output will depend on the appender's layout.
  6413. </para>
  6414. </remarks>
  6415. </member>
  6416. <member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions">
  6417. <summary>
  6418. Initialize the options for this appender
  6419. </summary>
  6420. <remarks>
  6421. <para>
  6422. Initialize the level to syslog severity mappings set on this appender.
  6423. </para>
  6424. </remarks>
  6425. </member>
  6426. <member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)">
  6427. <summary>
  6428. Translates a log4net level to a syslog severity.
  6429. </summary>
  6430. <param name="level">A log4net level.</param>
  6431. <returns>A syslog severity.</returns>
  6432. <remarks>
  6433. <para>
  6434. Translates a log4net level to a syslog severity.
  6435. </para>
  6436. </remarks>
  6437. </member>
  6438. <member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)">
  6439. <summary>
  6440. Generate a syslog priority.
  6441. </summary>
  6442. <param name="facility">The syslog facility.</param>
  6443. <param name="severity">The syslog severity.</param>
  6444. <returns>A syslog priority.</returns>
  6445. <remarks>
  6446. <para>
  6447. Generate a syslog priority.
  6448. </para>
  6449. </remarks>
  6450. </member>
  6451. <member name="F:log4net.Appender.RemoteSyslogAppender.m_facility">
  6452. <summary>
  6453. The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  6454. </summary>
  6455. </member>
  6456. <member name="F:log4net.Appender.RemoteSyslogAppender.m_identity">
  6457. <summary>
  6458. The message identity
  6459. </summary>
  6460. </member>
  6461. <member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping">
  6462. <summary>
  6463. Mapping from level object to syslog severity
  6464. </summary>
  6465. </member>
  6466. <member name="P:log4net.Appender.RemoteSyslogAppender.Identity">
  6467. <summary>
  6468. Message identity
  6469. </summary>
  6470. <remarks>
  6471. <para>
  6472. An identifier is specified with each log message. This can be specified
  6473. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  6474. as the tag) must not contain white space. The default value for the
  6475. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  6476. </para>
  6477. </remarks>
  6478. </member>
  6479. <member name="P:log4net.Appender.RemoteSyslogAppender.Facility">
  6480. <summary>
  6481. Syslog facility
  6482. </summary>
  6483. <remarks>
  6484. Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of
  6485. facilities is predefined and cannot be extended. The default value
  6486. is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  6487. </remarks>
  6488. </member>
  6489. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity">
  6490. <summary>
  6491. syslog severities
  6492. </summary>
  6493. <remarks>
  6494. <para>
  6495. The syslog severities.
  6496. </para>
  6497. </remarks>
  6498. </member>
  6499. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency">
  6500. <summary>
  6501. system is unusable
  6502. </summary>
  6503. </member>
  6504. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert">
  6505. <summary>
  6506. action must be taken immediately
  6507. </summary>
  6508. </member>
  6509. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical">
  6510. <summary>
  6511. critical conditions
  6512. </summary>
  6513. </member>
  6514. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error">
  6515. <summary>
  6516. error conditions
  6517. </summary>
  6518. </member>
  6519. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning">
  6520. <summary>
  6521. warning conditions
  6522. </summary>
  6523. </member>
  6524. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice">
  6525. <summary>
  6526. normal but significant condition
  6527. </summary>
  6528. </member>
  6529. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational">
  6530. <summary>
  6531. informational
  6532. </summary>
  6533. </member>
  6534. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug">
  6535. <summary>
  6536. debug-level messages
  6537. </summary>
  6538. </member>
  6539. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility">
  6540. <summary>
  6541. syslog facilities
  6542. </summary>
  6543. <remarks>
  6544. <para>
  6545. The syslog facilities
  6546. </para>
  6547. </remarks>
  6548. </member>
  6549. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel">
  6550. <summary>
  6551. kernel messages
  6552. </summary>
  6553. </member>
  6554. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User">
  6555. <summary>
  6556. random user-level messages
  6557. </summary>
  6558. </member>
  6559. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail">
  6560. <summary>
  6561. mail system
  6562. </summary>
  6563. </member>
  6564. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons">
  6565. <summary>
  6566. system daemons
  6567. </summary>
  6568. </member>
  6569. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization">
  6570. <summary>
  6571. security/authorization messages
  6572. </summary>
  6573. </member>
  6574. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog">
  6575. <summary>
  6576. messages generated internally by syslogd
  6577. </summary>
  6578. </member>
  6579. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer">
  6580. <summary>
  6581. line printer subsystem
  6582. </summary>
  6583. </member>
  6584. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News">
  6585. <summary>
  6586. network news subsystem
  6587. </summary>
  6588. </member>
  6589. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp">
  6590. <summary>
  6591. UUCP subsystem
  6592. </summary>
  6593. </member>
  6594. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock">
  6595. <summary>
  6596. clock (cron/at) daemon
  6597. </summary>
  6598. </member>
  6599. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2">
  6600. <summary>
  6601. security/authorization messages (private)
  6602. </summary>
  6603. </member>
  6604. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp">
  6605. <summary>
  6606. ftp daemon
  6607. </summary>
  6608. </member>
  6609. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp">
  6610. <summary>
  6611. NTP subsystem
  6612. </summary>
  6613. </member>
  6614. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit">
  6615. <summary>
  6616. log audit
  6617. </summary>
  6618. </member>
  6619. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert">
  6620. <summary>
  6621. log alert
  6622. </summary>
  6623. </member>
  6624. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2">
  6625. <summary>
  6626. clock daemon
  6627. </summary>
  6628. </member>
  6629. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0">
  6630. <summary>
  6631. reserved for local use
  6632. </summary>
  6633. </member>
  6634. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1">
  6635. <summary>
  6636. reserved for local use
  6637. </summary>
  6638. </member>
  6639. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2">
  6640. <summary>
  6641. reserved for local use
  6642. </summary>
  6643. </member>
  6644. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3">
  6645. <summary>
  6646. reserved for local use
  6647. </summary>
  6648. </member>
  6649. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4">
  6650. <summary>
  6651. reserved for local use
  6652. </summary>
  6653. </member>
  6654. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5">
  6655. <summary>
  6656. reserved for local use
  6657. </summary>
  6658. </member>
  6659. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6">
  6660. <summary>
  6661. reserved for local use
  6662. </summary>
  6663. </member>
  6664. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7">
  6665. <summary>
  6666. reserved for local use
  6667. </summary>
  6668. </member>
  6669. <member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity">
  6670. <summary>
  6671. A class to act as a mapping between the level that a logging call is made at and
  6672. the syslog severity that is should be logged at.
  6673. </summary>
  6674. <remarks>
  6675. <para>
  6676. A class to act as a mapping between the level that a logging call is made at and
  6677. the syslog severity that is should be logged at.
  6678. </para>
  6679. </remarks>
  6680. </member>
  6681. <member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity">
  6682. <summary>
  6683. The mapped syslog severity for the specified level
  6684. </summary>
  6685. <remarks>
  6686. <para>
  6687. Required property.
  6688. The mapped syslog severity for the specified level
  6689. </para>
  6690. </remarks>
  6691. </member>
  6692. <member name="T:log4net.Appender.RemotingAppender">
  6693. <summary>
  6694. Delivers logging events to a remote logging sink.
  6695. </summary>
  6696. <remarks>
  6697. <para>
  6698. This Appender is designed to deliver events to a remote sink.
  6699. That is any object that implements the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6700. interface. It delivers the events using .NET remoting. The
  6701. object to deliver events to is specified by setting the
  6702. appenders <see cref="P:log4net.Appender.RemotingAppender.Sink"/> property.</para>
  6703. <para>
  6704. The RemotingAppender buffers events before sending them. This allows it to
  6705. make more efficient use of the remoting infrastructure.</para>
  6706. <para>
  6707. Once the buffer is full the events are still not sent immediately.
  6708. They are scheduled to be sent using a pool thread. The effect is that
  6709. the send occurs asynchronously. This is very important for a
  6710. number of non obvious reasons. The remoting infrastructure will
  6711. flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  6712. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  6713. remoting boundary. If the server is not contactable then
  6714. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  6715. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  6716. having side effects on the calling application the remoting call must be made
  6717. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  6718. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  6719. the events will block in the thread pool manager until a thread is available.</para>
  6720. <para>
  6721. Because the events are sent asynchronously using pool threads it is possible to close
  6722. this appender before all the queued events have been sent.
  6723. When closing the appender attempts to wait until all the queued events have been sent, but
  6724. this will timeout after 30 seconds regardless.</para>
  6725. <para>
  6726. If this appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
  6727. event has fired it may not be possible to send all the queued events. During process
  6728. exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
  6729. event handler is allowed to run for. If the runtime terminates the threads before
  6730. the queued events have been sent then they will be lost. To ensure that all events
  6731. are sent the appender must be closed before the application exits. See
  6732. <see cref="M:log4net.Core.LoggerManager.Shutdown"/> for details on how to shutdown
  6733. log4net programmatically.</para>
  6734. </remarks>
  6735. <seealso cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6736. <author>Nicko Cadell</author>
  6737. <author>Gert Driesen</author>
  6738. <author>Daniel Cazzulino</author>
  6739. </member>
  6740. <member name="M:log4net.Appender.RemotingAppender.#ctor">
  6741. <summary>
  6742. Initializes a new instance of the <see cref="T:log4net.Appender.RemotingAppender"/> class.
  6743. </summary>
  6744. <remarks>
  6745. <para>
  6746. Default constructor.
  6747. </para>
  6748. </remarks>
  6749. </member>
  6750. <member name="M:log4net.Appender.RemotingAppender.ActivateOptions">
  6751. <summary>
  6752. Initialize the appender based on the options set
  6753. </summary>
  6754. <remarks>
  6755. <para>
  6756. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6757. activation scheme. The <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> method must
  6758. be called on this object after the configuration properties have
  6759. been set. Until <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> is called this
  6760. object is in an undefined state and must not be used.
  6761. </para>
  6762. <para>
  6763. If any of the configuration properties are modified then
  6764. <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> must be called again.
  6765. </para>
  6766. </remarks>
  6767. </member>
  6768. <member name="M:log4net.Appender.RemotingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  6769. <summary>
  6770. Send the contents of the buffer to the remote sink.
  6771. </summary>
  6772. <remarks>
  6773. The events are not sent immediately. They are scheduled to be sent
  6774. using a pool thread. The effect is that the send occurs asynchronously.
  6775. This is very important for a number of non obvious reasons. The remoting
  6776. infrastructure will flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  6777. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  6778. remoting boundary. If the server is not contactable then
  6779. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  6780. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  6781. having side effects on the calling application the remoting call must be made
  6782. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  6783. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  6784. the events will block in the thread pool manager until a thread is available.
  6785. </remarks>
  6786. <param name="events">The events to send.</param>
  6787. </member>
  6788. <member name="M:log4net.Appender.RemotingAppender.OnClose">
  6789. <summary>
  6790. Override base class close.
  6791. </summary>
  6792. <remarks>
  6793. <para>
  6794. This method waits while there are queued work items. The events are
  6795. sent asynchronously using <see cref="T:System.Threading.ThreadPool"/> work items. These items
  6796. will be sent once a thread pool thread is available to send them, therefore
  6797. it is possible to close the appender before all the queued events have been
  6798. sent.</para>
  6799. <para>
  6800. This method attempts to wait until all the queued events have been sent, but this
  6801. method will timeout after 30 seconds regardless.</para>
  6802. <para>
  6803. If the appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
  6804. event has fired it may not be possible to send all the queued events. During process
  6805. exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
  6806. event handler is allowed to run for.</para>
  6807. </remarks>
  6808. </member>
  6809. <member name="M:log4net.Appender.RemotingAppender.Flush(System.Int32)">
  6810. <summary>
  6811. Flushes any buffered log data.
  6812. </summary>
  6813. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  6814. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  6815. </member>
  6816. <member name="M:log4net.Appender.RemotingAppender.BeginAsyncSend">
  6817. <summary>
  6818. A work item is being queued into the thread pool
  6819. </summary>
  6820. </member>
  6821. <member name="M:log4net.Appender.RemotingAppender.EndAsyncSend">
  6822. <summary>
  6823. A work item from the thread pool has completed
  6824. </summary>
  6825. </member>
  6826. <member name="M:log4net.Appender.RemotingAppender.SendBufferCallback(System.Object)">
  6827. <summary>
  6828. Send the contents of the buffer to the remote sink.
  6829. </summary>
  6830. <remarks>
  6831. This method is designed to be used with the <see cref="T:System.Threading.ThreadPool"/>.
  6832. This method expects to be passed an array of <see cref="T:log4net.Core.LoggingEvent"/>
  6833. objects in the state param.
  6834. </remarks>
  6835. <param name="state">the logging events to send</param>
  6836. </member>
  6837. <member name="F:log4net.Appender.RemotingAppender.m_sinkUrl">
  6838. <summary>
  6839. The URL of the remote sink.
  6840. </summary>
  6841. </member>
  6842. <member name="F:log4net.Appender.RemotingAppender.m_sinkObj">
  6843. <summary>
  6844. The local proxy (.NET remoting) for the remote logging sink.
  6845. </summary>
  6846. </member>
  6847. <member name="F:log4net.Appender.RemotingAppender.m_queuedCallbackCount">
  6848. <summary>
  6849. The number of queued callbacks currently waiting or executing
  6850. </summary>
  6851. </member>
  6852. <member name="F:log4net.Appender.RemotingAppender.m_workQueueEmptyEvent">
  6853. <summary>
  6854. Event used to signal when there are no queued work items
  6855. </summary>
  6856. <remarks>
  6857. This event is set when there are no queued work items. In this
  6858. state it is safe to close the appender.
  6859. </remarks>
  6860. </member>
  6861. <member name="P:log4net.Appender.RemotingAppender.Sink">
  6862. <summary>
  6863. Gets or sets the URL of the well-known object that will accept
  6864. the logging events.
  6865. </summary>
  6866. <value>
  6867. The well-known URL of the remote sink.
  6868. </value>
  6869. <remarks>
  6870. <para>
  6871. The URL of the remoting sink that will accept logging events.
  6872. The sink must implement the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6873. interface.
  6874. </para>
  6875. </remarks>
  6876. </member>
  6877. <member name="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink">
  6878. <summary>
  6879. Interface used to deliver <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
  6880. </summary>
  6881. <remarks>
  6882. This interface must be implemented by a remoting sink
  6883. if the <see cref="T:log4net.Appender.RemotingAppender"/> is to be used
  6884. to deliver logging events to the sink.
  6885. </remarks>
  6886. </member>
  6887. <member name="M:log4net.Appender.RemotingAppender.IRemoteLoggingSink.LogEvents(log4net.Core.LoggingEvent[])">
  6888. <summary>
  6889. Delivers logging events to the remote sink
  6890. </summary>
  6891. <param name="events">Array of events to log.</param>
  6892. <remarks>
  6893. <para>
  6894. Delivers logging events to the remote sink
  6895. </para>
  6896. </remarks>
  6897. </member>
  6898. <member name="T:log4net.Appender.RollingFileAppender">
  6899. <summary>
  6900. Appender that rolls log files based on size or date or both.
  6901. </summary>
  6902. <remarks>
  6903. <para>
  6904. RollingFileAppender can roll log files based on size or date or both
  6905. depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property.
  6906. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled
  6907. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  6908. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled
  6909. once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  6910. is crossed.
  6911. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be
  6912. rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  6913. is crossed, but within a date boundary the file will also be rolled
  6914. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  6915. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when
  6916. the appender is configured. This effectively means that the log file can be
  6917. rolled once per program execution.
  6918. </para>
  6919. <para>
  6920. A of few additional optional features have been added:
  6921. <list type="bullet">
  6922. <item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item>
  6923. <item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item>
  6924. <item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item>
  6925. </list>
  6926. </para>
  6927. <note>
  6928. <para>
  6929. For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/>
  6930. greater than zero is highly recommended, otherwise all the backup files need
  6931. to be renamed each time a new backup is created.
  6932. </para>
  6933. <para>
  6934. When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  6935. to <see langword="true"/> will reduce the number of file renamings to few or none.
  6936. </para>
  6937. </note>
  6938. <note type="caution">
  6939. <para>
  6940. Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing
  6941. the log file directory of backup files will cause unexpected and unwanted side effects.
  6942. </para>
  6943. </note>
  6944. <para>
  6945. If Date/Time based rolling is enabled this appender will attempt to roll existing files
  6946. in the directory without a Date/Time tag based on the last write date of the base log file.
  6947. The appender only rolls the log file when a message is logged. If Date/Time based rolling
  6948. is enabled then the appender will not roll the log file at the Date/Time boundary but
  6949. at the point when the next message is logged after the boundary has been crossed.
  6950. </para>
  6951. <para>
  6952. The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and
  6953. has the same behavior when opening the log file.
  6954. The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>
  6955. is called. This will typically be during configuration.
  6956. If the file cannot be opened for writing the appender will attempt
  6957. to open the file again each time a message is logged to the appender.
  6958. If the file cannot be opened for writing when a message is logged then
  6959. the message will be discarded by this appender.
  6960. </para>
  6961. <para>
  6962. When rolling a backup file necessitates deleting an older backup file the
  6963. file to be deleted is moved to a temporary name before being deleted.
  6964. </para>
  6965. <note type="caution">
  6966. <para>
  6967. A maximum number of backup files when rolling on date/time boundaries is not supported.
  6968. </para>
  6969. </note>
  6970. </remarks>
  6971. <author>Nicko Cadell</author>
  6972. <author>Gert Driesen</author>
  6973. <author>Aspi Havewala</author>
  6974. <author>Douglas de la Torre</author>
  6975. <author>Edward Smit</author>
  6976. </member>
  6977. <member name="M:log4net.Appender.RollingFileAppender.#ctor">
  6978. <summary>
  6979. Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender"/> class.
  6980. </summary>
  6981. <remarks>
  6982. <para>
  6983. Default constructor.
  6984. </para>
  6985. </remarks>
  6986. </member>
  6987. <member name="M:log4net.Appender.RollingFileAppender.Finalize">
  6988. <summary>
  6989. Cleans up all resources used by this appender.
  6990. </summary>
  6991. </member>
  6992. <member name="F:log4net.Appender.RollingFileAppender.declaringType">
  6993. <summary>
  6994. The fully qualified type of the RollingFileAppender class.
  6995. </summary>
  6996. <remarks>
  6997. Used by the internal logger to record the Type of the
  6998. log message.
  6999. </remarks>
  7000. </member>
  7001. <member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)">
  7002. <summary>
  7003. Sets the quiet writer being used.
  7004. </summary>
  7005. <remarks>
  7006. This method can be overridden by sub classes.
  7007. </remarks>
  7008. <param name="writer">the writer to set</param>
  7009. </member>
  7010. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)">
  7011. <summary>
  7012. Write out a logging event.
  7013. </summary>
  7014. <param name="loggingEvent">the event to write to file.</param>
  7015. <remarks>
  7016. <para>
  7017. Handles append time behavior for RollingFileAppender. This checks
  7018. if a roll over either by date (checked first) or time (checked second)
  7019. is need and then appends to the file last.
  7020. </para>
  7021. </remarks>
  7022. </member>
  7023. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])">
  7024. <summary>
  7025. Write out an array of logging events.
  7026. </summary>
  7027. <param name="loggingEvents">the events to write to file.</param>
  7028. <remarks>
  7029. <para>
  7030. Handles append time behavior for RollingFileAppender. This checks
  7031. if a roll over either by date (checked first) or time (checked second)
  7032. is need and then appends to the file last.
  7033. </para>
  7034. </remarks>
  7035. </member>
  7036. <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend">
  7037. <summary>
  7038. Performs any required rolling before outputting the next event
  7039. </summary>
  7040. <remarks>
  7041. <para>
  7042. Handles append time behavior for RollingFileAppender. This checks
  7043. if a roll over either by date (checked first) or time (checked second)
  7044. is need and then appends to the file last.
  7045. </para>
  7046. </remarks>
  7047. </member>
  7048. <member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)">
  7049. <summary>
  7050. Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  7051. is false then the fully qualified name is determined and used.
  7052. </summary>
  7053. <param name="fileName">the name of the file to open</param>
  7054. <param name="append">true to append to existing file</param>
  7055. <remarks>
  7056. <para>This method will ensure that the directory structure
  7057. for the <paramref name="fileName"/> specified exists.</para>
  7058. </remarks>
  7059. </member>
  7060. <member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)">
  7061. <summary>
  7062. Get the current output file name
  7063. </summary>
  7064. <param name="fileName">the base file name</param>
  7065. <returns>the output file name</returns>
  7066. <remarks>
  7067. The output file name is based on the base fileName specified.
  7068. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output
  7069. file name is the same as the base file passed in. Otherwise
  7070. the output file depends on the date pattern, on the count
  7071. direction or both.
  7072. </remarks>
  7073. </member>
  7074. <member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups">
  7075. <summary>
  7076. Determines curSizeRollBackups (only within the current roll point)
  7077. </summary>
  7078. </member>
  7079. <member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)">
  7080. <summary>
  7081. Generates a wildcard pattern that can be used to find all files
  7082. that are similar to the base file name.
  7083. </summary>
  7084. <param name="baseFileName"></param>
  7085. <returns></returns>
  7086. </member>
  7087. <member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)">
  7088. <summary>
  7089. Builds a list of filenames for all files matching the base filename plus a file
  7090. pattern.
  7091. </summary>
  7092. <param name="baseFilePath"></param>
  7093. <returns></returns>
  7094. </member>
  7095. <member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing">
  7096. <summary>
  7097. Initiates a roll over if needed for crossing a date boundary since the last run.
  7098. </summary>
  7099. </member>
  7100. <member name="M:log4net.Appender.RollingFileAppender.ExistingInit">
  7101. <summary>
  7102. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  7103. </summary>
  7104. <remarks>
  7105. <para>
  7106. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  7107. The following is done
  7108. <list type="bullet">
  7109. <item>determine curSizeRollBackups (only within the current roll point)</item>
  7110. <item>initiates a roll over if needed for crossing a date boundary since the last run.</item>
  7111. </list>
  7112. </para>
  7113. </remarks>
  7114. </member>
  7115. <member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)">
  7116. <summary>
  7117. Does the work of bumping the 'current' file counter higher
  7118. to the highest count when an incremental file name is seen.
  7119. The highest count is either the first file (when count direction
  7120. is greater than 0) or the last file (when count direction less than 0).
  7121. In either case, we want to know the highest count that is present.
  7122. </summary>
  7123. <param name="baseFile"></param>
  7124. <param name="curFileName"></param>
  7125. </member>
  7126. <member name="M:log4net.Appender.RollingFileAppender.GetBackUpIndex(System.String)">
  7127. <summary>
  7128. Attempts to extract a number from the end of the file name that indicates
  7129. the number of the times the file has been rolled over.
  7130. </summary>
  7131. <remarks>
  7132. Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes.
  7133. </remarks>
  7134. <param name="curFileName"></param>
  7135. <returns></returns>
  7136. </member>
  7137. <member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)">
  7138. <summary>
  7139. Takes a list of files and a base file name, and looks for
  7140. 'incremented' versions of the base file. Bumps the max
  7141. count up to the highest count seen.
  7142. </summary>
  7143. <param name="baseFile"></param>
  7144. <param name="arrayFiles"></param>
  7145. </member>
  7146. <member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)">
  7147. <summary>
  7148. Calculates the RollPoint for the datePattern supplied.
  7149. </summary>
  7150. <param name="datePattern">the date pattern to calculate the check period for</param>
  7151. <returns>The RollPoint that is most accurate for the date pattern supplied</returns>
  7152. <remarks>
  7153. Essentially the date pattern is examined to determine what the
  7154. most suitable roll point is. The roll point chosen is the roll point
  7155. with the smallest period that can be detected using the date pattern
  7156. supplied. i.e. if the date pattern only outputs the year, month, day
  7157. and hour then the smallest roll point that can be detected would be
  7158. and hourly roll point as minutes could not be detected.
  7159. </remarks>
  7160. </member>
  7161. <member name="M:log4net.Appender.RollingFileAppender.ActivateOptions">
  7162. <summary>
  7163. Initialize the appender based on the options set
  7164. </summary>
  7165. <remarks>
  7166. <para>
  7167. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  7168. activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must
  7169. be called on this object after the configuration properties have
  7170. been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this
  7171. object is in an undefined state and must not be used.
  7172. </para>
  7173. <para>
  7174. If any of the configuration properties are modified then
  7175. <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again.
  7176. </para>
  7177. <para>
  7178. Sets initial conditions including date/time roll over information, first check,
  7179. scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize
  7180. the current number of backups.
  7181. </para>
  7182. </remarks>
  7183. </member>
  7184. <member name="M:log4net.Appender.RollingFileAppender.CombinePath(System.String,System.String)">
  7185. <summary>
  7186. </summary>
  7187. <param name="path1"></param>
  7188. <param name="path2">.1, .2, .3, etc.</param>
  7189. <returns></returns>
  7190. </member>
  7191. <member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)">
  7192. <summary>
  7193. Rollover the file(s) to date/time tagged file(s).
  7194. </summary>
  7195. <param name="fileIsOpen">set to true if the file to be rolled is currently open</param>
  7196. <remarks>
  7197. <para>
  7198. Rollover the file(s) to date/time tagged file(s).
  7199. Resets curSizeRollBackups.
  7200. If fileIsOpen is set then the new file is opened (through SafeOpenFile).
  7201. </para>
  7202. </remarks>
  7203. </member>
  7204. <member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)">
  7205. <summary>
  7206. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>.
  7207. </summary>
  7208. <param name="fromFile">Name of existing file to roll.</param>
  7209. <param name="toFile">New name for file.</param>
  7210. <remarks>
  7211. <para>
  7212. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It
  7213. also checks for existence of target file and deletes if it does.
  7214. </para>
  7215. </remarks>
  7216. </member>
  7217. <member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)">
  7218. <summary>
  7219. Test if a file exists at a specified path
  7220. </summary>
  7221. <param name="path">the path to the file</param>
  7222. <returns>true if the file exists</returns>
  7223. <remarks>
  7224. <para>
  7225. Test if a file exists at a specified path
  7226. </para>
  7227. </remarks>
  7228. </member>
  7229. <member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)">
  7230. <summary>
  7231. Deletes the specified file if it exists.
  7232. </summary>
  7233. <param name="fileName">The file to delete.</param>
  7234. <remarks>
  7235. <para>
  7236. Delete a file if is exists.
  7237. The file is first moved to a new filename then deleted.
  7238. This allows the file to be removed even when it cannot
  7239. be deleted, but it still can be moved.
  7240. </para>
  7241. </remarks>
  7242. </member>
  7243. <member name="M:log4net.Appender.RollingFileAppender.RollOverSize">
  7244. <summary>
  7245. Implements file roll base on file size.
  7246. </summary>
  7247. <remarks>
  7248. <para>
  7249. If the maximum number of size based backups is reached
  7250. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  7251. file is deleted -- its index determined by the sign of countDirection.
  7252. If <c>countDirection</c> &lt; 0, then files
  7253. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  7254. are renamed to {<c>File.2</c>, ...,
  7255. <c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is
  7256. renamed <c>File.1</c> and closed.
  7257. </para>
  7258. <para>
  7259. A new file is created to receive further log output.
  7260. </para>
  7261. <para>
  7262. If <c>maxSizeRollBackups</c> is equal to zero, then the
  7263. <c>File</c> is truncated with no backup files created.
  7264. </para>
  7265. <para>
  7266. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  7267. renamed if needed and no files are deleted.
  7268. </para>
  7269. </remarks>
  7270. </member>
  7271. <member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)">
  7272. <summary>
  7273. Implements file roll.
  7274. </summary>
  7275. <param name="baseFileName">the base name to rename</param>
  7276. <remarks>
  7277. <para>
  7278. If the maximum number of size based backups is reached
  7279. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  7280. file is deleted -- its index determined by the sign of countDirection.
  7281. If <c>countDirection</c> &lt; 0, then files
  7282. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  7283. are renamed to {<c>File.2</c>, ...,
  7284. <c>File.curSizeRollBackups</c>}.
  7285. </para>
  7286. <para>
  7287. If <c>maxSizeRollBackups</c> is equal to zero, then the
  7288. <c>File</c> is truncated with no backup files created.
  7289. </para>
  7290. <para>
  7291. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  7292. renamed if needed and no files are deleted.
  7293. </para>
  7294. <para>
  7295. This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files.
  7296. </para>
  7297. </remarks>
  7298. </member>
  7299. <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)">
  7300. <summary>
  7301. Get the start time of the next window for the current rollpoint
  7302. </summary>
  7303. <param name="currentDateTime">the current date</param>
  7304. <param name="rollPoint">the type of roll point we are working with</param>
  7305. <returns>the start time for the next roll point an interval after the currentDateTime date</returns>
  7306. <remarks>
  7307. <para>
  7308. Returns the date of the next roll point after the currentDateTime date passed to the method.
  7309. </para>
  7310. <para>
  7311. The basic strategy is to subtract the time parts that are less significant
  7312. than the rollpoint from the current time. This should roll the time back to
  7313. the start of the time window for the current rollpoint. Then we add 1 window
  7314. worth of time and get the start time of the next window for the rollpoint.
  7315. </para>
  7316. </remarks>
  7317. </member>
  7318. <member name="F:log4net.Appender.RollingFileAppender.m_dateTime">
  7319. <summary>
  7320. This object supplies the current date/time. Allows test code to plug in
  7321. a method to control this class when testing date/time based rolling. The default
  7322. implementation uses the underlying value of DateTime.Now.
  7323. </summary>
  7324. </member>
  7325. <member name="F:log4net.Appender.RollingFileAppender.m_datePattern">
  7326. <summary>
  7327. The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c>
  7328. meaning daily rollover.
  7329. </summary>
  7330. </member>
  7331. <member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename">
  7332. <summary>
  7333. The actual formatted filename that is currently being written to
  7334. or will be the file transferred to on roll over
  7335. (based on staticLogFileName).
  7336. </summary>
  7337. </member>
  7338. <member name="F:log4net.Appender.RollingFileAppender.m_nextCheck">
  7339. <summary>
  7340. The timestamp when we shall next recompute the filename.
  7341. </summary>
  7342. </member>
  7343. <member name="F:log4net.Appender.RollingFileAppender.m_now">
  7344. <summary>
  7345. Holds date of last roll over
  7346. </summary>
  7347. </member>
  7348. <member name="F:log4net.Appender.RollingFileAppender.m_rollPoint">
  7349. <summary>
  7350. The type of rolling done
  7351. </summary>
  7352. </member>
  7353. <member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize">
  7354. <summary>
  7355. The default maximum file size is 10MB
  7356. </summary>
  7357. </member>
  7358. <member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups">
  7359. <summary>
  7360. There is zero backup files by default
  7361. </summary>
  7362. </member>
  7363. <member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups">
  7364. <summary>
  7365. How many sized based backups have been made so far
  7366. </summary>
  7367. </member>
  7368. <member name="F:log4net.Appender.RollingFileAppender.m_countDirection">
  7369. <summary>
  7370. The rolling file count direction.
  7371. </summary>
  7372. </member>
  7373. <member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle">
  7374. <summary>
  7375. The rolling mode used in this appender.
  7376. </summary>
  7377. </member>
  7378. <member name="F:log4net.Appender.RollingFileAppender.m_rollDate">
  7379. <summary>
  7380. Cache flag set if we are rolling by date.
  7381. </summary>
  7382. </member>
  7383. <member name="F:log4net.Appender.RollingFileAppender.m_rollSize">
  7384. <summary>
  7385. Cache flag set if we are rolling by size.
  7386. </summary>
  7387. </member>
  7388. <member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName">
  7389. <summary>
  7390. Value indicating whether to always log to the same file.
  7391. </summary>
  7392. </member>
  7393. <member name="F:log4net.Appender.RollingFileAppender.m_preserveLogFileNameExtension">
  7394. <summary>
  7395. Value indicating whether to preserve the file name extension when rolling.
  7396. </summary>
  7397. </member>
  7398. <member name="F:log4net.Appender.RollingFileAppender.m_baseFileName">
  7399. <summary>
  7400. FileName provided in configuration. Used for rolling properly
  7401. </summary>
  7402. </member>
  7403. <member name="F:log4net.Appender.RollingFileAppender.m_mutexForRolling">
  7404. <summary>
  7405. A mutex that is used to lock rolling of files.
  7406. </summary>
  7407. </member>
  7408. <member name="F:log4net.Appender.RollingFileAppender.s_date1970">
  7409. <summary>
  7410. The 1st of January 1970 in UTC
  7411. </summary>
  7412. </member>
  7413. <member name="P:log4net.Appender.RollingFileAppender.DateTimeStrategy">
  7414. <summary>
  7415. Gets or sets the strategy for determining the current date and time. The default
  7416. implementation is to use LocalDateTime which internally calls through to DateTime.Now.
  7417. DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying
  7418. <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  7419. </summary>
  7420. <value>
  7421. An implementation of the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> interface which returns the current date and time.
  7422. </value>
  7423. <remarks>
  7424. <para>
  7425. Gets or sets the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> used to return the current date and time.
  7426. </para>
  7427. <para>
  7428. There are two built strategies for determining the current date and time,
  7429. <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>
  7430. and <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  7431. </para>
  7432. <para>
  7433. The default strategy is <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>.
  7434. </para>
  7435. </remarks>
  7436. </member>
  7437. <member name="P:log4net.Appender.RollingFileAppender.DatePattern">
  7438. <summary>
  7439. Gets or sets the date pattern to be used for generating file names
  7440. when rolling over on date.
  7441. </summary>
  7442. <value>
  7443. The date pattern to be used for generating file names when rolling
  7444. over on date.
  7445. </value>
  7446. <remarks>
  7447. <para>
  7448. Takes a string in the same format as expected by
  7449. <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/>.
  7450. </para>
  7451. <para>
  7452. This property determines the rollover schedule when rolling over
  7453. on date.
  7454. </para>
  7455. </remarks>
  7456. </member>
  7457. <member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups">
  7458. <summary>
  7459. Gets or sets the maximum number of backup files that are kept before
  7460. the oldest is erased.
  7461. </summary>
  7462. <value>
  7463. The maximum number of backup files that are kept before the oldest is
  7464. erased.
  7465. </value>
  7466. <remarks>
  7467. <para>
  7468. If set to zero, then there will be no backup files and the log file
  7469. will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>.
  7470. </para>
  7471. <para>
  7472. If a negative number is supplied then no deletions will be made. Note
  7473. that this could result in very slow performance as a large number of
  7474. files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used.
  7475. </para>
  7476. <para>
  7477. The maximum applies to <b>each</b> time based group of files and
  7478. <b>not</b> the total.
  7479. </para>
  7480. </remarks>
  7481. </member>
  7482. <member name="P:log4net.Appender.RollingFileAppender.MaxFileSize">
  7483. <summary>
  7484. Gets or sets the maximum size that the output file is allowed to reach
  7485. before being rolled over to backup files.
  7486. </summary>
  7487. <value>
  7488. The maximum size in bytes that the output file is allowed to reach before being
  7489. rolled over to backup files.
  7490. </value>
  7491. <remarks>
  7492. <para>
  7493. This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except
  7494. that it is required for differentiating the setter taking a
  7495. <see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/>
  7496. argument.
  7497. </para>
  7498. <para>
  7499. The default maximum file size is 10MB (10*1024*1024).
  7500. </para>
  7501. </remarks>
  7502. </member>
  7503. <member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize">
  7504. <summary>
  7505. Gets or sets the maximum size that the output file is allowed to reach
  7506. before being rolled over to backup files.
  7507. </summary>
  7508. <value>
  7509. The maximum size that the output file is allowed to reach before being
  7510. rolled over to backup files.
  7511. </value>
  7512. <remarks>
  7513. <para>
  7514. This property allows you to specify the maximum size with the
  7515. suffixes "KB", "MB" or "GB" so that the size is interpreted being
  7516. expressed respectively in kilobytes, megabytes or gigabytes.
  7517. </para>
  7518. <para>
  7519. For example, the value "10KB" will be interpreted as 10240 bytes.
  7520. </para>
  7521. <para>
  7522. The default maximum file size is 10MB.
  7523. </para>
  7524. <para>
  7525. If you have the option to set the maximum file size programmatically
  7526. consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this
  7527. allows you to set the size in bytes as a <see cref="T:System.Int64"/>.
  7528. </para>
  7529. </remarks>
  7530. </member>
  7531. <member name="P:log4net.Appender.RollingFileAppender.CountDirection">
  7532. <summary>
  7533. Gets or sets the rolling file count direction.
  7534. </summary>
  7535. <value>
  7536. The rolling file count direction.
  7537. </value>
  7538. <remarks>
  7539. <para>
  7540. Indicates if the current file is the lowest numbered file or the
  7541. highest numbered file.
  7542. </para>
  7543. <para>
  7544. By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &lt; 0),
  7545. i.e. log.1 is most recent, log.5 is the 5th backup, etc...
  7546. </para>
  7547. <para>
  7548. <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &gt;= 0 does the opposite i.e.
  7549. log.1 is the first backup made, log.5 is the 5th backup made, etc.
  7550. For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &gt;= 0 to reduce
  7551. rollover costs.
  7552. </para>
  7553. <para>The default file count direction is -1.</para>
  7554. </remarks>
  7555. </member>
  7556. <member name="P:log4net.Appender.RollingFileAppender.RollingStyle">
  7557. <summary>
  7558. Gets or sets the rolling style.
  7559. </summary>
  7560. <value>The rolling style.</value>
  7561. <remarks>
  7562. <para>
  7563. The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/>.
  7564. </para>
  7565. <para>
  7566. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's
  7567. <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise
  7568. the appender would append to a single file rather than rolling
  7569. the file each time it is opened.
  7570. </para>
  7571. </remarks>
  7572. </member>
  7573. <member name="P:log4net.Appender.RollingFileAppender.PreserveLogFileNameExtension">
  7574. <summary>
  7575. Gets or sets a value indicating whether to preserve the file name extension when rolling.
  7576. </summary>
  7577. <value>
  7578. <c>true</c> if the file name extension should be preserved.
  7579. </value>
  7580. <remarks>
  7581. <para>
  7582. By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup.
  7583. However, under Windows the new file name will loose any program associations as the
  7584. extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or
  7585. file.curSizeRollBackup.log to maintain any program associations.
  7586. </para>
  7587. </remarks>
  7588. </member>
  7589. <member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName">
  7590. <summary>
  7591. Gets or sets a value indicating whether to always log to
  7592. the same file.
  7593. </summary>
  7594. <value>
  7595. <c>true</c> if always should be logged to the same file, otherwise <c>false</c>.
  7596. </value>
  7597. <remarks>
  7598. <para>
  7599. By default file.log is always the current file. Optionally
  7600. file.log.yyyy-mm-dd for current formatted datePattern can by the currently
  7601. logging file (or file.log.curSizeRollBackup or even
  7602. file.log.yyyy-mm-dd.curSizeRollBackup).
  7603. </para>
  7604. <para>
  7605. This will make time based rollovers with a large number of backups
  7606. much faster as the appender it won't have to rename all the backups!
  7607. </para>
  7608. </remarks>
  7609. </member>
  7610. <member name="T:log4net.Appender.RollingFileAppender.RollingMode">
  7611. <summary>
  7612. Style of rolling to use
  7613. </summary>
  7614. <remarks>
  7615. <para>
  7616. Style of rolling to use
  7617. </para>
  7618. </remarks>
  7619. </member>
  7620. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once">
  7621. <summary>
  7622. Roll files once per program execution
  7623. </summary>
  7624. <remarks>
  7625. <para>
  7626. Roll files once per program execution.
  7627. Well really once each time this appender is
  7628. configured.
  7629. </para>
  7630. <para>
  7631. Setting this option also sets <c>AppendToFile</c> to
  7632. <c>false</c> on the <c>RollingFileAppender</c>, otherwise
  7633. this appender would just be a normal file appender.
  7634. </para>
  7635. </remarks>
  7636. </member>
  7637. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size">
  7638. <summary>
  7639. Roll files based only on the size of the file
  7640. </summary>
  7641. </member>
  7642. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date">
  7643. <summary>
  7644. Roll files based only on the date
  7645. </summary>
  7646. </member>
  7647. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite">
  7648. <summary>
  7649. Roll files based on both the size and date of the file
  7650. </summary>
  7651. </member>
  7652. <member name="T:log4net.Appender.RollingFileAppender.RollPoint">
  7653. <summary>
  7654. The code assumes that the following 'time' constants are in a increasing sequence.
  7655. </summary>
  7656. <remarks>
  7657. <para>
  7658. The code assumes that the following 'time' constants are in a increasing sequence.
  7659. </para>
  7660. </remarks>
  7661. </member>
  7662. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint">
  7663. <summary>
  7664. Roll the log not based on the date
  7665. </summary>
  7666. </member>
  7667. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute">
  7668. <summary>
  7669. Roll the log for each minute
  7670. </summary>
  7671. </member>
  7672. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour">
  7673. <summary>
  7674. Roll the log for each hour
  7675. </summary>
  7676. </member>
  7677. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay">
  7678. <summary>
  7679. Roll the log twice a day (midday and midnight)
  7680. </summary>
  7681. </member>
  7682. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay">
  7683. <summary>
  7684. Roll the log each day (midnight)
  7685. </summary>
  7686. </member>
  7687. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek">
  7688. <summary>
  7689. Roll the log each week
  7690. </summary>
  7691. </member>
  7692. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth">
  7693. <summary>
  7694. Roll the log each month
  7695. </summary>
  7696. </member>
  7697. <member name="T:log4net.Appender.RollingFileAppender.IDateTime">
  7698. <summary>
  7699. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  7700. </summary>
  7701. <remarks>
  7702. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  7703. Used primarily to allow test classes to plug themselves in so they can
  7704. supply test date/times.
  7705. </remarks>
  7706. </member>
  7707. <member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now">
  7708. <summary>
  7709. Gets the <i>current</i> time.
  7710. </summary>
  7711. <value>The <i>current</i> time.</value>
  7712. <remarks>
  7713. <para>
  7714. Gets the <i>current</i> time.
  7715. </para>
  7716. </remarks>
  7717. </member>
  7718. <member name="T:log4net.Appender.RollingFileAppender.LocalDateTime">
  7719. <summary>
  7720. Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time.
  7721. </summary>
  7722. </member>
  7723. <member name="P:log4net.Appender.RollingFileAppender.LocalDateTime.Now">
  7724. <summary>
  7725. Gets the <b>current</b> time.
  7726. </summary>
  7727. <value>The <b>current</b> time.</value>
  7728. <remarks>
  7729. <para>
  7730. Gets the <b>current</b> time.
  7731. </para>
  7732. </remarks>
  7733. </member>
  7734. <member name="T:log4net.Appender.RollingFileAppender.UniversalDateTime">
  7735. <summary>
  7736. Implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time as the coordinated universal time (UTC).
  7737. </summary>
  7738. </member>
  7739. <member name="P:log4net.Appender.RollingFileAppender.UniversalDateTime.Now">
  7740. <summary>
  7741. Gets the <b>current</b> time.
  7742. </summary>
  7743. <value>The <b>current</b> time.</value>
  7744. <remarks>
  7745. <para>
  7746. Gets the <b>current</b> time.
  7747. </para>
  7748. </remarks>
  7749. </member>
  7750. <member name="T:log4net.Appender.SmtpAppender">
  7751. <summary>
  7752. Send an e-mail when a specific logging event occurs, typically on errors
  7753. or fatal errors.
  7754. </summary>
  7755. <remarks>
  7756. <para>
  7757. The number of logging events delivered in this e-mail depend on
  7758. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  7759. <see cref="T:log4net.Appender.SmtpAppender"/> keeps only the last
  7760. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  7761. cyclic buffer. This keeps memory requirements at a reasonable level while
  7762. still delivering useful application context.
  7763. </para>
  7764. <note type="caution">
  7765. Authentication and setting the server Port are only available on the MS .NET 1.1 runtime.
  7766. For these features to be enabled you need to ensure that you are using a version of
  7767. the log4net assembly that is built against the MS .NET 1.1 framework and that you are
  7768. running the your application on the MS .NET 1.1 runtime. On all other platforms only sending
  7769. unauthenticated messages to a server listening on port 25 (the default) is supported.
  7770. </note>
  7771. <para>
  7772. Authentication is supported by setting the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property to
  7773. either <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> or <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  7774. If using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> authentication then the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  7775. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> properties must also be set.
  7776. </para>
  7777. <para>
  7778. To set the SMTP server port use the <see cref="P:log4net.Appender.SmtpAppender.Port"/> property. The default port is 25.
  7779. </para>
  7780. </remarks>
  7781. <author>Nicko Cadell</author>
  7782. <author>Gert Driesen</author>
  7783. </member>
  7784. <member name="M:log4net.Appender.SmtpAppender.#ctor">
  7785. <summary>
  7786. Default constructor
  7787. </summary>
  7788. <remarks>
  7789. <para>
  7790. Default constructor
  7791. </para>
  7792. </remarks>
  7793. </member>
  7794. <member name="M:log4net.Appender.SmtpAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  7795. <summary>
  7796. Sends the contents of the cyclic buffer as an e-mail message.
  7797. </summary>
  7798. <param name="events">The logging events to send.</param>
  7799. </member>
  7800. <member name="M:log4net.Appender.SmtpAppender.SendEmail(System.String)">
  7801. <summary>
  7802. Send the email message
  7803. </summary>
  7804. <param name="messageBody">the body text to include in the mail</param>
  7805. </member>
  7806. <member name="M:log4net.Appender.SmtpAppender.MaybeTrimSeparators(System.String)">
  7807. <summary>
  7808. trims leading and trailing commas or semicolons
  7809. </summary>
  7810. </member>
  7811. <member name="P:log4net.Appender.SmtpAppender.To">
  7812. <summary>
  7813. Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions).
  7814. </summary>
  7815. <value>
  7816. <para>
  7817. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7818. </para>
  7819. <para>
  7820. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7821. </para>
  7822. </value>
  7823. <remarks>
  7824. <para>
  7825. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7826. </para>
  7827. <para>
  7828. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7829. </para>
  7830. </remarks>
  7831. </member>
  7832. <member name="P:log4net.Appender.SmtpAppender.Cc">
  7833. <summary>
  7834. Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses
  7835. that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions).
  7836. </summary>
  7837. <value>
  7838. <para>
  7839. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7840. </para>
  7841. <para>
  7842. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7843. </para>
  7844. </value>
  7845. <remarks>
  7846. <para>
  7847. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7848. </para>
  7849. <para>
  7850. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7851. </para>
  7852. </remarks>
  7853. </member>
  7854. <member name="P:log4net.Appender.SmtpAppender.Bcc">
  7855. <summary>
  7856. Gets or sets a semicolon-delimited list of recipient e-mail addresses
  7857. that will be blind carbon copied.
  7858. </summary>
  7859. <value>
  7860. A semicolon-delimited list of e-mail addresses.
  7861. </value>
  7862. <remarks>
  7863. <para>
  7864. A semicolon-delimited list of recipient e-mail addresses.
  7865. </para>
  7866. </remarks>
  7867. </member>
  7868. <member name="P:log4net.Appender.SmtpAppender.From">
  7869. <summary>
  7870. Gets or sets the e-mail address of the sender.
  7871. </summary>
  7872. <value>
  7873. The e-mail address of the sender.
  7874. </value>
  7875. <remarks>
  7876. <para>
  7877. The e-mail address of the sender.
  7878. </para>
  7879. </remarks>
  7880. </member>
  7881. <member name="P:log4net.Appender.SmtpAppender.Subject">
  7882. <summary>
  7883. Gets or sets the subject line of the e-mail message.
  7884. </summary>
  7885. <value>
  7886. The subject line of the e-mail message.
  7887. </value>
  7888. <remarks>
  7889. <para>
  7890. The subject line of the e-mail message.
  7891. </para>
  7892. </remarks>
  7893. </member>
  7894. <member name="P:log4net.Appender.SmtpAppender.SmtpHost">
  7895. <summary>
  7896. Gets or sets the name of the SMTP relay mail server to use to send
  7897. the e-mail messages.
  7898. </summary>
  7899. <value>
  7900. The name of the e-mail relay server. If SmtpServer is not set, the
  7901. name of the local SMTP server is used.
  7902. </value>
  7903. <remarks>
  7904. <para>
  7905. The name of the e-mail relay server. If SmtpServer is not set, the
  7906. name of the local SMTP server is used.
  7907. </para>
  7908. </remarks>
  7909. </member>
  7910. <member name="P:log4net.Appender.SmtpAppender.LocationInfo">
  7911. <summary>
  7912. Obsolete
  7913. </summary>
  7914. <remarks>
  7915. Use the BufferingAppenderSkeleton Fix methods instead
  7916. </remarks>
  7917. <remarks>
  7918. <para>
  7919. Obsolete property.
  7920. </para>
  7921. </remarks>
  7922. </member>
  7923. <member name="P:log4net.Appender.SmtpAppender.Authentication">
  7924. <summary>
  7925. The mode to use to authentication with the SMTP server
  7926. </summary>
  7927. <remarks>
  7928. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7929. <para>
  7930. Valid Authentication mode values are: <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>,
  7931. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, and <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  7932. The default value is <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>. When using
  7933. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> you must specify the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  7934. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> to use to authenticate.
  7935. When using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/> the Windows credentials for the current
  7936. thread, if impersonating, or the process will be used to authenticate.
  7937. </para>
  7938. </remarks>
  7939. </member>
  7940. <member name="P:log4net.Appender.SmtpAppender.Username">
  7941. <summary>
  7942. The username to use to authenticate with the SMTP server
  7943. </summary>
  7944. <remarks>
  7945. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7946. <para>
  7947. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7948. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7949. otherwise the username will be ignored.
  7950. </para>
  7951. </remarks>
  7952. </member>
  7953. <member name="P:log4net.Appender.SmtpAppender.Password">
  7954. <summary>
  7955. The password to use to authenticate with the SMTP server
  7956. </summary>
  7957. <remarks>
  7958. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7959. <para>
  7960. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7961. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7962. otherwise the password will be ignored.
  7963. </para>
  7964. </remarks>
  7965. </member>
  7966. <member name="P:log4net.Appender.SmtpAppender.Port">
  7967. <summary>
  7968. The port on which the SMTP server is listening
  7969. </summary>
  7970. <remarks>
  7971. <note type="caution">Server Port is only available on the MS .NET 1.1 runtime.</note>
  7972. <para>
  7973. The port on which the SMTP server is listening. The default
  7974. port is <c>25</c>. The Port can only be changed when running on
  7975. the MS .NET 1.1 runtime.
  7976. </para>
  7977. </remarks>
  7978. </member>
  7979. <member name="P:log4net.Appender.SmtpAppender.Priority">
  7980. <summary>
  7981. Gets or sets the priority of the e-mail message
  7982. </summary>
  7983. <value>
  7984. One of the <see cref="T:System.Net.Mail.MailPriority"/> values.
  7985. </value>
  7986. <remarks>
  7987. <para>
  7988. Sets the priority of the e-mails generated by this
  7989. appender. The default priority is <see cref="F:System.Net.Mail.MailPriority.Normal"/>.
  7990. </para>
  7991. <para>
  7992. If you are using this appender to report errors then
  7993. you may want to set the priority to <see cref="F:System.Net.Mail.MailPriority.High"/>.
  7994. </para>
  7995. </remarks>
  7996. </member>
  7997. <member name="P:log4net.Appender.SmtpAppender.EnableSsl">
  7998. <summary>
  7999. Enable or disable use of SSL when sending e-mail message
  8000. </summary>
  8001. <remarks>
  8002. This is available on MS .NET 2.0 runtime and higher
  8003. </remarks>
  8004. </member>
  8005. <member name="P:log4net.Appender.SmtpAppender.ReplyTo">
  8006. <summary>
  8007. Gets or sets the reply-to e-mail address.
  8008. </summary>
  8009. <remarks>
  8010. This is available on MS .NET 2.0 runtime and higher
  8011. </remarks>
  8012. </member>
  8013. <member name="P:log4net.Appender.SmtpAppender.SubjectEncoding">
  8014. <summary>
  8015. Gets or sets the subject encoding to be used.
  8016. </summary>
  8017. <remarks>
  8018. The default encoding is the operating system's current ANSI codepage.
  8019. </remarks>
  8020. </member>
  8021. <member name="P:log4net.Appender.SmtpAppender.BodyEncoding">
  8022. <summary>
  8023. Gets or sets the body encoding to be used.
  8024. </summary>
  8025. <remarks>
  8026. The default encoding is the operating system's current ANSI codepage.
  8027. </remarks>
  8028. </member>
  8029. <member name="P:log4net.Appender.SmtpAppender.RequiresLayout">
  8030. <summary>
  8031. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8032. </summary>
  8033. <value><c>true</c></value>
  8034. <remarks>
  8035. <para>
  8036. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8037. </para>
  8038. </remarks>
  8039. </member>
  8040. <member name="T:log4net.Appender.SmtpAppender.SmtpAuthentication">
  8041. <summary>
  8042. Values for the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property.
  8043. </summary>
  8044. <remarks>
  8045. <para>
  8046. SMTP authentication modes.
  8047. </para>
  8048. </remarks>
  8049. </member>
  8050. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None">
  8051. <summary>
  8052. No authentication
  8053. </summary>
  8054. </member>
  8055. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic">
  8056. <summary>
  8057. Basic authentication.
  8058. </summary>
  8059. <remarks>
  8060. Requires a username and password to be supplied
  8061. </remarks>
  8062. </member>
  8063. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm">
  8064. <summary>
  8065. Integrated authentication
  8066. </summary>
  8067. <remarks>
  8068. Uses the Windows credentials from the current thread or process to authenticate.
  8069. </remarks>
  8070. </member>
  8071. <member name="T:log4net.Appender.SmtpPickupDirAppender">
  8072. <summary>
  8073. Send an email when a specific logging event occurs, typically on errors
  8074. or fatal errors. Rather than sending via smtp it writes a file into the
  8075. directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such
  8076. as the IIS SMTP agent to manage sending the messages.
  8077. </summary>
  8078. <remarks>
  8079. <para>
  8080. The configuration for this appender is identical to that of the <c>SMTPAppender</c>,
  8081. except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify
  8082. <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>.
  8083. </para>
  8084. <para>
  8085. The number of logging events delivered in this e-mail depend on
  8086. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  8087. <see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last
  8088. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  8089. cyclic buffer. This keeps memory requirements at a reasonable level while
  8090. still delivering useful application context.
  8091. </para>
  8092. </remarks>
  8093. <author>Niall Daley</author>
  8094. <author>Nicko Cadell</author>
  8095. </member>
  8096. <member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor">
  8097. <summary>
  8098. Default constructor
  8099. </summary>
  8100. <remarks>
  8101. <para>
  8102. Default constructor
  8103. </para>
  8104. </remarks>
  8105. </member>
  8106. <member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  8107. <summary>
  8108. Sends the contents of the cyclic buffer as an e-mail message.
  8109. </summary>
  8110. <param name="events">The logging events to send.</param>
  8111. <remarks>
  8112. <para>
  8113. Sends the contents of the cyclic buffer as an e-mail message.
  8114. </para>
  8115. </remarks>
  8116. </member>
  8117. <member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions">
  8118. <summary>
  8119. Activate the options on this appender.
  8120. </summary>
  8121. <remarks>
  8122. <para>
  8123. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  8124. activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must
  8125. be called on this object after the configuration properties have
  8126. been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this
  8127. object is in an undefined state and must not be used.
  8128. </para>
  8129. <para>
  8130. If any of the configuration properties are modified then
  8131. <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again.
  8132. </para>
  8133. </remarks>
  8134. </member>
  8135. <member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)">
  8136. <summary>
  8137. Convert a path into a fully qualified path.
  8138. </summary>
  8139. <param name="path">The path to convert.</param>
  8140. <returns>The fully qualified path.</returns>
  8141. <remarks>
  8142. <para>
  8143. Converts the path specified to a fully
  8144. qualified path. If the path is relative it is
  8145. taken as relative from the application base
  8146. directory.
  8147. </para>
  8148. </remarks>
  8149. </member>
  8150. <member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext">
  8151. <summary>
  8152. The security context to use for privileged calls
  8153. </summary>
  8154. </member>
  8155. <member name="P:log4net.Appender.SmtpPickupDirAppender.To">
  8156. <summary>
  8157. Gets or sets a semicolon-delimited list of recipient e-mail addresses.
  8158. </summary>
  8159. <value>
  8160. A semicolon-delimited list of e-mail addresses.
  8161. </value>
  8162. <remarks>
  8163. <para>
  8164. A semicolon-delimited list of e-mail addresses.
  8165. </para>
  8166. </remarks>
  8167. </member>
  8168. <member name="P:log4net.Appender.SmtpPickupDirAppender.From">
  8169. <summary>
  8170. Gets or sets the e-mail address of the sender.
  8171. </summary>
  8172. <value>
  8173. The e-mail address of the sender.
  8174. </value>
  8175. <remarks>
  8176. <para>
  8177. The e-mail address of the sender.
  8178. </para>
  8179. </remarks>
  8180. </member>
  8181. <member name="P:log4net.Appender.SmtpPickupDirAppender.Subject">
  8182. <summary>
  8183. Gets or sets the subject line of the e-mail message.
  8184. </summary>
  8185. <value>
  8186. The subject line of the e-mail message.
  8187. </value>
  8188. <remarks>
  8189. <para>
  8190. The subject line of the e-mail message.
  8191. </para>
  8192. </remarks>
  8193. </member>
  8194. <member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir">
  8195. <summary>
  8196. Gets or sets the path to write the messages to.
  8197. </summary>
  8198. <remarks>
  8199. <para>
  8200. Gets or sets the path to write the messages to. This should be the same
  8201. as that used by the agent sending the messages.
  8202. </para>
  8203. </remarks>
  8204. </member>
  8205. <member name="P:log4net.Appender.SmtpPickupDirAppender.FileExtension">
  8206. <summary>
  8207. Gets or sets the file extension for the generated files
  8208. </summary>
  8209. <value>
  8210. The file extension for the generated files
  8211. </value>
  8212. <remarks>
  8213. <para>
  8214. The file extension for the generated files
  8215. </para>
  8216. </remarks>
  8217. </member>
  8218. <member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext">
  8219. <summary>
  8220. Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  8221. </summary>
  8222. <value>
  8223. The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  8224. </value>
  8225. <remarks>
  8226. <para>
  8227. Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender
  8228. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  8229. security context to use. The default behavior is to use the security context
  8230. of the current thread.
  8231. </para>
  8232. </remarks>
  8233. </member>
  8234. <member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout">
  8235. <summary>
  8236. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8237. </summary>
  8238. <value><c>true</c></value>
  8239. <remarks>
  8240. <para>
  8241. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8242. </para>
  8243. </remarks>
  8244. </member>
  8245. <member name="T:log4net.Appender.TelnetAppender">
  8246. <summary>
  8247. Appender that allows clients to connect via Telnet to receive log messages
  8248. </summary>
  8249. <remarks>
  8250. <para>
  8251. The TelnetAppender accepts socket connections and streams logging messages
  8252. back to the client.
  8253. The output is provided in a telnet-friendly way so that a log can be monitored
  8254. over a TCP/IP socket.
  8255. This allows simple remote monitoring of application logging.
  8256. </para>
  8257. <para>
  8258. The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port).
  8259. </para>
  8260. </remarks>
  8261. <author>Keith Long</author>
  8262. <author>Nicko Cadell</author>
  8263. </member>
  8264. <member name="M:log4net.Appender.TelnetAppender.#ctor">
  8265. <summary>
  8266. Default constructor
  8267. </summary>
  8268. <remarks>
  8269. <para>
  8270. Default constructor
  8271. </para>
  8272. </remarks>
  8273. </member>
  8274. <member name="F:log4net.Appender.TelnetAppender.declaringType">
  8275. <summary>
  8276. The fully qualified type of the TelnetAppender class.
  8277. </summary>
  8278. <remarks>
  8279. Used by the internal logger to record the Type of the
  8280. log message.
  8281. </remarks>
  8282. </member>
  8283. <member name="M:log4net.Appender.TelnetAppender.OnClose">
  8284. <summary>
  8285. Overrides the parent method to close the socket handler
  8286. </summary>
  8287. <remarks>
  8288. <para>
  8289. Closes all the outstanding connections.
  8290. </para>
  8291. </remarks>
  8292. </member>
  8293. <member name="M:log4net.Appender.TelnetAppender.ActivateOptions">
  8294. <summary>
  8295. Initialize the appender based on the options set.
  8296. </summary>
  8297. <remarks>
  8298. <para>
  8299. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  8300. activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must
  8301. be called on this object after the configuration properties have
  8302. been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this
  8303. object is in an undefined state and must not be used.
  8304. </para>
  8305. <para>
  8306. If any of the configuration properties are modified then
  8307. <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again.
  8308. </para>
  8309. <para>
  8310. Create the socket handler and wait for connections
  8311. </para>
  8312. </remarks>
  8313. </member>
  8314. <member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)">
  8315. <summary>
  8316. Writes the logging event to each connected client.
  8317. </summary>
  8318. <param name="loggingEvent">The event to log.</param>
  8319. <remarks>
  8320. <para>
  8321. Writes the logging event to each connected client.
  8322. </para>
  8323. </remarks>
  8324. </member>
  8325. <member name="P:log4net.Appender.TelnetAppender.Port">
  8326. <summary>
  8327. Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  8328. </summary>
  8329. <value>
  8330. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  8331. indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  8332. </value>
  8333. <remarks>
  8334. <para>
  8335. The default value is 23 (the telnet port).
  8336. </para>
  8337. </remarks>
  8338. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/>
  8339. or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
  8340. </member>
  8341. <member name="P:log4net.Appender.TelnetAppender.RequiresLayout">
  8342. <summary>
  8343. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8344. </summary>
  8345. <value><c>true</c></value>
  8346. <remarks>
  8347. <para>
  8348. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8349. </para>
  8350. </remarks>
  8351. </member>
  8352. <member name="T:log4net.Appender.TelnetAppender.SocketHandler">
  8353. <summary>
  8354. Helper class to manage connected clients
  8355. </summary>
  8356. <remarks>
  8357. <para>
  8358. The SocketHandler class is used to accept connections from
  8359. clients. It is threaded so that clients can connect/disconnect
  8360. asynchronously.
  8361. </para>
  8362. </remarks>
  8363. </member>
  8364. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)">
  8365. <summary>
  8366. Opens a new server port on <paramref ref="port"/>
  8367. </summary>
  8368. <param name="port">the local port to listen on for connections</param>
  8369. <remarks>
  8370. <para>
  8371. Creates a socket handler on the specified local server port.
  8372. </para>
  8373. </remarks>
  8374. </member>
  8375. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)">
  8376. <summary>
  8377. Sends a string message to each of the connected clients
  8378. </summary>
  8379. <param name="message">the text to send</param>
  8380. <remarks>
  8381. <para>
  8382. Sends a string message to each of the connected clients
  8383. </para>
  8384. </remarks>
  8385. </member>
  8386. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  8387. <summary>
  8388. Add a client to the internal clients list
  8389. </summary>
  8390. <param name="client">client to add</param>
  8391. </member>
  8392. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  8393. <summary>
  8394. Remove a client from the internal clients list
  8395. </summary>
  8396. <param name="client">client to remove</param>
  8397. </member>
  8398. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.OnConnect(System.IAsyncResult)">
  8399. <summary>
  8400. Callback used to accept a connection on the server socket
  8401. </summary>
  8402. <param name="asyncResult">The result of the asynchronous operation</param>
  8403. <remarks>
  8404. <para>
  8405. On connection adds to the list of connections
  8406. if there are two many open connections you will be disconnected
  8407. </para>
  8408. </remarks>
  8409. </member>
  8410. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose">
  8411. <summary>
  8412. Close all network connections
  8413. </summary>
  8414. <remarks>
  8415. <para>
  8416. Make sure we close all network connections
  8417. </para>
  8418. </remarks>
  8419. </member>
  8420. <member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections">
  8421. <summary>
  8422. Test if this handler has active connections
  8423. </summary>
  8424. <value>
  8425. <c>true</c> if this handler has active connections
  8426. </value>
  8427. <remarks>
  8428. <para>
  8429. This property will be <c>true</c> while this handler has
  8430. active connections, that is at least one connection that
  8431. the handler will attempt to send a message to.
  8432. </para>
  8433. </remarks>
  8434. </member>
  8435. <member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient">
  8436. <summary>
  8437. Class that represents a client connected to this handler
  8438. </summary>
  8439. <remarks>
  8440. <para>
  8441. Class that represents a client connected to this handler
  8442. </para>
  8443. </remarks>
  8444. </member>
  8445. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)">
  8446. <summary>
  8447. Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/>
  8448. </summary>
  8449. <param name="socket">the client's socket</param>
  8450. <remarks>
  8451. <para>
  8452. Opens a stream writer on the socket.
  8453. </para>
  8454. </remarks>
  8455. </member>
  8456. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)">
  8457. <summary>
  8458. Write a string to the client
  8459. </summary>
  8460. <param name="message">string to send</param>
  8461. <remarks>
  8462. <para>
  8463. Write a string to the client
  8464. </para>
  8465. </remarks>
  8466. </member>
  8467. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose">
  8468. <summary>
  8469. Cleanup the clients connection
  8470. </summary>
  8471. <remarks>
  8472. <para>
  8473. Close the socket connection.
  8474. </para>
  8475. </remarks>
  8476. </member>
  8477. <member name="T:log4net.Appender.TraceAppender">
  8478. <summary>
  8479. Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system.
  8480. </summary>
  8481. <remarks>
  8482. <para>
  8483. The application configuration file can be used to control what listeners
  8484. are actually used. See the MSDN documentation for the
  8485. <see cref="T:System.Diagnostics.Trace"/> class for details on configuring the
  8486. trace system.
  8487. </para>
  8488. <para>
  8489. Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c>
  8490. method. The event's logger name is the default value for the category parameter
  8491. of the Write method.
  8492. </para>
  8493. <para>
  8494. <b>Compact Framework</b><br/>
  8495. The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/>
  8496. class for any operation except <c>Assert</c>. When using the Compact Framework this
  8497. appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than
  8498. the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>.
  8499. </para>
  8500. </remarks>
  8501. <author>Douglas de la Torre</author>
  8502. <author>Nicko Cadell</author>
  8503. <author>Gert Driesen</author>
  8504. <author>Ron Grabowski</author>
  8505. </member>
  8506. <member name="M:log4net.Appender.TraceAppender.#ctor">
  8507. <summary>
  8508. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>.
  8509. </summary>
  8510. <remarks>
  8511. <para>
  8512. Default constructor.
  8513. </para>
  8514. </remarks>
  8515. </member>
  8516. <member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)">
  8517. <summary>
  8518. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>
  8519. with a specified layout.
  8520. </summary>
  8521. <param name="layout">The layout to use with this appender.</param>
  8522. <remarks>
  8523. <para>
  8524. Obsolete constructor.
  8525. </para>
  8526. </remarks>
  8527. </member>
  8528. <member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)">
  8529. <summary>
  8530. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  8531. </summary>
  8532. <param name="loggingEvent">The event to log.</param>
  8533. <remarks>
  8534. <para>
  8535. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  8536. </para>
  8537. </remarks>
  8538. </member>
  8539. <member name="F:log4net.Appender.TraceAppender.m_immediateFlush">
  8540. <summary>
  8541. Immediate flush means that the underlying writer or output stream
  8542. will be flushed at the end of each append operation.
  8543. </summary>
  8544. <remarks>
  8545. <para>
  8546. Immediate flush is slower but ensures that each append request is
  8547. actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to
  8548. <c>false</c>, then there is a good chance that the last few
  8549. logs events are not actually written to persistent media if and
  8550. when the application crashes.
  8551. </para>
  8552. <para>
  8553. The default value is <c>true</c>.</para>
  8554. </remarks>
  8555. </member>
  8556. <member name="F:log4net.Appender.TraceAppender.m_category">
  8557. <summary>
  8558. Defaults to %logger
  8559. </summary>
  8560. </member>
  8561. <member name="M:log4net.Appender.TraceAppender.Flush(System.Int32)">
  8562. <summary>
  8563. Flushes any buffered log data.
  8564. </summary>
  8565. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  8566. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  8567. </member>
  8568. <member name="P:log4net.Appender.TraceAppender.ImmediateFlush">
  8569. <summary>
  8570. Gets or sets a value that indicates whether the appender will
  8571. flush at the end of each write.
  8572. </summary>
  8573. <remarks>
  8574. <para>The default behavior is to flush at the end of each
  8575. write. If the option is set to<c>false</c>, then the underlying
  8576. stream can defer writing to physical medium to a later time.
  8577. </para>
  8578. <para>
  8579. Avoiding the flush operation at the end of each append results
  8580. in a performance gain of 10 to 20 percent. However, there is safety
  8581. trade-off involved in skipping flushing. Indeed, when flushing is
  8582. skipped, then it is likely that the last few log events will not
  8583. be recorded on disk when the application exits. This is a high
  8584. price to pay even for a 20% performance gain.
  8585. </para>
  8586. </remarks>
  8587. </member>
  8588. <member name="P:log4net.Appender.TraceAppender.Category">
  8589. <summary>
  8590. The category parameter sent to the Trace method.
  8591. </summary>
  8592. <remarks>
  8593. <para>
  8594. Defaults to %logger which will use the logger name of the current
  8595. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  8596. </para>
  8597. <para>
  8598. </para>
  8599. </remarks>
  8600. </member>
  8601. <member name="P:log4net.Appender.TraceAppender.RequiresLayout">
  8602. <summary>
  8603. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8604. </summary>
  8605. <value><c>true</c></value>
  8606. <remarks>
  8607. <para>
  8608. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8609. </para>
  8610. </remarks>
  8611. </member>
  8612. <member name="T:log4net.Config.AliasDomainAttribute">
  8613. <summary>
  8614. Assembly level attribute that specifies a domain to alias to this assembly's repository.
  8615. </summary>
  8616. <remarks>
  8617. <para>
  8618. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  8619. </para>
  8620. <para>
  8621. An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>,
  8622. however this can be overridden by an assembly loaded before the target assembly.
  8623. </para>
  8624. <para>
  8625. An assembly can alias another assembly's domain to its repository by
  8626. specifying this attribute with the name of the target domain.
  8627. </para>
  8628. <para>
  8629. This attribute can only be specified on the assembly and may be used
  8630. as many times as necessary to alias all the required domains.
  8631. </para>
  8632. </remarks>
  8633. <author>Nicko Cadell</author>
  8634. <author>Gert Driesen</author>
  8635. </member>
  8636. <member name="T:log4net.Config.AliasRepositoryAttribute">
  8637. <summary>
  8638. Assembly level attribute that specifies a repository to alias to this assembly's repository.
  8639. </summary>
  8640. <remarks>
  8641. <para>
  8642. An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>,
  8643. however this can be overridden by an assembly loaded before the target assembly.
  8644. </para>
  8645. <para>
  8646. An assembly can alias another assembly's repository to its repository by
  8647. specifying this attribute with the name of the target repository.
  8648. </para>
  8649. <para>
  8650. This attribute can only be specified on the assembly and may be used
  8651. as many times as necessary to alias all the required repositories.
  8652. </para>
  8653. </remarks>
  8654. <author>Nicko Cadell</author>
  8655. <author>Gert Driesen</author>
  8656. </member>
  8657. <member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)">
  8658. <summary>
  8659. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
  8660. the specified repository to alias to this assembly's repository.
  8661. </summary>
  8662. <param name="name">The repository to alias to this assemby's repository.</param>
  8663. <remarks>
  8664. <para>
  8665. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
  8666. the specified repository to alias to this assembly's repository.
  8667. </para>
  8668. </remarks>
  8669. </member>
  8670. <member name="P:log4net.Config.AliasRepositoryAttribute.Name">
  8671. <summary>
  8672. Gets or sets the repository to alias to this assemby's repository.
  8673. </summary>
  8674. <value>
  8675. The repository to alias to this assemby's repository.
  8676. </value>
  8677. <remarks>
  8678. <para>
  8679. The name of the repository to alias to this assemby's repository.
  8680. </para>
  8681. </remarks>
  8682. </member>
  8683. <member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)">
  8684. <summary>
  8685. Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute"/> class with
  8686. the specified domain to alias to this assembly's repository.
  8687. </summary>
  8688. <param name="name">The domain to alias to this assemby's repository.</param>
  8689. <remarks>
  8690. <para>
  8691. Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>.
  8692. </para>
  8693. </remarks>
  8694. </member>
  8695. <member name="T:log4net.Config.BasicConfigurator">
  8696. <summary>
  8697. Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  8698. </summary>
  8699. <remarks>
  8700. <para>
  8701. Allows very simple programmatic configuration of log4net.
  8702. </para>
  8703. <para>
  8704. Only one appender can be configured using this configurator.
  8705. The appender is set at the root of the hierarchy and all logging
  8706. events will be delivered to that appender.
  8707. </para>
  8708. <para>
  8709. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  8710. they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions()"/> method
  8711. be called after the appenders properties have been configured.
  8712. </para>
  8713. </remarks>
  8714. <author>Nicko Cadell</author>
  8715. <author>Gert Driesen</author>
  8716. </member>
  8717. <member name="F:log4net.Config.BasicConfigurator.declaringType">
  8718. <summary>
  8719. The fully qualified type of the BasicConfigurator class.
  8720. </summary>
  8721. <remarks>
  8722. Used by the internal logger to record the Type of the
  8723. log message.
  8724. </remarks>
  8725. </member>
  8726. <member name="M:log4net.Config.BasicConfigurator.#ctor">
  8727. <summary>
  8728. Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator"/> class.
  8729. </summary>
  8730. <remarks>
  8731. <para>
  8732. Uses a private access modifier to prevent instantiation of this class.
  8733. </para>
  8734. </remarks>
  8735. </member>
  8736. <member name="M:log4net.Config.BasicConfigurator.Configure">
  8737. <summary>
  8738. Initializes the log4net system with a default configuration.
  8739. </summary>
  8740. <remarks>
  8741. <para>
  8742. Initializes the log4net logging system using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  8743. that will write to <c>Console.Out</c>. The log messages are
  8744. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  8745. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  8746. layout style.
  8747. </para>
  8748. </remarks>
  8749. </member>
  8750. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender[])">
  8751. <summary>
  8752. Initializes the log4net system using the specified appenders.
  8753. </summary>
  8754. <param name="appenders">The appenders to use to log all logging events.</param>
  8755. <remarks>
  8756. <para>
  8757. Initializes the log4net system using the specified appenders.
  8758. </para>
  8759. </remarks>
  8760. </member>
  8761. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender)">
  8762. <summary>
  8763. Initializes the log4net system using the specified appender.
  8764. </summary>
  8765. <param name="appender">The appender to use to log all logging events.</param>
  8766. <remarks>
  8767. <para>
  8768. Initializes the log4net system using the specified appender.
  8769. </para>
  8770. </remarks>
  8771. </member>
  8772. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  8773. <summary>
  8774. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration.
  8775. </summary>
  8776. <param name="repository">The repository to configure.</param>
  8777. <remarks>
  8778. <para>
  8779. Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  8780. that will write to <c>Console.Out</c>. The log messages are
  8781. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  8782. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  8783. layout style.
  8784. </para>
  8785. </remarks>
  8786. </member>
  8787. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)">
  8788. <summary>
  8789. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8790. </summary>
  8791. <param name="repository">The repository to configure.</param>
  8792. <param name="appender">The appender to use to log all logging events.</param>
  8793. <remarks>
  8794. <para>
  8795. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8796. </para>
  8797. </remarks>
  8798. </member>
  8799. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender[])">
  8800. <summary>
  8801. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appenders.
  8802. </summary>
  8803. <param name="repository">The repository to configure.</param>
  8804. <param name="appenders">The appenders to use to log all logging events.</param>
  8805. <remarks>
  8806. <para>
  8807. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8808. </para>
  8809. </remarks>
  8810. </member>
  8811. <member name="T:log4net.Config.ConfiguratorAttribute">
  8812. <summary>
  8813. Base class for all log4net configuration attributes.
  8814. </summary>
  8815. <remarks>
  8816. This is an abstract class that must be extended by
  8817. specific configurators. This attribute allows the
  8818. configurator to be parameterized by an assembly level
  8819. attribute.
  8820. </remarks>
  8821. <author>Nicko Cadell</author>
  8822. <author>Gert Driesen</author>
  8823. </member>
  8824. <member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)">
  8825. <summary>
  8826. Constructor used by subclasses.
  8827. </summary>
  8828. <param name="priority">the ordering priority for this configurator</param>
  8829. <remarks>
  8830. <para>
  8831. The <paramref name="priority"/> is used to order the configurator
  8832. attributes before they are invoked. Higher priority configurators are executed
  8833. before lower priority ones.
  8834. </para>
  8835. </remarks>
  8836. </member>
  8837. <member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8838. <summary>
  8839. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  8840. </summary>
  8841. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8842. <param name="targetRepository">The repository to configure.</param>
  8843. <remarks>
  8844. <para>
  8845. Abstract method implemented by a subclass. When this method is called
  8846. the subclass should configure the <paramref name="targetRepository"/>.
  8847. </para>
  8848. </remarks>
  8849. </member>
  8850. <member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)">
  8851. <summary>
  8852. Compare this instance to another ConfiguratorAttribute
  8853. </summary>
  8854. <param name="obj">the object to compare to</param>
  8855. <returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns>
  8856. <remarks>
  8857. <para>
  8858. Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances.
  8859. Sorts by priority in descending order. Objects with the same priority are
  8860. randomly ordered.
  8861. </para>
  8862. </remarks>
  8863. </member>
  8864. <member name="T:log4net.Config.DomainAttribute">
  8865. <summary>
  8866. Assembly level attribute that specifies the logging domain for the assembly.
  8867. </summary>
  8868. <remarks>
  8869. <para>
  8870. <b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b>
  8871. </para>
  8872. <para>
  8873. Assemblies are mapped to logging domains. Each domain has its own
  8874. logging repository. This attribute specified on the assembly controls
  8875. the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  8876. of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  8877. specifies the type of the repository objects to create for the domain. If
  8878. this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified
  8879. then the assembly will be part of the default shared logging domain.
  8880. </para>
  8881. <para>
  8882. This attribute can only be specified on the assembly and may only be used
  8883. once per assembly.
  8884. </para>
  8885. </remarks>
  8886. <author>Nicko Cadell</author>
  8887. <author>Gert Driesen</author>
  8888. </member>
  8889. <member name="T:log4net.Config.RepositoryAttribute">
  8890. <summary>
  8891. Assembly level attribute that specifies the logging repository for the assembly.
  8892. </summary>
  8893. <remarks>
  8894. <para>
  8895. Assemblies are mapped to logging repository. This attribute specified
  8896. on the assembly controls
  8897. the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  8898. of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  8899. specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object
  8900. to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/>
  8901. is not specified then the assembly will be part of the default shared logging repository.
  8902. </para>
  8903. <para>
  8904. This attribute can only be specified on the assembly and may only be used
  8905. once per assembly.
  8906. </para>
  8907. </remarks>
  8908. <author>Nicko Cadell</author>
  8909. <author>Gert Driesen</author>
  8910. </member>
  8911. <member name="M:log4net.Config.RepositoryAttribute.#ctor">
  8912. <summary>
  8913. Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class.
  8914. </summary>
  8915. <remarks>
  8916. <para>
  8917. Default constructor.
  8918. </para>
  8919. </remarks>
  8920. </member>
  8921. <member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)">
  8922. <summary>
  8923. Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class
  8924. with the name of the repository.
  8925. </summary>
  8926. <param name="name">The name of the repository.</param>
  8927. <remarks>
  8928. <para>
  8929. Initialize the attribute with the name for the assembly's repository.
  8930. </para>
  8931. </remarks>
  8932. </member>
  8933. <member name="P:log4net.Config.RepositoryAttribute.Name">
  8934. <summary>
  8935. Gets or sets the name of the logging repository.
  8936. </summary>
  8937. <value>
  8938. The string name to use as the name of the repository associated with this
  8939. assembly.
  8940. </value>
  8941. <remarks>
  8942. <para>
  8943. This value does not have to be unique. Several assemblies can share the
  8944. same repository. They will share the logging configuration of the repository.
  8945. </para>
  8946. </remarks>
  8947. </member>
  8948. <member name="P:log4net.Config.RepositoryAttribute.RepositoryType">
  8949. <summary>
  8950. Gets or sets the type of repository to create for this assembly.
  8951. </summary>
  8952. <value>
  8953. The type of repository to create for this assembly.
  8954. </value>
  8955. <remarks>
  8956. <para>
  8957. The type of the repository to create for the assembly.
  8958. The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/>
  8959. interface.
  8960. </para>
  8961. <para>
  8962. This will be the type of repository created when
  8963. the repository is created. If multiple assemblies reference the
  8964. same repository then the repository is only created once using the
  8965. <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> of the first assembly to call into the
  8966. repository.
  8967. </para>
  8968. </remarks>
  8969. </member>
  8970. <member name="M:log4net.Config.DomainAttribute.#ctor">
  8971. <summary>
  8972. Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class.
  8973. </summary>
  8974. <remarks>
  8975. <para>
  8976. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8977. </para>
  8978. </remarks>
  8979. </member>
  8980. <member name="M:log4net.Config.DomainAttribute.#ctor(System.String)">
  8981. <summary>
  8982. Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class
  8983. with the name of the domain.
  8984. </summary>
  8985. <param name="name">The name of the domain.</param>
  8986. <remarks>
  8987. <para>
  8988. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8989. </para>
  8990. </remarks>
  8991. </member>
  8992. <member name="T:log4net.Config.DOMConfigurator">
  8993. <summary>
  8994. Use this class to initialize the log4net environment using an Xml tree.
  8995. </summary>
  8996. <remarks>
  8997. <para>
  8998. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8999. </para>
  9000. <para>
  9001. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  9002. </para>
  9003. </remarks>
  9004. <author>Nicko Cadell</author>
  9005. <author>Gert Driesen</author>
  9006. </member>
  9007. <member name="M:log4net.Config.DOMConfigurator.#ctor">
  9008. <summary>
  9009. Private constructor
  9010. </summary>
  9011. </member>
  9012. <member name="M:log4net.Config.DOMConfigurator.Configure">
  9013. <summary>
  9014. Automatically configures the log4net system based on the
  9015. application's configuration settings.
  9016. </summary>
  9017. <remarks>
  9018. <para>
  9019. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9020. </para>
  9021. Each application has a configuration file. This has the
  9022. same name as the application with '.config' appended.
  9023. This file is XML and calling this function prompts the
  9024. configurator to look in that file for a section called
  9025. <c>log4net</c> that contains the configuration data.
  9026. </remarks>
  9027. </member>
  9028. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  9029. <summary>
  9030. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  9031. stored in the application's configuration file.
  9032. </summary>
  9033. <remarks>
  9034. <para>
  9035. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9036. </para>
  9037. Each application has a configuration file. This has the
  9038. same name as the application with '.config' appended.
  9039. This file is XML and calling this function prompts the
  9040. configurator to look in that file for a section called
  9041. <c>log4net</c> that contains the configuration data.
  9042. </remarks>
  9043. <param name="repository">The repository to configure.</param>
  9044. </member>
  9045. <member name="M:log4net.Config.DOMConfigurator.Configure(System.Xml.XmlElement)">
  9046. <summary>
  9047. Configures log4net using a <c>log4net</c> element
  9048. </summary>
  9049. <remarks>
  9050. <para>
  9051. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9052. </para>
  9053. Loads the log4net configuration from the XML element
  9054. supplied as <paramref name="element"/>.
  9055. </remarks>
  9056. <param name="element">The element to parse.</param>
  9057. </member>
  9058. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9059. <summary>
  9060. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  9061. element.
  9062. </summary>
  9063. <remarks>
  9064. <para>
  9065. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9066. </para>
  9067. Loads the log4net configuration from the XML element
  9068. supplied as <paramref name="element"/>.
  9069. </remarks>
  9070. <param name="repository">The repository to configure.</param>
  9071. <param name="element">The element to parse.</param>
  9072. </member>
  9073. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)">
  9074. <summary>
  9075. Configures log4net using the specified configuration file.
  9076. </summary>
  9077. <param name="configFile">The XML file to load the configuration from.</param>
  9078. <remarks>
  9079. <para>
  9080. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9081. </para>
  9082. <para>
  9083. The configuration file must be valid XML. It must contain
  9084. at least one element called <c>log4net</c> that holds
  9085. the log4net configuration data.
  9086. </para>
  9087. <para>
  9088. The log4net configuration file can possible be specified in the application's
  9089. configuration file (either <c>MyAppName.exe.config</c> for a
  9090. normal application on <c>Web.config</c> for an ASP.NET application).
  9091. </para>
  9092. <example>
  9093. The following example configures log4net using a configuration file, of which the
  9094. location is stored in the application's configuration file :
  9095. </example>
  9096. <code lang="C#">
  9097. using log4net.Config;
  9098. using System.IO;
  9099. using System.Configuration;
  9100. ...
  9101. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9102. </code>
  9103. <para>
  9104. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9105. </para>
  9106. <code lang="XML" escaped="true">
  9107. <configuration>
  9108. <appSettings>
  9109. <add key="log4net-config-file" value="log.config"/>
  9110. </appSettings>
  9111. </configuration>
  9112. </code>
  9113. </remarks>
  9114. </member>
  9115. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.Stream)">
  9116. <summary>
  9117. Configures log4net using the specified configuration file.
  9118. </summary>
  9119. <param name="configStream">A stream to load the XML configuration from.</param>
  9120. <remarks>
  9121. <para>
  9122. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9123. </para>
  9124. <para>
  9125. The configuration data must be valid XML. It must contain
  9126. at least one element called <c>log4net</c> that holds
  9127. the log4net configuration data.
  9128. </para>
  9129. <para>
  9130. Note that this method will NOT close the stream parameter.
  9131. </para>
  9132. </remarks>
  9133. </member>
  9134. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9135. <summary>
  9136. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9137. file.
  9138. </summary>
  9139. <param name="repository">The repository to configure.</param>
  9140. <param name="configFile">The XML file to load the configuration from.</param>
  9141. <remarks>
  9142. <para>
  9143. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9144. </para>
  9145. <para>
  9146. The configuration file must be valid XML. It must contain
  9147. at least one element called <c>log4net</c> that holds
  9148. the configuration data.
  9149. </para>
  9150. <para>
  9151. The log4net configuration file can possible be specified in the application's
  9152. configuration file (either <c>MyAppName.exe.config</c> for a
  9153. normal application on <c>Web.config</c> for an ASP.NET application).
  9154. </para>
  9155. <example>
  9156. The following example configures log4net using a configuration file, of which the
  9157. location is stored in the application's configuration file :
  9158. </example>
  9159. <code lang="C#">
  9160. using log4net.Config;
  9161. using System.IO;
  9162. using System.Configuration;
  9163. ...
  9164. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9165. </code>
  9166. <para>
  9167. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9168. </para>
  9169. <code lang="XML" escaped="true">
  9170. <configuration>
  9171. <appSettings>
  9172. <add key="log4net-config-file" value="log.config"/>
  9173. </appSettings>
  9174. </configuration>
  9175. </code>
  9176. </remarks>
  9177. </member>
  9178. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  9179. <summary>
  9180. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9181. file.
  9182. </summary>
  9183. <param name="repository">The repository to configure.</param>
  9184. <param name="configStream">The stream to load the XML configuration from.</param>
  9185. <remarks>
  9186. <para>
  9187. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9188. </para>
  9189. <para>
  9190. The configuration data must be valid XML. It must contain
  9191. at least one element called <c>log4net</c> that holds
  9192. the configuration data.
  9193. </para>
  9194. <para>
  9195. Note that this method will NOT close the stream parameter.
  9196. </para>
  9197. </remarks>
  9198. </member>
  9199. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  9200. <summary>
  9201. Configures log4net using the file specified, monitors the file for changes
  9202. and reloads the configuration if a change is detected.
  9203. </summary>
  9204. <param name="configFile">The XML file to load the configuration from.</param>
  9205. <remarks>
  9206. <para>
  9207. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9208. </para>
  9209. <para>
  9210. The configuration file must be valid XML. It must contain
  9211. at least one element called <c>log4net</c> that holds
  9212. the configuration data.
  9213. </para>
  9214. <para>
  9215. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9216. and depends on the behavior of that class.
  9217. </para>
  9218. <para>
  9219. For more information on how to configure log4net using
  9220. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9221. </para>
  9222. </remarks>
  9223. <seealso cref="M:Configure(FileInfo)"/>
  9224. </member>
  9225. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9226. <summary>
  9227. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  9228. monitors the file for changes and reloads the configuration if a change
  9229. is detected.
  9230. </summary>
  9231. <param name="repository">The repository to configure.</param>
  9232. <param name="configFile">The XML file to load the configuration from.</param>
  9233. <remarks>
  9234. <para>
  9235. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9236. </para>
  9237. <para>
  9238. The configuration file must be valid XML. It must contain
  9239. at least one element called <c>log4net</c> that holds
  9240. the configuration data.
  9241. </para>
  9242. <para>
  9243. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9244. and depends on the behavior of that class.
  9245. </para>
  9246. <para>
  9247. For more information on how to configure log4net using
  9248. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9249. </para>
  9250. </remarks>
  9251. <seealso cref="M:Configure(FileInfo)"/>
  9252. </member>
  9253. <member name="T:log4net.Config.DOMConfiguratorAttribute">
  9254. <summary>
  9255. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  9256. </summary>
  9257. <remarks>
  9258. <para>
  9259. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  9260. </para>
  9261. <para>
  9262. This attribute may only be used at the assembly scope and can only
  9263. be used once per assembly.
  9264. </para>
  9265. <para>
  9266. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  9267. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  9268. methods.
  9269. </para>
  9270. </remarks>
  9271. <author>Nicko Cadell</author>
  9272. <author>Gert Driesen</author>
  9273. </member>
  9274. <member name="T:log4net.Config.XmlConfiguratorAttribute">
  9275. <summary>
  9276. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  9277. </summary>
  9278. <remarks>
  9279. <para>
  9280. This attribute may only be used at the assembly scope and can only
  9281. be used once per assembly.
  9282. </para>
  9283. <para>
  9284. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  9285. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  9286. methods.
  9287. </para>
  9288. <para>
  9289. If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>
  9290. properties are set the configuration is loaded from the application's .config file.
  9291. If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the
  9292. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property
  9293. specifies a path to a file to load the config from. The path is relative to the
  9294. application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  9295. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name.
  9296. The config file must be located in the application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  9297. For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to
  9298. <c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or
  9299. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties.
  9300. </para>
  9301. <para>
  9302. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/>
  9303. to watch the configuration file for changes.
  9304. </para>
  9305. <note>
  9306. <para>
  9307. Log4net will only look for assembly level configuration attributes once.
  9308. When using the log4net assembly level attributes to control the configuration
  9309. of log4net you must ensure that the first call to any of the
  9310. <see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration
  9311. attributes.
  9312. </para>
  9313. <para>
  9314. If you cannot guarantee the order in which log4net calls will be made from
  9315. different assemblies you must use programmatic configuration instead, i.e.
  9316. call the <see cref="M:XmlConfigurator.Configure()"/> method directly.
  9317. </para>
  9318. </note>
  9319. </remarks>
  9320. <author>Nicko Cadell</author>
  9321. <author>Gert Driesen</author>
  9322. </member>
  9323. <member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor">
  9324. <summary>
  9325. Default constructor
  9326. </summary>
  9327. <remarks>
  9328. <para>
  9329. Default constructor
  9330. </para>
  9331. </remarks>
  9332. </member>
  9333. <member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9334. <summary>
  9335. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9336. </summary>
  9337. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9338. <param name="targetRepository">The repository to configure.</param>
  9339. <remarks>
  9340. <para>
  9341. Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>.
  9342. The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  9343. class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to
  9344. configure it.
  9345. </para>
  9346. </remarks>
  9347. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetRepository"/> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception>
  9348. </member>
  9349. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9350. <summary>
  9351. Attempt to load configuration from the local file system
  9352. </summary>
  9353. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9354. <param name="targetRepository">The repository to configure.</param>
  9355. </member>
  9356. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9357. <summary>
  9358. Configure the specified repository using a <see cref="T:System.IO.FileInfo"/>
  9359. </summary>
  9360. <param name="targetRepository">The repository to configure.</param>
  9361. <param name="configFile">the FileInfo pointing to the config file</param>
  9362. </member>
  9363. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9364. <summary>
  9365. Attempt to load configuration from a URI
  9366. </summary>
  9367. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9368. <param name="targetRepository">The repository to configure.</param>
  9369. </member>
  9370. <member name="F:log4net.Config.XmlConfiguratorAttribute.declaringType">
  9371. <summary>
  9372. The fully qualified type of the XmlConfiguratorAttribute class.
  9373. </summary>
  9374. <remarks>
  9375. Used by the internal logger to record the Type of the
  9376. log message.
  9377. </remarks>
  9378. </member>
  9379. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile">
  9380. <summary>
  9381. Gets or sets the filename of the configuration file.
  9382. </summary>
  9383. <value>
  9384. The filename of the configuration file.
  9385. </value>
  9386. <remarks>
  9387. <para>
  9388. If specified, this is the name of the configuration file to use with
  9389. the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the
  9390. <b>application base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>).
  9391. </para>
  9392. <para>
  9393. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  9394. </para>
  9395. </remarks>
  9396. </member>
  9397. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension">
  9398. <summary>
  9399. Gets or sets the extension of the configuration file.
  9400. </summary>
  9401. <value>
  9402. The extension of the configuration file.
  9403. </value>
  9404. <remarks>
  9405. <para>
  9406. If specified this is the extension for the configuration file.
  9407. The path to the config file is built by using the <b>application
  9408. base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>),
  9409. the <b>assembly file name</b> and the config file extension.
  9410. </para>
  9411. <para>
  9412. If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then
  9413. possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or
  9414. <c>MyClassLibrary.dll.MyExt</c>.
  9415. </para>
  9416. <para>
  9417. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  9418. </para>
  9419. </remarks>
  9420. </member>
  9421. <member name="P:log4net.Config.XmlConfiguratorAttribute.Watch">
  9422. <summary>
  9423. Gets or sets a value indicating whether to watch the configuration file.
  9424. </summary>
  9425. <value>
  9426. <c>true</c> if the configuration should be watched, <c>false</c> otherwise.
  9427. </value>
  9428. <remarks>
  9429. <para>
  9430. If this flag is specified and set to <c>true</c> then the framework
  9431. will watch the configuration file and will reload the config each time
  9432. the file is modified.
  9433. </para>
  9434. <para>
  9435. The config file can only be watched if it is loaded from local disk.
  9436. In a No-Touch (Smart Client) deployment where the application is downloaded
  9437. from a web server the config file may not reside on the local disk
  9438. and therefore it may not be able to watch it.
  9439. </para>
  9440. <note>
  9441. Watching configuration is not supported on the SSCLI.
  9442. </note>
  9443. </remarks>
  9444. </member>
  9445. <member name="T:log4net.Config.Log4NetConfigurationSectionHandler">
  9446. <summary>
  9447. Class to register for the log4net section of the configuration file
  9448. </summary>
  9449. <remarks>
  9450. The log4net section of the configuration file needs to have a section
  9451. handler registered. This is the section handler used. It simply returns
  9452. the XML element that is the root of the section.
  9453. </remarks>
  9454. <example>
  9455. Example of registering the log4net section handler :
  9456. <code lang="XML" escaped="true">
  9457. <configuration>
  9458. <configSections>
  9459. <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  9460. </configSections>
  9461. <log4net>
  9462. log4net configuration XML goes here
  9463. </log4net>
  9464. </configuration>
  9465. </code>
  9466. </example>
  9467. <author>Nicko Cadell</author>
  9468. <author>Gert Driesen</author>
  9469. </member>
  9470. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.#ctor">
  9471. <summary>
  9472. Initializes a new instance of the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> class.
  9473. </summary>
  9474. <remarks>
  9475. <para>
  9476. Default constructor.
  9477. </para>
  9478. </remarks>
  9479. </member>
  9480. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.Create(System.Object,System.Object,System.Xml.XmlNode)">
  9481. <summary>
  9482. Parses the configuration section.
  9483. </summary>
  9484. <param name="parent">The configuration settings in a corresponding parent configuration section.</param>
  9485. <param name="configContext">The configuration context when called from the ASP.NET configuration system. Otherwise, this parameter is reserved and is a null reference.</param>
  9486. <param name="section">The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</param>
  9487. <returns>The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</returns>
  9488. <remarks>
  9489. <para>
  9490. Returns the <see cref="T:System.Xml.XmlNode"/> containing the configuration data,
  9491. </para>
  9492. </remarks>
  9493. </member>
  9494. <member name="T:log4net.Config.PluginAttribute">
  9495. <summary>
  9496. Assembly level attribute that specifies a plugin to attach to
  9497. the repository.
  9498. </summary>
  9499. <remarks>
  9500. <para>
  9501. Specifies the type of a plugin to create and attach to the
  9502. assembly's repository. The plugin type must implement the
  9503. <see cref="T:log4net.Plugin.IPlugin"/> interface.
  9504. </para>
  9505. </remarks>
  9506. <author>Nicko Cadell</author>
  9507. <author>Gert Driesen</author>
  9508. </member>
  9509. <member name="T:log4net.Plugin.IPluginFactory">
  9510. <summary>
  9511. Interface used to create plugins.
  9512. </summary>
  9513. <remarks>
  9514. <para>
  9515. Interface used to create a plugin.
  9516. </para>
  9517. </remarks>
  9518. <author>Nicko Cadell</author>
  9519. <author>Gert Driesen</author>
  9520. </member>
  9521. <member name="M:log4net.Plugin.IPluginFactory.CreatePlugin">
  9522. <summary>
  9523. Creates the plugin object.
  9524. </summary>
  9525. <returns>the new plugin instance</returns>
  9526. <remarks>
  9527. <para>
  9528. Create and return a new plugin instance.
  9529. </para>
  9530. </remarks>
  9531. </member>
  9532. <member name="M:log4net.Config.PluginAttribute.#ctor(System.String)">
  9533. <summary>
  9534. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
  9535. with the specified type.
  9536. </summary>
  9537. <param name="typeName">The type name of plugin to create.</param>
  9538. <remarks>
  9539. <para>
  9540. Create the attribute with the plugin type specified.
  9541. </para>
  9542. <para>
  9543. Where possible use the constructor that takes a <see cref="T:System.Type"/>.
  9544. </para>
  9545. </remarks>
  9546. </member>
  9547. <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)">
  9548. <summary>
  9549. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
  9550. with the specified type.
  9551. </summary>
  9552. <param name="type">The type of plugin to create.</param>
  9553. <remarks>
  9554. <para>
  9555. Create the attribute with the plugin type specified.
  9556. </para>
  9557. </remarks>
  9558. </member>
  9559. <member name="M:log4net.Config.PluginAttribute.CreatePlugin">
  9560. <summary>
  9561. Creates the plugin object defined by this attribute.
  9562. </summary>
  9563. <remarks>
  9564. <para>
  9565. Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as
  9566. specified by this attribute.
  9567. </para>
  9568. </remarks>
  9569. <returns>The plugin object.</returns>
  9570. </member>
  9571. <member name="M:log4net.Config.PluginAttribute.ToString">
  9572. <summary>
  9573. Returns a representation of the properties of this object.
  9574. </summary>
  9575. <remarks>
  9576. <para>
  9577. Overrides base class <see cref="M:Object.ToString()" /> method to
  9578. return a representation of the properties of this object.
  9579. </para>
  9580. </remarks>
  9581. <returns>A representation of the properties of this object</returns>
  9582. </member>
  9583. <member name="P:log4net.Config.PluginAttribute.Type">
  9584. <summary>
  9585. Gets or sets the type for the plugin.
  9586. </summary>
  9587. <value>
  9588. The type for the plugin.
  9589. </value>
  9590. <remarks>
  9591. <para>
  9592. The type for the plugin.
  9593. </para>
  9594. </remarks>
  9595. </member>
  9596. <member name="P:log4net.Config.PluginAttribute.TypeName">
  9597. <summary>
  9598. Gets or sets the type name for the plugin.
  9599. </summary>
  9600. <value>
  9601. The type name for the plugin.
  9602. </value>
  9603. <remarks>
  9604. <para>
  9605. The type name for the plugin.
  9606. </para>
  9607. <para>
  9608. Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead.
  9609. </para>
  9610. </remarks>
  9611. </member>
  9612. <member name="T:log4net.Config.SecurityContextProviderAttribute">
  9613. <summary>
  9614. Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>.
  9615. </summary>
  9616. <remarks>
  9617. <para>
  9618. This attribute may only be used at the assembly scope and can only
  9619. be used once per assembly.
  9620. </para>
  9621. <para>
  9622. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  9623. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  9624. methods.
  9625. </para>
  9626. </remarks>
  9627. <author>Nicko Cadell</author>
  9628. </member>
  9629. <member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)">
  9630. <summary>
  9631. Construct provider attribute with type specified
  9632. </summary>
  9633. <param name="providerType">the type of the provider to use</param>
  9634. <remarks>
  9635. <para>
  9636. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  9637. class.
  9638. </para>
  9639. </remarks>
  9640. </member>
  9641. <member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9642. <summary>
  9643. Configures the SecurityContextProvider
  9644. </summary>
  9645. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9646. <param name="targetRepository">The repository to configure.</param>
  9647. <remarks>
  9648. <para>
  9649. Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified.
  9650. Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>.
  9651. </para>
  9652. </remarks>
  9653. </member>
  9654. <member name="F:log4net.Config.SecurityContextProviderAttribute.declaringType">
  9655. <summary>
  9656. The fully qualified type of the SecurityContextProviderAttribute class.
  9657. </summary>
  9658. <remarks>
  9659. Used by the internal logger to record the Type of the
  9660. log message.
  9661. </remarks>
  9662. </member>
  9663. <member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType">
  9664. <summary>
  9665. Gets or sets the type of the provider to use.
  9666. </summary>
  9667. <value>
  9668. the type of the provider to use.
  9669. </value>
  9670. <remarks>
  9671. <para>
  9672. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  9673. class.
  9674. </para>
  9675. </remarks>
  9676. </member>
  9677. <member name="T:log4net.Config.XmlConfigurator">
  9678. <summary>
  9679. Use this class to initialize the log4net environment using an Xml tree.
  9680. </summary>
  9681. <remarks>
  9682. <para>
  9683. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  9684. </para>
  9685. </remarks>
  9686. <author>Nicko Cadell</author>
  9687. <author>Gert Driesen</author>
  9688. </member>
  9689. <member name="M:log4net.Config.XmlConfigurator.#ctor">
  9690. <summary>
  9691. Private constructor
  9692. </summary>
  9693. </member>
  9694. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  9695. <summary>
  9696. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  9697. stored in the application's configuration file.
  9698. </summary>
  9699. <remarks>
  9700. <para>
  9701. Each application has a configuration file. This has the
  9702. same name as the application with '.config' appended.
  9703. This file is XML and calling this function prompts the
  9704. configurator to look in that file for a section called
  9705. <c>log4net</c> that contains the configuration data.
  9706. </para>
  9707. <para>
  9708. To use this method to configure log4net you must specify
  9709. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  9710. handler for the <c>log4net</c> configuration section. See the
  9711. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  9712. </para>
  9713. </remarks>
  9714. <param name="repository">The repository to configure.</param>
  9715. </member>
  9716. <member name="M:log4net.Config.XmlConfigurator.Configure">
  9717. <summary>
  9718. Automatically configures the log4net system based on the
  9719. application's configuration settings.
  9720. </summary>
  9721. <remarks>
  9722. <para>
  9723. Each application has a configuration file. This has the
  9724. same name as the application with '.config' appended.
  9725. This file is XML and calling this function prompts the
  9726. configurator to look in that file for a section called
  9727. <c>log4net</c> that contains the configuration data.
  9728. </para>
  9729. <para>
  9730. To use this method to configure log4net you must specify
  9731. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  9732. handler for the <c>log4net</c> configuration section. See the
  9733. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  9734. </para>
  9735. </remarks>
  9736. <seealso cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/>
  9737. </member>
  9738. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Xml.XmlElement)">
  9739. <summary>
  9740. Configures log4net using a <c>log4net</c> element
  9741. </summary>
  9742. <remarks>
  9743. <para>
  9744. Loads the log4net configuration from the XML element
  9745. supplied as <paramref name="element"/>.
  9746. </para>
  9747. </remarks>
  9748. <param name="element">The element to parse.</param>
  9749. </member>
  9750. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)">
  9751. <summary>
  9752. Configures log4net using the specified configuration file.
  9753. </summary>
  9754. <param name="configFile">The XML file to load the configuration from.</param>
  9755. <remarks>
  9756. <para>
  9757. The configuration file must be valid XML. It must contain
  9758. at least one element called <c>log4net</c> that holds
  9759. the log4net configuration data.
  9760. </para>
  9761. <para>
  9762. The log4net configuration file can possible be specified in the application's
  9763. configuration file (either <c>MyAppName.exe.config</c> for a
  9764. normal application on <c>Web.config</c> for an ASP.NET application).
  9765. </para>
  9766. <para>
  9767. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  9768. configuration. If this file is also a .NET .config file then you must specify
  9769. a configuration section for the <c>log4net</c> element otherwise .NET will
  9770. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  9771. <code lang="XML" escaped="true">
  9772. <configSections>
  9773. <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
  9774. </configSections>
  9775. </code>
  9776. </para>
  9777. <example>
  9778. The following example configures log4net using a configuration file, of which the
  9779. location is stored in the application's configuration file :
  9780. </example>
  9781. <code lang="C#">
  9782. using log4net.Config;
  9783. using System.IO;
  9784. using System.Configuration;
  9785. ...
  9786. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9787. </code>
  9788. <para>
  9789. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9790. </para>
  9791. <code lang="XML" escaped="true">
  9792. <configuration>
  9793. <appSettings>
  9794. <add key="log4net-config-file" value="log.config"/>
  9795. </appSettings>
  9796. </configuration>
  9797. </code>
  9798. </remarks>
  9799. </member>
  9800. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Uri)">
  9801. <summary>
  9802. Configures log4net using the specified configuration URI.
  9803. </summary>
  9804. <param name="configUri">A URI to load the XML configuration from.</param>
  9805. <remarks>
  9806. <para>
  9807. The configuration data must be valid XML. It must contain
  9808. at least one element called <c>log4net</c> that holds
  9809. the log4net configuration data.
  9810. </para>
  9811. <para>
  9812. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  9813. </para>
  9814. </remarks>
  9815. </member>
  9816. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.Stream)">
  9817. <summary>
  9818. Configures log4net using the specified configuration data stream.
  9819. </summary>
  9820. <param name="configStream">A stream to load the XML configuration from.</param>
  9821. <remarks>
  9822. <para>
  9823. The configuration data must be valid XML. It must contain
  9824. at least one element called <c>log4net</c> that holds
  9825. the log4net configuration data.
  9826. </para>
  9827. <para>
  9828. Note that this method will NOT close the stream parameter.
  9829. </para>
  9830. </remarks>
  9831. </member>
  9832. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9833. <summary>
  9834. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  9835. element.
  9836. </summary>
  9837. <remarks>
  9838. Loads the log4net configuration from the XML element
  9839. supplied as <paramref name="element"/>.
  9840. </remarks>
  9841. <param name="repository">The repository to configure.</param>
  9842. <param name="element">The element to parse.</param>
  9843. </member>
  9844. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9845. <summary>
  9846. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9847. file.
  9848. </summary>
  9849. <param name="repository">The repository to configure.</param>
  9850. <param name="configFile">The XML file to load the configuration from.</param>
  9851. <remarks>
  9852. <para>
  9853. The configuration file must be valid XML. It must contain
  9854. at least one element called <c>log4net</c> that holds
  9855. the configuration data.
  9856. </para>
  9857. <para>
  9858. The log4net configuration file can possible be specified in the application's
  9859. configuration file (either <c>MyAppName.exe.config</c> for a
  9860. normal application on <c>Web.config</c> for an ASP.NET application).
  9861. </para>
  9862. <para>
  9863. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  9864. configuration. If this file is also a .NET .config file then you must specify
  9865. a configuration section for the <c>log4net</c> element otherwise .NET will
  9866. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  9867. <code lang="XML" escaped="true">
  9868. <configSections>
  9869. <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
  9870. </configSections>
  9871. </code>
  9872. </para>
  9873. <example>
  9874. The following example configures log4net using a configuration file, of which the
  9875. location is stored in the application's configuration file :
  9876. </example>
  9877. <code lang="C#">
  9878. using log4net.Config;
  9879. using System.IO;
  9880. using System.Configuration;
  9881. ...
  9882. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9883. </code>
  9884. <para>
  9885. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9886. </para>
  9887. <code lang="XML" escaped="true">
  9888. <configuration>
  9889. <appSettings>
  9890. <add key="log4net-config-file" value="log.config"/>
  9891. </appSettings>
  9892. </configuration>
  9893. </code>
  9894. </remarks>
  9895. </member>
  9896. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)">
  9897. <summary>
  9898. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9899. URI.
  9900. </summary>
  9901. <param name="repository">The repository to configure.</param>
  9902. <param name="configUri">A URI to load the XML configuration from.</param>
  9903. <remarks>
  9904. <para>
  9905. The configuration data must be valid XML. It must contain
  9906. at least one element called <c>log4net</c> that holds
  9907. the configuration data.
  9908. </para>
  9909. <para>
  9910. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  9911. </para>
  9912. </remarks>
  9913. </member>
  9914. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  9915. <summary>
  9916. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9917. file.
  9918. </summary>
  9919. <param name="repository">The repository to configure.</param>
  9920. <param name="configStream">The stream to load the XML configuration from.</param>
  9921. <remarks>
  9922. <para>
  9923. The configuration data must be valid XML. It must contain
  9924. at least one element called <c>log4net</c> that holds
  9925. the configuration data.
  9926. </para>
  9927. <para>
  9928. Note that this method will NOT close the stream parameter.
  9929. </para>
  9930. </remarks>
  9931. </member>
  9932. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  9933. <summary>
  9934. Configures log4net using the file specified, monitors the file for changes
  9935. and reloads the configuration if a change is detected.
  9936. </summary>
  9937. <param name="configFile">The XML file to load the configuration from.</param>
  9938. <remarks>
  9939. <para>
  9940. The configuration file must be valid XML. It must contain
  9941. at least one element called <c>log4net</c> that holds
  9942. the configuration data.
  9943. </para>
  9944. <para>
  9945. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9946. and depends on the behavior of that class.
  9947. </para>
  9948. <para>
  9949. For more information on how to configure log4net using
  9950. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9951. </para>
  9952. </remarks>
  9953. <seealso cref="M:Configure(FileInfo)"/>
  9954. </member>
  9955. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9956. <summary>
  9957. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  9958. monitors the file for changes and reloads the configuration if a change
  9959. is detected.
  9960. </summary>
  9961. <param name="repository">The repository to configure.</param>
  9962. <param name="configFile">The XML file to load the configuration from.</param>
  9963. <remarks>
  9964. <para>
  9965. The configuration file must be valid XML. It must contain
  9966. at least one element called <c>log4net</c> that holds
  9967. the configuration data.
  9968. </para>
  9969. <para>
  9970. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9971. and depends on the behavior of that class.
  9972. </para>
  9973. <para>
  9974. For more information on how to configure log4net using
  9975. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9976. </para>
  9977. </remarks>
  9978. <seealso cref="M:Configure(FileInfo)"/>
  9979. </member>
  9980. <member name="M:log4net.Config.XmlConfigurator.InternalConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9981. <summary>
  9982. Configures the specified repository using a <c>log4net</c> element.
  9983. </summary>
  9984. <param name="repository">The hierarchy to configure.</param>
  9985. <param name="element">The element to parse.</param>
  9986. <remarks>
  9987. <para>
  9988. Loads the log4net configuration from the XML element
  9989. supplied as <paramref name="element"/>.
  9990. </para>
  9991. <para>
  9992. This method is ultimately called by one of the Configure methods
  9993. to load the configuration from an <see cref="T:System.Xml.XmlElement"/>.
  9994. </para>
  9995. </remarks>
  9996. </member>
  9997. <member name="F:log4net.Config.XmlConfigurator.m_repositoryName2ConfigAndWatchHandler">
  9998. <summary>
  9999. Maps repository names to ConfigAndWatchHandler instances to allow a particular
  10000. ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is
  10001. reconfigured.
  10002. </summary>
  10003. </member>
  10004. <member name="F:log4net.Config.XmlConfigurator.declaringType">
  10005. <summary>
  10006. The fully qualified type of the XmlConfigurator class.
  10007. </summary>
  10008. <remarks>
  10009. Used by the internal logger to record the Type of the
  10010. log message.
  10011. </remarks>
  10012. </member>
  10013. <member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler">
  10014. <summary>
  10015. Class used to watch config files.
  10016. </summary>
  10017. <remarks>
  10018. <para>
  10019. Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor
  10020. changes to a specified file. Because multiple change notifications
  10021. may be raised when the file is modified, a timer is used to
  10022. compress the notifications into a single event. The timer
  10023. waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering
  10024. the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/>
  10025. change notifications arrive while the timer is waiting it
  10026. is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to
  10027. elapse.
  10028. </para>
  10029. </remarks>
  10030. </member>
  10031. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis">
  10032. <summary>
  10033. The default amount of time to wait after receiving notification
  10034. before reloading the config file.
  10035. </summary>
  10036. </member>
  10037. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile">
  10038. <summary>
  10039. Holds the FileInfo used to configure the XmlConfigurator
  10040. </summary>
  10041. </member>
  10042. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository">
  10043. <summary>
  10044. Holds the repository being configured.
  10045. </summary>
  10046. </member>
  10047. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer">
  10048. <summary>
  10049. The timer used to compress the notification events.
  10050. </summary>
  10051. </member>
  10052. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_watcher">
  10053. <summary>
  10054. Watches file for changes. This object should be disposed when no longer
  10055. needed to free system handles on the watched resources.
  10056. </summary>
  10057. </member>
  10058. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  10059. <summary>
  10060. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class to
  10061. watch a specified config file used to configure a repository.
  10062. </summary>
  10063. <param name="repository">The repository to configure.</param>
  10064. <param name="configFile">The configuration file to watch.</param>
  10065. <remarks>
  10066. <para>
  10067. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class.
  10068. </para>
  10069. </remarks>
  10070. </member>
  10071. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)">
  10072. <summary>
  10073. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  10074. </summary>
  10075. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  10076. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  10077. <remarks>
  10078. <para>
  10079. This handler reloads the configuration from the file when the event is fired.
  10080. </para>
  10081. </remarks>
  10082. </member>
  10083. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)">
  10084. <summary>
  10085. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  10086. </summary>
  10087. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  10088. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  10089. <remarks>
  10090. <para>
  10091. This handler reloads the configuration from the file when the event is fired.
  10092. </para>
  10093. </remarks>
  10094. </member>
  10095. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)">
  10096. <summary>
  10097. Called by the timer when the configuration has been updated.
  10098. </summary>
  10099. <param name="state">null</param>
  10100. </member>
  10101. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.Dispose">
  10102. <summary>
  10103. Release the handles held by the watcher and timer.
  10104. </summary>
  10105. </member>
  10106. <member name="T:log4net.Core.CompactRepositorySelector">
  10107. <summary>
  10108. The implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface suitable
  10109. for use with the compact framework
  10110. </summary>
  10111. <remarks>
  10112. <para>
  10113. This <see cref="T:log4net.Core.IRepositorySelector"/> implementation is a simple
  10114. mapping between repository name and <see cref="T:log4net.Repository.ILoggerRepository"/>
  10115. object.
  10116. </para>
  10117. <para>
  10118. The .NET Compact Framework 1.0 does not support retrieving assembly
  10119. level attributes therefore unlike the <c>DefaultRepositorySelector</c>
  10120. this selector does not examine the calling assembly for attributes.
  10121. </para>
  10122. </remarks>
  10123. <author>Nicko Cadell</author>
  10124. </member>
  10125. <member name="T:log4net.Core.IRepositorySelector">
  10126. <summary>
  10127. Interface used by the <see cref="T:log4net.LogManager"/> to select the <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10128. </summary>
  10129. <remarks>
  10130. <para>
  10131. The <see cref="T:log4net.LogManager"/> uses a <see cref="T:log4net.Core.IRepositorySelector"/>
  10132. to specify the policy for selecting the correct <see cref="T:log4net.Repository.ILoggerRepository"/>
  10133. to return to the caller.
  10134. </para>
  10135. </remarks>
  10136. <author>Nicko Cadell</author>
  10137. <author>Gert Driesen</author>
  10138. </member>
  10139. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)">
  10140. <summary>
  10141. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10142. </summary>
  10143. <param name="assembly">The assembly to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10144. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly.</returns>
  10145. <remarks>
  10146. <para>
  10147. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10148. </para>
  10149. <para>
  10150. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  10151. is made is not defined. The implementation may choose any method for
  10152. this association. The results of this method must be repeatable, i.e.
  10153. when called again with the same arguments the result must be the
  10154. save value.
  10155. </para>
  10156. </remarks>
  10157. </member>
  10158. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.String)">
  10159. <summary>
  10160. Gets the named <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10161. </summary>
  10162. <param name="repositoryName">The name to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10163. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  10164. <remarks>
  10165. Lookup a named <see cref="T:log4net.Repository.ILoggerRepository"/>. This is the repository created by
  10166. calling <see cref="M:CreateRepository(string,Type)"/>.
  10167. </remarks>
  10168. </member>
  10169. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  10170. <summary>
  10171. Creates a new repository for the assembly specified.
  10172. </summary>
  10173. <param name="assembly">The assembly to use to create the domain to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10174. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10175. <returns>The repository created.</returns>
  10176. <remarks>
  10177. <para>
  10178. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the domain
  10179. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10180. same assembly specified will return the same repository instance.
  10181. </para>
  10182. <para>
  10183. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  10184. is made is not defined. The implementation may choose any method for
  10185. this association.
  10186. </para>
  10187. </remarks>
  10188. </member>
  10189. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)">
  10190. <summary>
  10191. Creates a new repository with the name specified.
  10192. </summary>
  10193. <param name="repositoryName">The name to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10194. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10195. <returns>The repository created.</returns>
  10196. <remarks>
  10197. <para>
  10198. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the name
  10199. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  10200. same name will return the same repository instance.
  10201. </para>
  10202. </remarks>
  10203. </member>
  10204. <member name="M:log4net.Core.IRepositorySelector.ExistsRepository(System.String)">
  10205. <summary>
  10206. Test if a named repository exists
  10207. </summary>
  10208. <param name="repositoryName">the named repository to check</param>
  10209. <returns><c>true</c> if the repository exists</returns>
  10210. <remarks>
  10211. <para>
  10212. Test if a named repository exists. Use <see cref="M:CreateRepository(Assembly, Type)"/>
  10213. to create a new repository and <see cref="M:GetRepository(Assembly)"/> to retrieve
  10214. a repository.
  10215. </para>
  10216. </remarks>
  10217. </member>
  10218. <member name="M:log4net.Core.IRepositorySelector.GetAllRepositories">
  10219. <summary>
  10220. Gets an array of all currently defined repositories.
  10221. </summary>
  10222. <returns>
  10223. An array of the <see cref="T:log4net.Repository.ILoggerRepository"/> instances created by
  10224. this <see cref="T:log4net.Core.IRepositorySelector"/>.</returns>
  10225. <remarks>
  10226. <para>
  10227. Gets an array of all of the repositories created by this selector.
  10228. </para>
  10229. </remarks>
  10230. </member>
  10231. <member name="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent">
  10232. <summary>
  10233. Event to notify that a logger repository has been created.
  10234. </summary>
  10235. <value>
  10236. Event to notify that a logger repository has been created.
  10237. </value>
  10238. <remarks>
  10239. <para>
  10240. Event raised when a new repository is created.
  10241. The event source will be this selector. The event args will
  10242. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  10243. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10244. </para>
  10245. </remarks>
  10246. </member>
  10247. <member name="M:log4net.Core.CompactRepositorySelector.#ctor(System.Type)">
  10248. <summary>
  10249. Create a new repository selector
  10250. </summary>
  10251. <param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10252. <remarks>
  10253. <para>
  10254. Create an new compact repository selector.
  10255. The default type for repositories must be specified,
  10256. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  10257. </para>
  10258. </remarks>
  10259. <exception cref="T:System.ArgumentNullException">throw if <paramref name="defaultRepositoryType"/> is null</exception>
  10260. <exception cref="T:System.ArgumentOutOfRangeException">throw if <paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/></exception>
  10261. </member>
  10262. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)">
  10263. <summary>
  10264. Get the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly
  10265. </summary>
  10266. <param name="assembly">not used</param>
  10267. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  10268. <remarks>
  10269. <para>
  10270. The <paramref name="assembly"/> argument is not used. This selector does not create a
  10271. separate repository for each assembly.
  10272. </para>
  10273. <para>
  10274. As a named repository is not specified the default repository is
  10275. returned. The default repository is named <c>log4net-default-repository</c>.
  10276. </para>
  10277. </remarks>
  10278. </member>
  10279. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)">
  10280. <summary>
  10281. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>
  10282. </summary>
  10283. <param name="repositoryName">the name of the repository to lookup</param>
  10284. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  10285. <remarks>
  10286. <para>
  10287. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>. The default
  10288. repository is <c>log4net-default-repository</c>. Other repositories
  10289. must be created using the <see cref="M:CreateRepository(string, Type)"/>.
  10290. If the named repository does not exist an exception is thrown.
  10291. </para>
  10292. </remarks>
  10293. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  10294. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> does not exist</exception>
  10295. </member>
  10296. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  10297. <summary>
  10298. Create a new repository for the assembly specified
  10299. </summary>
  10300. <param name="assembly">not used</param>
  10301. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10302. <returns>the repository created</returns>
  10303. <remarks>
  10304. <para>
  10305. The <paramref name="assembly"/> argument is not used. This selector does not create a
  10306. separate repository for each assembly.
  10307. </para>
  10308. <para>
  10309. If the <paramref name="repositoryType"/> is <c>null</c> then the
  10310. default repository type specified to the constructor is used.
  10311. </para>
  10312. <para>
  10313. As a named repository is not specified the default repository is
  10314. returned. The default repository is named <c>log4net-default-repository</c>.
  10315. </para>
  10316. </remarks>
  10317. </member>
  10318. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)">
  10319. <summary>
  10320. Create a new repository for the repository specified
  10321. </summary>
  10322. <param name="repositoryName">the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10323. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10324. If this param is null then the default repository type is used.</param>
  10325. <returns>the repository created</returns>
  10326. <remarks>
  10327. <para>
  10328. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10329. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  10330. same repository specified will return the same repository instance.
  10331. </para>
  10332. <para>
  10333. If the named repository already exists an exception will be thrown.
  10334. </para>
  10335. <para>
  10336. If <paramref name="repositoryType"/> is <c>null</c> then the default
  10337. repository type specified to the constructor is used.
  10338. </para>
  10339. </remarks>
  10340. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  10341. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> already exists</exception>
  10342. </member>
  10343. <member name="M:log4net.Core.CompactRepositorySelector.ExistsRepository(System.String)">
  10344. <summary>
  10345. Test if a named repository exists
  10346. </summary>
  10347. <param name="repositoryName">the named repository to check</param>
  10348. <returns><c>true</c> if the repository exists</returns>
  10349. <remarks>
  10350. <para>
  10351. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  10352. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  10353. a repository.
  10354. </para>
  10355. </remarks>
  10356. </member>
  10357. <member name="M:log4net.Core.CompactRepositorySelector.GetAllRepositories">
  10358. <summary>
  10359. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  10360. </summary>
  10361. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  10362. <remarks>
  10363. <para>
  10364. Gets an array of all of the repositories created by this selector.
  10365. </para>
  10366. </remarks>
  10367. </member>
  10368. <member name="F:log4net.Core.CompactRepositorySelector.declaringType">
  10369. <summary>
  10370. The fully qualified type of the CompactRepositorySelector class.
  10371. </summary>
  10372. <remarks>
  10373. Used by the internal logger to record the Type of the
  10374. log message.
  10375. </remarks>
  10376. </member>
  10377. <member name="M:log4net.Core.CompactRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  10378. <summary>
  10379. Notify the registered listeners that the repository has been created
  10380. </summary>
  10381. <param name="repository">The repository that has been created</param>
  10382. <remarks>
  10383. <para>
  10384. Raises the <event cref="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">LoggerRepositoryCreatedEvent</event>
  10385. event.
  10386. </para>
  10387. </remarks>
  10388. </member>
  10389. <member name="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">
  10390. <summary>
  10391. Event to notify that a logger repository has been created.
  10392. </summary>
  10393. <value>
  10394. Event to notify that a logger repository has been created.
  10395. </value>
  10396. <remarks>
  10397. <para>
  10398. Event raised when a new repository is created.
  10399. The event source will be this selector. The event args will
  10400. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  10401. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10402. </para>
  10403. </remarks>
  10404. </member>
  10405. <member name="T:log4net.Core.DefaultRepositorySelector">
  10406. <summary>
  10407. The default implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface.
  10408. </summary>
  10409. <remarks>
  10410. <para>
  10411. Uses attributes defined on the calling assembly to determine how to
  10412. configure the hierarchy for the repository.
  10413. </para>
  10414. </remarks>
  10415. <author>Nicko Cadell</author>
  10416. <author>Gert Driesen</author>
  10417. </member>
  10418. <member name="M:log4net.Core.DefaultRepositorySelector.#ctor(System.Type)">
  10419. <summary>
  10420. Creates a new repository selector.
  10421. </summary>
  10422. <param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10423. <remarks>
  10424. <para>
  10425. Create an new repository selector.
  10426. The default type for repositories must be specified,
  10427. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  10428. </para>
  10429. </remarks>
  10430. <exception cref="T:System.ArgumentNullException"><paramref name="defaultRepositoryType"/> is <see langword="null"/>.</exception>
  10431. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</exception>
  10432. </member>
  10433. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)">
  10434. <summary>
  10435. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10436. </summary>
  10437. <param name="repositoryAssembly">The assembly use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10438. <remarks>
  10439. <para>
  10440. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository
  10441. to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/>
  10442. attribute on the <paramref name="repositoryAssembly"/>.
  10443. </para>
  10444. <para>
  10445. The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  10446. implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10447. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10448. </para>
  10449. <para>
  10450. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using
  10451. any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on
  10452. the <paramref name="repositoryAssembly"/>.
  10453. </para>
  10454. </remarks>
  10455. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns>
  10456. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  10457. </member>
  10458. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)">
  10459. <summary>
  10460. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.
  10461. </summary>
  10462. <param name="repositoryName">The repository to use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10463. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.</returns>
  10464. <remarks>
  10465. <para>
  10466. Returns the named repository. If <paramref name="repositoryName"/> is <c>null</c>
  10467. a <see cref="T:System.ArgumentNullException"/> is thrown. If the repository
  10468. does not exist a <see cref="T:log4net.Core.LogException"/> is thrown.
  10469. </para>
  10470. <para>
  10471. Use <see cref="M:CreateRepository(string, Type)"/> to create a repository.
  10472. </para>
  10473. </remarks>
  10474. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
  10475. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> does not exist.</exception>
  10476. </member>
  10477. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  10478. <summary>
  10479. Create a new repository for the assembly specified
  10480. </summary>
  10481. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10482. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10483. <returns>The repository created.</returns>
  10484. <remarks>
  10485. <para>
  10486. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10487. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10488. same assembly specified will return the same repository instance.
  10489. </para>
  10490. <para>
  10491. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  10492. the repository to create can be overridden by specifying the
  10493. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10494. <paramref name="repositoryAssembly"/>. The default values are to use the
  10495. <paramref name="repositoryType"/> implementation of the
  10496. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10497. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10498. </para>
  10499. <para>
  10500. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  10501. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10502. attributes defined on the <paramref name="repositoryAssembly"/>.
  10503. </para>
  10504. <para>
  10505. If a repository for the <paramref name="repositoryAssembly"/> already exists
  10506. that repository will be returned. An error will not be raised and that
  10507. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  10508. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10509. assembly may be used to override the repository type specified in
  10510. <paramref name="repositoryType"/>.
  10511. </para>
  10512. </remarks>
  10513. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  10514. </member>
  10515. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type,System.String,System.Boolean)">
  10516. <summary>
  10517. Creates a new repository for the assembly specified.
  10518. </summary>
  10519. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10520. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10521. <param name="repositoryName">The name to assign to the created repository</param>
  10522. <param name="readAssemblyAttributes">Set to <c>true</c> to read and apply the assembly attributes</param>
  10523. <returns>The repository created.</returns>
  10524. <remarks>
  10525. <para>
  10526. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10527. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10528. same assembly specified will return the same repository instance.
  10529. </para>
  10530. <para>
  10531. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  10532. the repository to create can be overridden by specifying the
  10533. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10534. <paramref name="repositoryAssembly"/>. The default values are to use the
  10535. <paramref name="repositoryType"/> implementation of the
  10536. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10537. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10538. </para>
  10539. <para>
  10540. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  10541. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10542. attributes defined on the <paramref name="repositoryAssembly"/>.
  10543. </para>
  10544. <para>
  10545. If a repository for the <paramref name="repositoryAssembly"/> already exists
  10546. that repository will be returned. An error will not be raised and that
  10547. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  10548. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10549. assembly may be used to override the repository type specified in
  10550. <paramref name="repositoryType"/>.
  10551. </para>
  10552. </remarks>
  10553. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  10554. </member>
  10555. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)">
  10556. <summary>
  10557. Creates a new repository for the specified repository.
  10558. </summary>
  10559. <param name="repositoryName">The repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10560. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10561. If this param is <see langword="null"/> then the default repository type is used.</param>
  10562. <returns>The new repository.</returns>
  10563. <remarks>
  10564. <para>
  10565. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10566. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  10567. same repository specified will return the same repository instance.
  10568. </para>
  10569. </remarks>
  10570. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
  10571. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> already exists.</exception>
  10572. </member>
  10573. <member name="M:log4net.Core.DefaultRepositorySelector.ExistsRepository(System.String)">
  10574. <summary>
  10575. Test if a named repository exists
  10576. </summary>
  10577. <param name="repositoryName">the named repository to check</param>
  10578. <returns><c>true</c> if the repository exists</returns>
  10579. <remarks>
  10580. <para>
  10581. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  10582. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  10583. a repository.
  10584. </para>
  10585. </remarks>
  10586. </member>
  10587. <member name="M:log4net.Core.DefaultRepositorySelector.GetAllRepositories">
  10588. <summary>
  10589. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  10590. </summary>
  10591. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  10592. <remarks>
  10593. <para>
  10594. Gets an array of all of the repositories created by this selector.
  10595. </para>
  10596. </remarks>
  10597. </member>
  10598. <member name="M:log4net.Core.DefaultRepositorySelector.AliasRepository(System.String,log4net.Repository.ILoggerRepository)">
  10599. <summary>
  10600. Aliases a repository to an existing repository.
  10601. </summary>
  10602. <param name="repositoryAlias">The repository to alias.</param>
  10603. <param name="repositoryTarget">The repository that the repository is aliased to.</param>
  10604. <remarks>
  10605. <para>
  10606. The repository specified will be aliased to the repository when created.
  10607. The repository must not already exist.
  10608. </para>
  10609. <para>
  10610. When the repository is created it must utilize the same repository type as
  10611. the repository it is aliased to, otherwise the aliasing will fail.
  10612. </para>
  10613. </remarks>
  10614. <exception cref="T:System.ArgumentNullException">
  10615. <para><paramref name="repositoryAlias"/> is <see langword="null"/>.</para>
  10616. <para>-or-</para>
  10617. <para><paramref name="repositoryTarget"/> is <see langword="null"/>.</para>
  10618. </exception>
  10619. </member>
  10620. <member name="M:log4net.Core.DefaultRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  10621. <summary>
  10622. Notifies the registered listeners that the repository has been created.
  10623. </summary>
  10624. <param name="repository">The repository that has been created.</param>
  10625. <remarks>
  10626. <para>
  10627. Raises the <see cref="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  10628. </para>
  10629. </remarks>
  10630. </member>
  10631. <member name="M:log4net.Core.DefaultRepositorySelector.GetInfoForAssembly(System.Reflection.Assembly,System.String@,System.Type@)">
  10632. <summary>
  10633. Gets the repository name and repository type for the specified assembly.
  10634. </summary>
  10635. <param name="assembly">The assembly that has a <see cref="T:log4net.Config.RepositoryAttribute"/>.</param>
  10636. <param name="repositoryName">in/out param to hold the repository name to use for the assembly, caller should set this to the default value before calling.</param>
  10637. <param name="repositoryType">in/out param to hold the type of the repository to create for the assembly, caller should set this to the default value before calling.</param>
  10638. <exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is <see langword="null"/>.</exception>
  10639. </member>
  10640. <member name="M:log4net.Core.DefaultRepositorySelector.ConfigureRepository(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10641. <summary>
  10642. Configures the repository using information from the assembly.
  10643. </summary>
  10644. <param name="assembly">The assembly containing <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10645. attributes which define the configuration for the repository.</param>
  10646. <param name="repository">The repository to configure.</param>
  10647. <exception cref="T:System.ArgumentNullException">
  10648. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  10649. <para>-or-</para>
  10650. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  10651. </exception>
  10652. </member>
  10653. <member name="M:log4net.Core.DefaultRepositorySelector.LoadPlugins(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10654. <summary>
  10655. Loads the attribute defined plugins on the assembly.
  10656. </summary>
  10657. <param name="assembly">The assembly that contains the attributes.</param>
  10658. <param name="repository">The repository to add the plugins to.</param>
  10659. <exception cref="T:System.ArgumentNullException">
  10660. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  10661. <para>-or-</para>
  10662. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  10663. </exception>
  10664. </member>
  10665. <member name="M:log4net.Core.DefaultRepositorySelector.LoadAliases(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10666. <summary>
  10667. Loads the attribute defined aliases on the assembly.
  10668. </summary>
  10669. <param name="assembly">The assembly that contains the attributes.</param>
  10670. <param name="repository">The repository to alias to.</param>
  10671. <exception cref="T:System.ArgumentNullException">
  10672. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  10673. <para>-or-</para>
  10674. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  10675. </exception>
  10676. </member>
  10677. <member name="F:log4net.Core.DefaultRepositorySelector.declaringType">
  10678. <summary>
  10679. The fully qualified type of the DefaultRepositorySelector class.
  10680. </summary>
  10681. <remarks>
  10682. Used by the internal logger to record the Type of the
  10683. log message.
  10684. </remarks>
  10685. </member>
  10686. <member name="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent">
  10687. <summary>
  10688. Event to notify that a logger repository has been created.
  10689. </summary>
  10690. <value>
  10691. Event to notify that a logger repository has been created.
  10692. </value>
  10693. <remarks>
  10694. <para>
  10695. Event raised when a new repository is created.
  10696. The event source will be this selector. The event args will
  10697. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  10698. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10699. </para>
  10700. </remarks>
  10701. </member>
  10702. <member name="T:log4net.Core.ErrorCode">
  10703. <summary>
  10704. Defined error codes that can be passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  10705. </summary>
  10706. <remarks>
  10707. <para>
  10708. Values passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  10709. </para>
  10710. </remarks>
  10711. <author>Nicko Cadell</author>
  10712. </member>
  10713. <member name="F:log4net.Core.ErrorCode.GenericFailure">
  10714. <summary>
  10715. A general error
  10716. </summary>
  10717. </member>
  10718. <member name="F:log4net.Core.ErrorCode.WriteFailure">
  10719. <summary>
  10720. Error while writing output
  10721. </summary>
  10722. </member>
  10723. <member name="F:log4net.Core.ErrorCode.FlushFailure">
  10724. <summary>
  10725. Failed to flush file
  10726. </summary>
  10727. </member>
  10728. <member name="F:log4net.Core.ErrorCode.CloseFailure">
  10729. <summary>
  10730. Failed to close file
  10731. </summary>
  10732. </member>
  10733. <member name="F:log4net.Core.ErrorCode.FileOpenFailure">
  10734. <summary>
  10735. Unable to open output file
  10736. </summary>
  10737. </member>
  10738. <member name="F:log4net.Core.ErrorCode.MissingLayout">
  10739. <summary>
  10740. No layout specified
  10741. </summary>
  10742. </member>
  10743. <member name="F:log4net.Core.ErrorCode.AddressParseFailure">
  10744. <summary>
  10745. Failed to parse address
  10746. </summary>
  10747. </member>
  10748. <member name="T:log4net.Core.ExceptionEvaluator">
  10749. <summary>
  10750. An evaluator that triggers on an Exception type
  10751. </summary>
  10752. <remarks>
  10753. <para>
  10754. This evaluator will trigger if the type of the Exception
  10755. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  10756. is equal to a Type in <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. ///
  10757. </para>
  10758. </remarks>
  10759. <author>Drew Schaeffer</author>
  10760. </member>
  10761. <member name="T:log4net.Core.ITriggeringEventEvaluator">
  10762. <summary>
  10763. Test if an <see cref="T:log4net.Core.LoggingEvent"/> triggers an action
  10764. </summary>
  10765. <remarks>
  10766. <para>
  10767. Implementations of this interface allow certain appenders to decide
  10768. when to perform an appender specific action.
  10769. </para>
  10770. <para>
  10771. The action or behavior triggered is defined by the implementation.
  10772. </para>
  10773. </remarks>
  10774. <author>Nicko Cadell</author>
  10775. </member>
  10776. <member name="M:log4net.Core.ITriggeringEventEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  10777. <summary>
  10778. Test if this event triggers the action
  10779. </summary>
  10780. <param name="loggingEvent">The event to check</param>
  10781. <returns><c>true</c> if this event triggers the action, otherwise <c>false</c></returns>
  10782. <remarks>
  10783. <para>
  10784. Return <c>true</c> if this event triggers the action
  10785. </para>
  10786. </remarks>
  10787. </member>
  10788. <member name="F:log4net.Core.ExceptionEvaluator.m_type">
  10789. <summary>
  10790. The type that causes the trigger to fire.
  10791. </summary>
  10792. </member>
  10793. <member name="F:log4net.Core.ExceptionEvaluator.m_triggerOnSubclass">
  10794. <summary>
  10795. Causes subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/> to cause the trigger to fire.
  10796. </summary>
  10797. </member>
  10798. <member name="M:log4net.Core.ExceptionEvaluator.#ctor">
  10799. <summary>
  10800. Default ctor to allow dynamic creation through a configurator.
  10801. </summary>
  10802. </member>
  10803. <member name="M:log4net.Core.ExceptionEvaluator.#ctor(System.Type,System.Boolean)">
  10804. <summary>
  10805. Constructs an evaluator and initializes to trigger on <paramref name="exType"/>
  10806. </summary>
  10807. <param name="exType">the type that triggers this evaluator.</param>
  10808. <param name="triggerOnSubClass">If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.</param>
  10809. </member>
  10810. <member name="M:log4net.Core.ExceptionEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  10811. <summary>
  10812. Is this <paramref name="loggingEvent"/> the triggering event?
  10813. </summary>
  10814. <param name="loggingEvent">The event to check</param>
  10815. <returns>This method returns <c>true</c>, if the logging event Exception
  10816. Type is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10817. Otherwise it returns <c>false</c></returns>
  10818. <remarks>
  10819. <para>
  10820. This evaluator will trigger if the Exception Type of the event
  10821. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  10822. is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10823. </para>
  10824. </remarks>
  10825. </member>
  10826. <member name="P:log4net.Core.ExceptionEvaluator.ExceptionType">
  10827. <summary>
  10828. The type that triggers this evaluator.
  10829. </summary>
  10830. </member>
  10831. <member name="P:log4net.Core.ExceptionEvaluator.TriggerOnSubclass">
  10832. <summary>
  10833. If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10834. </summary>
  10835. </member>
  10836. <member name="T:log4net.Core.IErrorHandler">
  10837. <summary>
  10838. Appenders may delegate their error handling to an <see cref="T:log4net.Core.IErrorHandler"/>.
  10839. </summary>
  10840. <remarks>
  10841. <para>
  10842. Error handling is a particularly tedious to get right because by
  10843. definition errors are hard to predict and to reproduce.
  10844. </para>
  10845. </remarks>
  10846. <author>Nicko Cadell</author>
  10847. <author>Gert Driesen</author>
  10848. </member>
  10849. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  10850. <summary>
  10851. Handles the error and information about the error condition is passed as
  10852. a parameter.
  10853. </summary>
  10854. <param name="message">The message associated with the error.</param>
  10855. <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
  10856. <param name="errorCode">The error code associated with the error.</param>
  10857. <remarks>
  10858. <para>
  10859. Handles the error and information about the error condition is passed as
  10860. a parameter.
  10861. </para>
  10862. </remarks>
  10863. </member>
  10864. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception)">
  10865. <summary>
  10866. Prints the error message passed as a parameter.
  10867. </summary>
  10868. <param name="message">The message associated with the error.</param>
  10869. <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
  10870. <remarks>
  10871. <para>
  10872. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  10873. </para>
  10874. </remarks>
  10875. </member>
  10876. <member name="M:log4net.Core.IErrorHandler.Error(System.String)">
  10877. <summary>
  10878. Prints the error message passed as a parameter.
  10879. </summary>
  10880. <param name="message">The message associated with the error.</param>
  10881. <remarks>
  10882. <para>
  10883. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  10884. </para>
  10885. </remarks>
  10886. </member>
  10887. <member name="T:log4net.Core.IFixingRequired">
  10888. <summary>
  10889. Interface for objects that require fixing.
  10890. </summary>
  10891. <remarks>
  10892. <para>
  10893. Interface that indicates that the object requires fixing before it
  10894. can be taken outside the context of the appender's
  10895. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  10896. </para>
  10897. <para>
  10898. When objects that implement this interface are stored
  10899. in the context properties maps <see cref="T:log4net.GlobalContext"/>
  10900. <see cref="P:log4net.GlobalContext.Properties"/> and <see cref="T:log4net.ThreadContext"/>
  10901. <see cref="P:log4net.ThreadContext.Properties"/> are fixed
  10902. (see <see cref="P:log4net.Core.LoggingEvent.Fix"/>) the <see cref="M:log4net.Core.IFixingRequired.GetFixedObject"/>
  10903. method will be called.
  10904. </para>
  10905. </remarks>
  10906. <author>Nicko Cadell</author>
  10907. </member>
  10908. <member name="M:log4net.Core.IFixingRequired.GetFixedObject">
  10909. <summary>
  10910. Get a portable version of this object
  10911. </summary>
  10912. <returns>the portable instance of this object</returns>
  10913. <remarks>
  10914. <para>
  10915. Get a portable instance object that represents the current
  10916. state of this object. The portable object can be stored
  10917. and logged from any thread with identical results.
  10918. </para>
  10919. </remarks>
  10920. </member>
  10921. <member name="T:log4net.Core.ILogger">
  10922. <summary>
  10923. Interface that all loggers implement
  10924. </summary>
  10925. <remarks>
  10926. <para>
  10927. This interface supports logging events and testing if a level
  10928. is enabled for logging.
  10929. </para>
  10930. <para>
  10931. These methods will not throw exceptions. Note to implementor, ensure
  10932. that the implementation of these methods cannot allow an exception
  10933. to be thrown to the caller.
  10934. </para>
  10935. </remarks>
  10936. <author>Nicko Cadell</author>
  10937. <author>Gert Driesen</author>
  10938. </member>
  10939. <member name="M:log4net.Core.ILogger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  10940. <summary>
  10941. This generic form is intended to be used by wrappers.
  10942. </summary>
  10943. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  10944. the stack boundary into the logging system for this call.</param>
  10945. <param name="level">The level of the message to be logged.</param>
  10946. <param name="message">The message object to log.</param>
  10947. <param name="exception">the exception to log, including its stack trace. Pass <c>null</c> to not log an exception.</param>
  10948. <remarks>
  10949. <para>
  10950. Generates a logging event for the specified <paramref name="level"/> using
  10951. the <paramref name="message"/> and <paramref name="exception"/>.
  10952. </para>
  10953. </remarks>
  10954. </member>
  10955. <member name="M:log4net.Core.ILogger.Log(log4net.Core.LoggingEvent)">
  10956. <summary>
  10957. This is the most generic printing method that is intended to be used
  10958. by wrappers.
  10959. </summary>
  10960. <param name="logEvent">The event being logged.</param>
  10961. <remarks>
  10962. <para>
  10963. Logs the specified logging event through this logger.
  10964. </para>
  10965. </remarks>
  10966. </member>
  10967. <member name="M:log4net.Core.ILogger.IsEnabledFor(log4net.Core.Level)">
  10968. <summary>
  10969. Checks if this logger is enabled for a given <see cref="T:log4net.Core.Level"/> passed as parameter.
  10970. </summary>
  10971. <param name="level">The level to check.</param>
  10972. <returns>
  10973. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  10974. </returns>
  10975. <remarks>
  10976. <para>
  10977. Test if this logger is going to log events of the specified <paramref name="level"/>.
  10978. </para>
  10979. </remarks>
  10980. </member>
  10981. <member name="P:log4net.Core.ILogger.Name">
  10982. <summary>
  10983. Gets the name of the logger.
  10984. </summary>
  10985. <value>
  10986. The name of the logger.
  10987. </value>
  10988. <remarks>
  10989. <para>
  10990. The name of this logger
  10991. </para>
  10992. </remarks>
  10993. </member>
  10994. <member name="P:log4net.Core.ILogger.Repository">
  10995. <summary>
  10996. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  10997. <c>Logger</c> instance is attached to.
  10998. </summary>
  10999. <value>
  11000. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to.
  11001. </value>
  11002. <remarks>
  11003. <para>
  11004. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  11005. <c>Logger</c> instance is attached to.
  11006. </para>
  11007. </remarks>
  11008. </member>
  11009. <member name="T:log4net.Core.ILoggerWrapper">
  11010. <summary>
  11011. Base interface for all wrappers
  11012. </summary>
  11013. <remarks>
  11014. <para>
  11015. Base interface for all wrappers.
  11016. </para>
  11017. <para>
  11018. All wrappers must implement this interface.
  11019. </para>
  11020. </remarks>
  11021. <author>Nicko Cadell</author>
  11022. </member>
  11023. <member name="P:log4net.Core.ILoggerWrapper.Logger">
  11024. <summary>
  11025. Get the implementation behind this wrapper object.
  11026. </summary>
  11027. <value>
  11028. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this object.
  11029. </value>
  11030. <remarks>
  11031. <para>
  11032. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this
  11033. object. The <c>Logger</c> object may not
  11034. be the same object as this object because of logger decorators.
  11035. This gets the actual underlying objects that is used to process
  11036. the log events.
  11037. </para>
  11038. </remarks>
  11039. </member>
  11040. <member name="T:log4net.Core.LoggerRepositoryCreationEventHandler">
  11041. <summary>
  11042. Delegate used to handle logger repository creation event notifications
  11043. </summary>
  11044. <param name="sender">The <see cref="T:log4net.Core.IRepositorySelector"/> which created the repository.</param>
  11045. <param name="e">The <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> event args
  11046. that holds the <see cref="T:log4net.Repository.ILoggerRepository"/> instance that has been created.</param>
  11047. <remarks>
  11048. <para>
  11049. Delegate used to handle logger repository creation event notifications.
  11050. </para>
  11051. </remarks>
  11052. </member>
  11053. <member name="T:log4net.Core.LoggerRepositoryCreationEventArgs">
  11054. <summary>
  11055. Provides data for the <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  11056. </summary>
  11057. <remarks>
  11058. <para>
  11059. A <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/>
  11060. event is raised every time a <see cref="T:log4net.Repository.ILoggerRepository"/> is created.
  11061. </para>
  11062. </remarks>
  11063. </member>
  11064. <member name="F:log4net.Core.LoggerRepositoryCreationEventArgs.m_repository">
  11065. <summary>
  11066. The <see cref="T:log4net.Repository.ILoggerRepository"/> created
  11067. </summary>
  11068. </member>
  11069. <member name="M:log4net.Core.LoggerRepositoryCreationEventArgs.#ctor(log4net.Repository.ILoggerRepository)">
  11070. <summary>
  11071. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  11072. </summary>
  11073. <param name="repository">the <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created</param>
  11074. <remarks>
  11075. <para>
  11076. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  11077. </para>
  11078. </remarks>
  11079. </member>
  11080. <member name="P:log4net.Core.LoggerRepositoryCreationEventArgs.LoggerRepository">
  11081. <summary>
  11082. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  11083. </summary>
  11084. <value>
  11085. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  11086. </value>
  11087. <remarks>
  11088. <para>
  11089. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  11090. </para>
  11091. </remarks>
  11092. </member>
  11093. <member name="T:log4net.Core.Level">
  11094. <summary>
  11095. Defines the default set of levels recognized by the system.
  11096. </summary>
  11097. <remarks>
  11098. <para>
  11099. Each <see cref="T:log4net.Core.LoggingEvent"/> has an associated <see cref="T:log4net.Core.Level"/>.
  11100. </para>
  11101. <para>
  11102. Levels have a numeric <see cref="P:log4net.Core.Level.Value"/> that defines the relative
  11103. ordering between levels. Two Levels with the same <see cref="P:log4net.Core.Level.Value"/>
  11104. are deemed to be equivalent.
  11105. </para>
  11106. <para>
  11107. The levels that are recognized by log4net are set for each <see cref="T:log4net.Repository.ILoggerRepository"/>
  11108. and each repository can have different levels defined. The levels are stored
  11109. in the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> on the repository. Levels are
  11110. looked up by name from the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>.
  11111. </para>
  11112. <para>
  11113. When logging at level INFO the actual level used is not <see cref="F:log4net.Core.Level.Info"/> but
  11114. the value of <c>LoggerRepository.LevelMap["INFO"]</c>. The default value for this is
  11115. <see cref="F:log4net.Core.Level.Info"/>, but this can be changed by reconfiguring the level map.
  11116. </para>
  11117. <para>
  11118. Each level has a <see cref="P:log4net.Core.Level.DisplayName"/> in addition to its <see cref="P:log4net.Core.Level.Name"/>. The
  11119. <see cref="P:log4net.Core.Level.DisplayName"/> is the string that is written into the output log. By default
  11120. the display name is the same as the level name, but this can be used to alias levels
  11121. or to localize the log output.
  11122. </para>
  11123. <para>
  11124. Some of the predefined levels recognized by the system are:
  11125. </para>
  11126. <list type="bullet">
  11127. <item>
  11128. <description><see cref="F:log4net.Core.Level.Off"/>.</description>
  11129. </item>
  11130. <item>
  11131. <description><see cref="F:log4net.Core.Level.Fatal"/>.</description>
  11132. </item>
  11133. <item>
  11134. <description><see cref="F:log4net.Core.Level.Error"/>.</description>
  11135. </item>
  11136. <item>
  11137. <description><see cref="F:log4net.Core.Level.Warn"/>.</description>
  11138. </item>
  11139. <item>
  11140. <description><see cref="F:log4net.Core.Level.Info"/>.</description>
  11141. </item>
  11142. <item>
  11143. <description><see cref="F:log4net.Core.Level.Debug"/>.</description>
  11144. </item>
  11145. <item>
  11146. <description><see cref="F:log4net.Core.Level.All"/>.</description>
  11147. </item>
  11148. </list>
  11149. </remarks>
  11150. <author>Nicko Cadell</author>
  11151. <author>Gert Driesen</author>
  11152. </member>
  11153. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String,System.String)">
  11154. <summary>
  11155. Constructor
  11156. </summary>
  11157. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  11158. <param name="levelName">The string name of this level.</param>
  11159. <param name="displayName">The display name for this level. This may be localized or otherwise different from the name</param>
  11160. <remarks>
  11161. <para>
  11162. Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
  11163. the specified level name and value.
  11164. </para>
  11165. </remarks>
  11166. </member>
  11167. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String)">
  11168. <summary>
  11169. Constructor
  11170. </summary>
  11171. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  11172. <param name="levelName">The string name of this level.</param>
  11173. <remarks>
  11174. <para>
  11175. Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
  11176. the specified level name and value.
  11177. </para>
  11178. </remarks>
  11179. </member>
  11180. <member name="M:log4net.Core.Level.ToString">
  11181. <summary>
  11182. Returns the <see cref="T:System.String"/> representation of the current
  11183. <see cref="T:log4net.Core.Level"/>.
  11184. </summary>
  11185. <returns>
  11186. A <see cref="T:System.String"/> representation of the current <see cref="T:log4net.Core.Level"/>.
  11187. </returns>
  11188. <remarks>
  11189. <para>
  11190. Returns the level <see cref="P:log4net.Core.Level.Name"/>.
  11191. </para>
  11192. </remarks>
  11193. </member>
  11194. <member name="M:log4net.Core.Level.Equals(System.Object)">
  11195. <summary>
  11196. Compares levels.
  11197. </summary>
  11198. <param name="o">The object to compare against.</param>
  11199. <returns><c>true</c> if the objects are equal.</returns>
  11200. <remarks>
  11201. <para>
  11202. Compares the levels of <see cref="T:log4net.Core.Level"/> instances, and
  11203. defers to base class if the target object is not a <see cref="T:log4net.Core.Level"/>
  11204. instance.
  11205. </para>
  11206. </remarks>
  11207. </member>
  11208. <member name="M:log4net.Core.Level.GetHashCode">
  11209. <summary>
  11210. Returns a hash code
  11211. </summary>
  11212. <returns>A hash code for the current <see cref="T:log4net.Core.Level"/>.</returns>
  11213. <remarks>
  11214. <para>
  11215. Returns a hash code suitable for use in hashing algorithms and data
  11216. structures like a hash table.
  11217. </para>
  11218. <para>
  11219. Returns the hash code of the level <see cref="P:log4net.Core.Level.Value"/>.
  11220. </para>
  11221. </remarks>
  11222. </member>
  11223. <member name="M:log4net.Core.Level.CompareTo(System.Object)">
  11224. <summary>
  11225. Compares this instance to a specified object and returns an
  11226. indication of their relative values.
  11227. </summary>
  11228. <param name="r">A <see cref="T:log4net.Core.Level"/> instance or <see langword="null"/> to compare with this instance.</param>
  11229. <returns>
  11230. A 32-bit signed integer that indicates the relative order of the
  11231. values compared. The return value has these meanings:
  11232. <list type="table">
  11233. <listheader>
  11234. <term>Value</term>
  11235. <description>Meaning</description>
  11236. </listheader>
  11237. <item>
  11238. <term>Less than zero</term>
  11239. <description>This instance is less than <paramref name="r"/>.</description>
  11240. </item>
  11241. <item>
  11242. <term>Zero</term>
  11243. <description>This instance is equal to <paramref name="r"/>.</description>
  11244. </item>
  11245. <item>
  11246. <term>Greater than zero</term>
  11247. <description>
  11248. <para>This instance is greater than <paramref name="r"/>.</para>
  11249. <para>-or-</para>
  11250. <para><paramref name="r"/> is <see langword="null"/>.</para>
  11251. </description>
  11252. </item>
  11253. </list>
  11254. </returns>
  11255. <remarks>
  11256. <para>
  11257. <paramref name="r"/> must be an instance of <see cref="T:log4net.Core.Level"/>
  11258. or <see langword="null"/>; otherwise, an exception is thrown.
  11259. </para>
  11260. </remarks>
  11261. <exception cref="T:System.ArgumentException"><paramref name="r"/> is not a <see cref="T:log4net.Core.Level"/>.</exception>
  11262. </member>
  11263. <member name="M:log4net.Core.Level.op_GreaterThan(log4net.Core.Level,log4net.Core.Level)">
  11264. <summary>
  11265. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  11266. is greater than another specified <see cref="T:log4net.Core.Level"/>.
  11267. </summary>
  11268. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  11269. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  11270. <returns>
  11271. <c>true</c> if <paramref name="l"/> is greater than
  11272. <paramref name="r"/>; otherwise, <c>false</c>.
  11273. </returns>
  11274. <remarks>
  11275. <para>
  11276. Compares two levels.
  11277. </para>
  11278. </remarks>
  11279. </member>
  11280. <member name="M:log4net.Core.Level.op_LessThan(log4net.Core.Level,log4net.Core.Level)">
  11281. <summary>
  11282. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  11283. is less than another specified <see cref="T:log4net.Core.Level"/>.
  11284. </summary>
  11285. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  11286. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  11287. <returns>
  11288. <c>true</c> if <paramref name="l"/> is less than
  11289. <paramref name="r"/>; otherwise, <c>false</c>.
  11290. </returns>
  11291. <remarks>
  11292. <para>
  11293. Compares two levels.
  11294. </para>
  11295. </remarks>
  11296. </member>
  11297. <member name="M:log4net.Core.Level.op_GreaterThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  11298. <summary>
  11299. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  11300. is greater than or equal to another specified <see cref="T:log4net.Core.Level"/>.
  11301. </summary>
  11302. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  11303. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  11304. <returns>
  11305. <c>true</c> if <paramref name="l"/> is greater than or equal to
  11306. <paramref name="r"/>; otherwise, <c>false</c>.
  11307. </returns>
  11308. <remarks>
  11309. <para>
  11310. Compares two levels.
  11311. </para>
  11312. </remarks>
  11313. </member>
  11314. <member name="M:log4net.Core.Level.op_LessThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  11315. <summary>
  11316. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  11317. is less than or equal to another specified <see cref="T:log4net.Core.Level"/>.
  11318. </summary>
  11319. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  11320. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  11321. <returns>
  11322. <c>true</c> if <paramref name="l"/> is less than or equal to
  11323. <paramref name="r"/>; otherwise, <c>false</c>.
  11324. </returns>
  11325. <remarks>
  11326. <para>
  11327. Compares two levels.
  11328. </para>
  11329. </remarks>
  11330. </member>
  11331. <member name="M:log4net.Core.Level.op_Equality(log4net.Core.Level,log4net.Core.Level)">
  11332. <summary>
  11333. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
  11334. objects have the same value.
  11335. </summary>
  11336. <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  11337. <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  11338. <returns>
  11339. <c>true</c> if the value of <paramref name="l"/> is the same as the
  11340. value of <paramref name="r"/>; otherwise, <c>false</c>.
  11341. </returns>
  11342. <remarks>
  11343. <para>
  11344. Compares two levels.
  11345. </para>
  11346. </remarks>
  11347. </member>
  11348. <member name="M:log4net.Core.Level.op_Inequality(log4net.Core.Level,log4net.Core.Level)">
  11349. <summary>
  11350. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
  11351. objects have different values.
  11352. </summary>
  11353. <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  11354. <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  11355. <returns>
  11356. <c>true</c> if the value of <paramref name="l"/> is different from
  11357. the value of <paramref name="r"/>; otherwise, <c>false</c>.
  11358. </returns>
  11359. <remarks>
  11360. <para>
  11361. Compares two levels.
  11362. </para>
  11363. </remarks>
  11364. </member>
  11365. <member name="M:log4net.Core.Level.Compare(log4net.Core.Level,log4net.Core.Level)">
  11366. <summary>
  11367. Compares two specified <see cref="T:log4net.Core.Level"/> instances.
  11368. </summary>
  11369. <param name="l">The first <see cref="T:log4net.Core.Level"/> to compare.</param>
  11370. <param name="r">The second <see cref="T:log4net.Core.Level"/> to compare.</param>
  11371. <returns>
  11372. A 32-bit signed integer that indicates the relative order of the
  11373. two values compared. The return value has these meanings:
  11374. <list type="table">
  11375. <listheader>
  11376. <term>Value</term>
  11377. <description>Meaning</description>
  11378. </listheader>
  11379. <item>
  11380. <term>Less than zero</term>
  11381. <description><paramref name="l"/> is less than <paramref name="r"/>.</description>
  11382. </item>
  11383. <item>
  11384. <term>Zero</term>
  11385. <description><paramref name="l"/> is equal to <paramref name="r"/>.</description>
  11386. </item>
  11387. <item>
  11388. <term>Greater than zero</term>
  11389. <description><paramref name="l"/> is greater than <paramref name="r"/>.</description>
  11390. </item>
  11391. </list>
  11392. </returns>
  11393. <remarks>
  11394. <para>
  11395. Compares two levels.
  11396. </para>
  11397. </remarks>
  11398. </member>
  11399. <member name="F:log4net.Core.Level.Off">
  11400. <summary>
  11401. The <see cref="F:log4net.Core.Level.Off"/> level designates a higher level than all the rest.
  11402. </summary>
  11403. </member>
  11404. <member name="F:log4net.Core.Level.Log4Net_Debug">
  11405. <summary>
  11406. The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events.
  11407. System unusable, emergencies.
  11408. </summary>
  11409. </member>
  11410. <member name="F:log4net.Core.Level.Emergency">
  11411. <summary>
  11412. The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events.
  11413. System unusable, emergencies.
  11414. </summary>
  11415. </member>
  11416. <member name="F:log4net.Core.Level.Fatal">
  11417. <summary>
  11418. The <see cref="F:log4net.Core.Level.Fatal"/> level designates very severe error events
  11419. that will presumably lead the application to abort.
  11420. </summary>
  11421. </member>
  11422. <member name="F:log4net.Core.Level.Alert">
  11423. <summary>
  11424. The <see cref="F:log4net.Core.Level.Alert"/> level designates very severe error events.
  11425. Take immediate action, alerts.
  11426. </summary>
  11427. </member>
  11428. <member name="F:log4net.Core.Level.Critical">
  11429. <summary>
  11430. The <see cref="F:log4net.Core.Level.Critical"/> level designates very severe error events.
  11431. Critical condition, critical.
  11432. </summary>
  11433. </member>
  11434. <member name="F:log4net.Core.Level.Severe">
  11435. <summary>
  11436. The <see cref="F:log4net.Core.Level.Severe"/> level designates very severe error events.
  11437. </summary>
  11438. </member>
  11439. <member name="F:log4net.Core.Level.Error">
  11440. <summary>
  11441. The <see cref="F:log4net.Core.Level.Error"/> level designates error events that might
  11442. still allow the application to continue running.
  11443. </summary>
  11444. </member>
  11445. <member name="F:log4net.Core.Level.Warn">
  11446. <summary>
  11447. The <see cref="F:log4net.Core.Level.Warn"/> level designates potentially harmful
  11448. situations.
  11449. </summary>
  11450. </member>
  11451. <member name="F:log4net.Core.Level.Notice">
  11452. <summary>
  11453. The <see cref="F:log4net.Core.Level.Notice"/> level designates informational messages
  11454. that highlight the progress of the application at the highest level.
  11455. </summary>
  11456. </member>
  11457. <member name="F:log4net.Core.Level.Info">
  11458. <summary>
  11459. The <see cref="F:log4net.Core.Level.Info"/> level designates informational messages that
  11460. highlight the progress of the application at coarse-grained level.
  11461. </summary>
  11462. </member>
  11463. <member name="F:log4net.Core.Level.Debug">
  11464. <summary>
  11465. The <see cref="F:log4net.Core.Level.Debug"/> level designates fine-grained informational
  11466. events that are most useful to debug an application.
  11467. </summary>
  11468. </member>
  11469. <member name="F:log4net.Core.Level.Fine">
  11470. <summary>
  11471. The <see cref="F:log4net.Core.Level.Fine"/> level designates fine-grained informational
  11472. events that are most useful to debug an application.
  11473. </summary>
  11474. </member>
  11475. <member name="F:log4net.Core.Level.Trace">
  11476. <summary>
  11477. The <see cref="F:log4net.Core.Level.Trace"/> level designates fine-grained informational
  11478. events that are most useful to debug an application.
  11479. </summary>
  11480. </member>
  11481. <member name="F:log4net.Core.Level.Finer">
  11482. <summary>
  11483. The <see cref="F:log4net.Core.Level.Finer"/> level designates fine-grained informational
  11484. events that are most useful to debug an application.
  11485. </summary>
  11486. </member>
  11487. <member name="F:log4net.Core.Level.Verbose">
  11488. <summary>
  11489. The <see cref="F:log4net.Core.Level.Verbose"/> level designates fine-grained informational
  11490. events that are most useful to debug an application.
  11491. </summary>
  11492. </member>
  11493. <member name="F:log4net.Core.Level.Finest">
  11494. <summary>
  11495. The <see cref="F:log4net.Core.Level.Finest"/> level designates fine-grained informational
  11496. events that are most useful to debug an application.
  11497. </summary>
  11498. </member>
  11499. <member name="F:log4net.Core.Level.All">
  11500. <summary>
  11501. The <see cref="F:log4net.Core.Level.All"/> level designates the lowest level possible.
  11502. </summary>
  11503. </member>
  11504. <member name="P:log4net.Core.Level.Name">
  11505. <summary>
  11506. Gets the name of this level.
  11507. </summary>
  11508. <value>
  11509. The name of this level.
  11510. </value>
  11511. <remarks>
  11512. <para>
  11513. Gets the name of this level.
  11514. </para>
  11515. </remarks>
  11516. </member>
  11517. <member name="P:log4net.Core.Level.Value">
  11518. <summary>
  11519. Gets the value of this level.
  11520. </summary>
  11521. <value>
  11522. The value of this level.
  11523. </value>
  11524. <remarks>
  11525. <para>
  11526. Gets the value of this level.
  11527. </para>
  11528. </remarks>
  11529. </member>
  11530. <member name="P:log4net.Core.Level.DisplayName">
  11531. <summary>
  11532. Gets the display name of this level.
  11533. </summary>
  11534. <value>
  11535. The display name of this level.
  11536. </value>
  11537. <remarks>
  11538. <para>
  11539. Gets the display name of this level.
  11540. </para>
  11541. </remarks>
  11542. </member>
  11543. <member name="T:log4net.Core.LevelCollection">
  11544. <summary>
  11545. A strongly-typed collection of <see cref="T:log4net.Core.Level"/> objects.
  11546. </summary>
  11547. <author>Nicko Cadell</author>
  11548. </member>
  11549. <member name="M:log4net.Core.LevelCollection.ReadOnly(log4net.Core.LevelCollection)">
  11550. <summary>
  11551. Creates a read-only wrapper for a <c>LevelCollection</c> instance.
  11552. </summary>
  11553. <param name="list">list to create a readonly wrapper arround</param>
  11554. <returns>
  11555. A <c>LevelCollection</c> wrapper that is read-only.
  11556. </returns>
  11557. </member>
  11558. <member name="M:log4net.Core.LevelCollection.#ctor">
  11559. <summary>
  11560. Initializes a new instance of the <c>LevelCollection</c> class
  11561. that is empty and has the default initial capacity.
  11562. </summary>
  11563. </member>
  11564. <member name="M:log4net.Core.LevelCollection.#ctor(System.Int32)">
  11565. <summary>
  11566. Initializes a new instance of the <c>LevelCollection</c> class
  11567. that has the specified initial capacity.
  11568. </summary>
  11569. <param name="capacity">
  11570. The number of elements that the new <c>LevelCollection</c> is initially capable of storing.
  11571. </param>
  11572. </member>
  11573. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection)">
  11574. <summary>
  11575. Initializes a new instance of the <c>LevelCollection</c> class
  11576. that contains elements copied from the specified <c>LevelCollection</c>.
  11577. </summary>
  11578. <param name="c">The <c>LevelCollection</c> whose elements are copied to the new collection.</param>
  11579. </member>
  11580. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.Level[])">
  11581. <summary>
  11582. Initializes a new instance of the <c>LevelCollection</c> class
  11583. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> array.
  11584. </summary>
  11585. <param name="a">The <see cref="T:log4net.Core.Level"/> array whose elements are copied to the new list.</param>
  11586. </member>
  11587. <member name="M:log4net.Core.LevelCollection.#ctor(System.Collections.ICollection)">
  11588. <summary>
  11589. Initializes a new instance of the <c>LevelCollection</c> class
  11590. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> collection.
  11591. </summary>
  11592. <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements are copied to the new list.</param>
  11593. </member>
  11594. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection.Tag)">
  11595. <summary>
  11596. Allow subclasses to avoid our default constructors
  11597. </summary>
  11598. <param name="tag"></param>
  11599. </member>
  11600. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[])">
  11601. <summary>
  11602. Copies the entire <c>LevelCollection</c> to a one-dimensional
  11603. <see cref="T:log4net.Core.Level"/> array.
  11604. </summary>
  11605. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  11606. </member>
  11607. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[],System.Int32)">
  11608. <summary>
  11609. Copies the entire <c>LevelCollection</c> to a one-dimensional
  11610. <see cref="T:log4net.Core.Level"/> array, starting at the specified index of the target array.
  11611. </summary>
  11612. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  11613. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  11614. </member>
  11615. <member name="M:log4net.Core.LevelCollection.Add(log4net.Core.Level)">
  11616. <summary>
  11617. Adds a <see cref="T:log4net.Core.Level"/> to the end of the <c>LevelCollection</c>.
  11618. </summary>
  11619. <param name="item">The <see cref="T:log4net.Core.Level"/> to be added to the end of the <c>LevelCollection</c>.</param>
  11620. <returns>The index at which the value has been added.</returns>
  11621. </member>
  11622. <member name="M:log4net.Core.LevelCollection.Clear">
  11623. <summary>
  11624. Removes all elements from the <c>LevelCollection</c>.
  11625. </summary>
  11626. </member>
  11627. <member name="M:log4net.Core.LevelCollection.Clone">
  11628. <summary>
  11629. Creates a shallow copy of the <see cref="T:log4net.Core.LevelCollection"/>.
  11630. </summary>
  11631. <returns>A new <see cref="T:log4net.Core.LevelCollection"/> with a shallow copy of the collection data.</returns>
  11632. </member>
  11633. <member name="M:log4net.Core.LevelCollection.Contains(log4net.Core.Level)">
  11634. <summary>
  11635. Determines whether a given <see cref="T:log4net.Core.Level"/> is in the <c>LevelCollection</c>.
  11636. </summary>
  11637. <param name="item">The <see cref="T:log4net.Core.Level"/> to check for.</param>
  11638. <returns><c>true</c> if <paramref name="item"/> is found in the <c>LevelCollection</c>; otherwise, <c>false</c>.</returns>
  11639. </member>
  11640. <member name="M:log4net.Core.LevelCollection.IndexOf(log4net.Core.Level)">
  11641. <summary>
  11642. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Core.Level"/>
  11643. in the <c>LevelCollection</c>.
  11644. </summary>
  11645. <param name="item">The <see cref="T:log4net.Core.Level"/> to locate in the <c>LevelCollection</c>.</param>
  11646. <returns>
  11647. The zero-based index of the first occurrence of <paramref name="item"/>
  11648. in the entire <c>LevelCollection</c>, if found; otherwise, -1.
  11649. </returns>
  11650. </member>
  11651. <member name="M:log4net.Core.LevelCollection.Insert(System.Int32,log4net.Core.Level)">
  11652. <summary>
  11653. Inserts an element into the <c>LevelCollection</c> at the specified index.
  11654. </summary>
  11655. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  11656. <param name="item">The <see cref="T:log4net.Core.Level"/> to insert.</param>
  11657. <exception cref="T:System.ArgumentOutOfRangeException">
  11658. <para><paramref name="index"/> is less than zero</para>
  11659. <para>-or-</para>
  11660. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11661. </exception>
  11662. </member>
  11663. <member name="M:log4net.Core.LevelCollection.Remove(log4net.Core.Level)">
  11664. <summary>
  11665. Removes the first occurrence of a specific <see cref="T:log4net.Core.Level"/> from the <c>LevelCollection</c>.
  11666. </summary>
  11667. <param name="item">The <see cref="T:log4net.Core.Level"/> to remove from the <c>LevelCollection</c>.</param>
  11668. <exception cref="T:System.ArgumentException">
  11669. The specified <see cref="T:log4net.Core.Level"/> was not found in the <c>LevelCollection</c>.
  11670. </exception>
  11671. </member>
  11672. <member name="M:log4net.Core.LevelCollection.RemoveAt(System.Int32)">
  11673. <summary>
  11674. Removes the element at the specified index of the <c>LevelCollection</c>.
  11675. </summary>
  11676. <param name="index">The zero-based index of the element to remove.</param>
  11677. <exception cref="T:System.ArgumentOutOfRangeException">
  11678. <para><paramref name="index"/> is less than zero</para>
  11679. <para>-or-</para>
  11680. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11681. </exception>
  11682. </member>
  11683. <member name="M:log4net.Core.LevelCollection.GetEnumerator">
  11684. <summary>
  11685. Returns an enumerator that can iterate through the <c>LevelCollection</c>.
  11686. </summary>
  11687. <returns>An <see cref="T:log4net.Core.LevelCollection.Enumerator"/> for the entire <c>LevelCollection</c>.</returns>
  11688. </member>
  11689. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.LevelCollection)">
  11690. <summary>
  11691. Adds the elements of another <c>LevelCollection</c> to the current <c>LevelCollection</c>.
  11692. </summary>
  11693. <param name="x">The <c>LevelCollection</c> whose elements should be added to the end of the current <c>LevelCollection</c>.</param>
  11694. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11695. </member>
  11696. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.Level[])">
  11697. <summary>
  11698. Adds the elements of a <see cref="T:log4net.Core.Level"/> array to the current <c>LevelCollection</c>.
  11699. </summary>
  11700. <param name="x">The <see cref="T:log4net.Core.Level"/> array whose elements should be added to the end of the <c>LevelCollection</c>.</param>
  11701. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11702. </member>
  11703. <member name="M:log4net.Core.LevelCollection.AddRange(System.Collections.ICollection)">
  11704. <summary>
  11705. Adds the elements of a <see cref="T:log4net.Core.Level"/> collection to the current <c>LevelCollection</c>.
  11706. </summary>
  11707. <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements should be added to the end of the <c>LevelCollection</c>.</param>
  11708. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11709. </member>
  11710. <member name="M:log4net.Core.LevelCollection.TrimToSize">
  11711. <summary>
  11712. Sets the capacity to the actual number of elements.
  11713. </summary>
  11714. </member>
  11715. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32)">
  11716. <exception cref="T:System.ArgumentOutOfRangeException">
  11717. <para><paramref name="i"/> is less than zero</para>
  11718. <para>-or-</para>
  11719. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11720. </exception>
  11721. </member>
  11722. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32,System.Boolean)">
  11723. <exception cref="T:System.ArgumentOutOfRangeException">
  11724. <para><paramref name="i"/> is less than zero</para>
  11725. <para>-or-</para>
  11726. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11727. </exception>
  11728. </member>
  11729. <member name="P:log4net.Core.LevelCollection.Count">
  11730. <summary>
  11731. Gets the number of elements actually contained in the <c>LevelCollection</c>.
  11732. </summary>
  11733. </member>
  11734. <member name="P:log4net.Core.LevelCollection.IsSynchronized">
  11735. <summary>
  11736. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  11737. </summary>
  11738. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  11739. </member>
  11740. <member name="P:log4net.Core.LevelCollection.SyncRoot">
  11741. <summary>
  11742. Gets an object that can be used to synchronize access to the collection.
  11743. </summary>
  11744. </member>
  11745. <member name="P:log4net.Core.LevelCollection.Item(System.Int32)">
  11746. <summary>
  11747. Gets or sets the <see cref="T:log4net.Core.Level"/> at the specified index.
  11748. </summary>
  11749. <param name="index">The zero-based index of the element to get or set.</param>
  11750. <exception cref="T:System.ArgumentOutOfRangeException">
  11751. <para><paramref name="index"/> is less than zero</para>
  11752. <para>-or-</para>
  11753. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11754. </exception>
  11755. </member>
  11756. <member name="P:log4net.Core.LevelCollection.IsFixedSize">
  11757. <summary>
  11758. Gets a value indicating whether the collection has a fixed size.
  11759. </summary>
  11760. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  11761. </member>
  11762. <member name="P:log4net.Core.LevelCollection.IsReadOnly">
  11763. <summary>
  11764. Gets a value indicating whether the IList is read-only.
  11765. </summary>
  11766. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  11767. </member>
  11768. <member name="P:log4net.Core.LevelCollection.Capacity">
  11769. <summary>
  11770. Gets or sets the number of elements the <c>LevelCollection</c> can contain.
  11771. </summary>
  11772. </member>
  11773. <member name="T:log4net.Core.LevelCollection.ILevelCollectionEnumerator">
  11774. <summary>
  11775. Supports type-safe iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  11776. </summary>
  11777. </member>
  11778. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.MoveNext">
  11779. <summary>
  11780. Advances the enumerator to the next element in the collection.
  11781. </summary>
  11782. <returns>
  11783. <c>true</c> if the enumerator was successfully advanced to the next element;
  11784. <c>false</c> if the enumerator has passed the end of the collection.
  11785. </returns>
  11786. <exception cref="T:System.InvalidOperationException">
  11787. The collection was modified after the enumerator was created.
  11788. </exception>
  11789. </member>
  11790. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Reset">
  11791. <summary>
  11792. Sets the enumerator to its initial position, before the first element in the collection.
  11793. </summary>
  11794. </member>
  11795. <member name="P:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Current">
  11796. <summary>
  11797. Gets the current element in the collection.
  11798. </summary>
  11799. </member>
  11800. <member name="T:log4net.Core.LevelCollection.Tag">
  11801. <summary>
  11802. Type visible only to our subclasses
  11803. Used to access protected constructor
  11804. </summary>
  11805. </member>
  11806. <member name="F:log4net.Core.LevelCollection.Tag.Default">
  11807. <summary>
  11808. A value
  11809. </summary>
  11810. </member>
  11811. <member name="T:log4net.Core.LevelCollection.Enumerator">
  11812. <summary>
  11813. Supports simple iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  11814. </summary>
  11815. </member>
  11816. <member name="M:log4net.Core.LevelCollection.Enumerator.#ctor(log4net.Core.LevelCollection)">
  11817. <summary>
  11818. Initializes a new instance of the <c>Enumerator</c> class.
  11819. </summary>
  11820. <param name="tc"></param>
  11821. </member>
  11822. <member name="M:log4net.Core.LevelCollection.Enumerator.MoveNext">
  11823. <summary>
  11824. Advances the enumerator to the next element in the collection.
  11825. </summary>
  11826. <returns>
  11827. <c>true</c> if the enumerator was successfully advanced to the next element;
  11828. <c>false</c> if the enumerator has passed the end of the collection.
  11829. </returns>
  11830. <exception cref="T:System.InvalidOperationException">
  11831. The collection was modified after the enumerator was created.
  11832. </exception>
  11833. </member>
  11834. <member name="M:log4net.Core.LevelCollection.Enumerator.Reset">
  11835. <summary>
  11836. Sets the enumerator to its initial position, before the first element in the collection.
  11837. </summary>
  11838. </member>
  11839. <member name="P:log4net.Core.LevelCollection.Enumerator.Current">
  11840. <summary>
  11841. Gets the current element in the collection.
  11842. </summary>
  11843. </member>
  11844. <member name="T:log4net.Core.LevelEvaluator">
  11845. <summary>
  11846. An evaluator that triggers at a threshold level
  11847. </summary>
  11848. <remarks>
  11849. <para>
  11850. This evaluator will trigger if the level of the event
  11851. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11852. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11853. level.
  11854. </para>
  11855. </remarks>
  11856. <author>Nicko Cadell</author>
  11857. </member>
  11858. <member name="F:log4net.Core.LevelEvaluator.m_threshold">
  11859. <summary>
  11860. The threshold for triggering
  11861. </summary>
  11862. </member>
  11863. <member name="M:log4net.Core.LevelEvaluator.#ctor">
  11864. <summary>
  11865. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  11866. </summary>
  11867. <remarks>
  11868. <para>
  11869. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  11870. </para>
  11871. <para>
  11872. This evaluator will trigger if the level of the event
  11873. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11874. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11875. level.
  11876. </para>
  11877. </remarks>
  11878. </member>
  11879. <member name="M:log4net.Core.LevelEvaluator.#ctor(log4net.Core.Level)">
  11880. <summary>
  11881. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  11882. </summary>
  11883. <param name="threshold">the threshold to trigger at</param>
  11884. <remarks>
  11885. <para>
  11886. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  11887. </para>
  11888. <para>
  11889. This evaluator will trigger if the level of the event
  11890. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11891. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11892. level.
  11893. </para>
  11894. </remarks>
  11895. </member>
  11896. <member name="M:log4net.Core.LevelEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  11897. <summary>
  11898. Is this <paramref name="loggingEvent"/> the triggering event?
  11899. </summary>
  11900. <param name="loggingEvent">The event to check</param>
  11901. <returns>This method returns <c>true</c>, if the event level
  11902. is equal or higher than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>.
  11903. Otherwise it returns <c>false</c></returns>
  11904. <remarks>
  11905. <para>
  11906. This evaluator will trigger if the level of the event
  11907. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11908. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11909. level.
  11910. </para>
  11911. </remarks>
  11912. </member>
  11913. <member name="P:log4net.Core.LevelEvaluator.Threshold">
  11914. <summary>
  11915. the threshold to trigger at
  11916. </summary>
  11917. <value>
  11918. The <see cref="T:log4net.Core.Level"/> that will cause this evaluator to trigger
  11919. </value>
  11920. <remarks>
  11921. <para>
  11922. This evaluator will trigger if the level of the event
  11923. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11924. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11925. level.
  11926. </para>
  11927. </remarks>
  11928. </member>
  11929. <member name="T:log4net.Core.LevelMap">
  11930. <summary>
  11931. Mapping between string name and Level object
  11932. </summary>
  11933. <remarks>
  11934. <para>
  11935. Mapping between string name and <see cref="T:log4net.Core.Level"/> object.
  11936. This mapping is held separately for each <see cref="T:log4net.Repository.ILoggerRepository"/>.
  11937. The level name is case insensitive.
  11938. </para>
  11939. </remarks>
  11940. <author>Nicko Cadell</author>
  11941. </member>
  11942. <member name="F:log4net.Core.LevelMap.m_mapName2Level">
  11943. <summary>
  11944. Mapping from level name to Level object. The
  11945. level name is case insensitive
  11946. </summary>
  11947. </member>
  11948. <member name="M:log4net.Core.LevelMap.#ctor">
  11949. <summary>
  11950. Construct the level map
  11951. </summary>
  11952. <remarks>
  11953. <para>
  11954. Construct the level map.
  11955. </para>
  11956. </remarks>
  11957. </member>
  11958. <member name="M:log4net.Core.LevelMap.Clear">
  11959. <summary>
  11960. Clear the internal maps of all levels
  11961. </summary>
  11962. <remarks>
  11963. <para>
  11964. Clear the internal maps of all levels
  11965. </para>
  11966. </remarks>
  11967. </member>
  11968. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32)">
  11969. <summary>
  11970. Create a new Level and add it to the map
  11971. </summary>
  11972. <param name="name">the string to display for the Level</param>
  11973. <param name="value">the level value to give to the Level</param>
  11974. <remarks>
  11975. <para>
  11976. Create a new Level and add it to the map
  11977. </para>
  11978. </remarks>
  11979. <seealso cref="M:Add(string,int,string)"/>
  11980. </member>
  11981. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32,System.String)">
  11982. <summary>
  11983. Create a new Level and add it to the map
  11984. </summary>
  11985. <param name="name">the string to display for the Level</param>
  11986. <param name="value">the level value to give to the Level</param>
  11987. <param name="displayName">the display name to give to the Level</param>
  11988. <remarks>
  11989. <para>
  11990. Create a new Level and add it to the map
  11991. </para>
  11992. </remarks>
  11993. </member>
  11994. <member name="M:log4net.Core.LevelMap.Add(log4net.Core.Level)">
  11995. <summary>
  11996. Add a Level to the map
  11997. </summary>
  11998. <param name="level">the Level to add</param>
  11999. <remarks>
  12000. <para>
  12001. Add a Level to the map
  12002. </para>
  12003. </remarks>
  12004. </member>
  12005. <member name="M:log4net.Core.LevelMap.LookupWithDefault(log4net.Core.Level)">
  12006. <summary>
  12007. Lookup a named level from the map
  12008. </summary>
  12009. <param name="defaultLevel">the name of the level to lookup is taken from this level.
  12010. If the level is not set on the map then this level is added</param>
  12011. <returns>the level in the map with the name specified</returns>
  12012. <remarks>
  12013. <para>
  12014. Lookup a named level from the map. The name of the level to lookup is taken
  12015. from the <see cref="P:log4net.Core.Level.Name"/> property of the <paramref name="defaultLevel"/>
  12016. argument.
  12017. </para>
  12018. <para>
  12019. If no level with the specified name is found then the
  12020. <paramref name="defaultLevel"/> argument is added to the level map
  12021. and returned.
  12022. </para>
  12023. </remarks>
  12024. </member>
  12025. <member name="P:log4net.Core.LevelMap.Item(System.String)">
  12026. <summary>
  12027. Lookup a <see cref="T:log4net.Core.Level"/> by name
  12028. </summary>
  12029. <param name="name">The name of the Level to lookup</param>
  12030. <returns>a Level from the map with the name specified</returns>
  12031. <remarks>
  12032. <para>
  12033. Returns the <see cref="T:log4net.Core.Level"/> from the
  12034. map with the name specified. If the no level is
  12035. found then <c>null</c> is returned.
  12036. </para>
  12037. </remarks>
  12038. </member>
  12039. <member name="P:log4net.Core.LevelMap.AllLevels">
  12040. <summary>
  12041. Return all possible levels as a list of Level objects.
  12042. </summary>
  12043. <returns>all possible levels as a list of Level objects</returns>
  12044. <remarks>
  12045. <para>
  12046. Return all possible levels as a list of Level objects.
  12047. </para>
  12048. </remarks>
  12049. </member>
  12050. <member name="T:log4net.Core.LocationInfo">
  12051. <summary>
  12052. The internal representation of caller location information.
  12053. </summary>
  12054. <remarks>
  12055. <para>
  12056. This class uses the <c>System.Diagnostics.StackTrace</c> class to generate
  12057. a call stack. The caller's information is then extracted from this stack.
  12058. </para>
  12059. <para>
  12060. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  12061. .NET Compact Framework 1.0 therefore caller location information is not
  12062. available on that framework.
  12063. </para>
  12064. <para>
  12065. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  12066. </para>
  12067. <para>
  12068. "StackTrace information will be most informative with Debug build configurations.
  12069. By default, Debug builds include debug symbols, while Release builds do not. The
  12070. debug symbols contain most of the file, method name, line number, and column
  12071. information used in constructing StackFrame and StackTrace objects. StackTrace
  12072. might not report as many method calls as expected, due to code transformations
  12073. that occur during optimization."
  12074. </para>
  12075. <para>
  12076. This means that in a Release build the caller information may be incomplete or may
  12077. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  12078. </para>
  12079. </remarks>
  12080. <author>Nicko Cadell</author>
  12081. <author>Gert Driesen</author>
  12082. </member>
  12083. <member name="F:log4net.Core.LocationInfo.NA">
  12084. <summary>
  12085. When location information is not available the constant
  12086. <c>NA</c> is returned. Current value of this string
  12087. constant is <b>?</b>.
  12088. </summary>
  12089. </member>
  12090. <member name="M:log4net.Core.LocationInfo.#ctor(System.Type)">
  12091. <summary>
  12092. Constructor
  12093. </summary>
  12094. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  12095. the stack boundary into the logging system for this call.</param>
  12096. <remarks>
  12097. <para>
  12098. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/>
  12099. class based on the current thread.
  12100. </para>
  12101. </remarks>
  12102. </member>
  12103. <member name="M:log4net.Core.LocationInfo.#ctor(System.String,System.String,System.String,System.String)">
  12104. <summary>
  12105. Constructor
  12106. </summary>
  12107. <param name="className">The fully qualified class name.</param>
  12108. <param name="methodName">The method name.</param>
  12109. <param name="fileName">The file name.</param>
  12110. <param name="lineNumber">The line number of the method within the file.</param>
  12111. <remarks>
  12112. <para>
  12113. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/>
  12114. class with the specified data.
  12115. </para>
  12116. </remarks>
  12117. </member>
  12118. <member name="F:log4net.Core.LocationInfo.declaringType">
  12119. <summary>
  12120. The fully qualified type of the LocationInfo class.
  12121. </summary>
  12122. <remarks>
  12123. Used by the internal logger to record the Type of the
  12124. log message.
  12125. </remarks>
  12126. </member>
  12127. <member name="P:log4net.Core.LocationInfo.ClassName">
  12128. <summary>
  12129. Gets the fully qualified class name of the caller making the logging
  12130. request.
  12131. </summary>
  12132. <value>
  12133. The fully qualified class name of the caller making the logging
  12134. request.
  12135. </value>
  12136. <remarks>
  12137. <para>
  12138. Gets the fully qualified class name of the caller making the logging
  12139. request.
  12140. </para>
  12141. </remarks>
  12142. </member>
  12143. <member name="P:log4net.Core.LocationInfo.FileName">
  12144. <summary>
  12145. Gets the file name of the caller.
  12146. </summary>
  12147. <value>
  12148. The file name of the caller.
  12149. </value>
  12150. <remarks>
  12151. <para>
  12152. Gets the file name of the caller.
  12153. </para>
  12154. </remarks>
  12155. </member>
  12156. <member name="P:log4net.Core.LocationInfo.LineNumber">
  12157. <summary>
  12158. Gets the line number of the caller.
  12159. </summary>
  12160. <value>
  12161. The line number of the caller.
  12162. </value>
  12163. <remarks>
  12164. <para>
  12165. Gets the line number of the caller.
  12166. </para>
  12167. </remarks>
  12168. </member>
  12169. <member name="P:log4net.Core.LocationInfo.MethodName">
  12170. <summary>
  12171. Gets the method name of the caller.
  12172. </summary>
  12173. <value>
  12174. The method name of the caller.
  12175. </value>
  12176. <remarks>
  12177. <para>
  12178. Gets the method name of the caller.
  12179. </para>
  12180. </remarks>
  12181. </member>
  12182. <member name="P:log4net.Core.LocationInfo.FullInfo">
  12183. <summary>
  12184. Gets all available caller information
  12185. </summary>
  12186. <value>
  12187. All available caller information, in the format
  12188. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  12189. </value>
  12190. <remarks>
  12191. <para>
  12192. Gets all available caller information, in the format
  12193. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  12194. </para>
  12195. </remarks>
  12196. </member>
  12197. <member name="P:log4net.Core.LocationInfo.StackFrames">
  12198. <summary>
  12199. Gets the stack frames from the stack trace of the caller making the log request
  12200. </summary>
  12201. </member>
  12202. <member name="T:log4net.Core.LoggerManager">
  12203. <summary>
  12204. Static manager that controls the creation of repositories
  12205. </summary>
  12206. <remarks>
  12207. <para>
  12208. Static manager that controls the creation of repositories
  12209. </para>
  12210. <para>
  12211. This class is used by the wrapper managers (e.g. <see cref="T:log4net.LogManager"/>)
  12212. to provide access to the <see cref="T:log4net.Core.ILogger"/> objects.
  12213. </para>
  12214. <para>
  12215. This manager also holds the <see cref="T:log4net.Core.IRepositorySelector"/> that is used to
  12216. lookup and create repositories. The selector can be set either programmatically using
  12217. the <see cref="P:log4net.Core.LoggerManager.RepositorySelector"/> property, or by setting the <c>log4net.RepositorySelector</c>
  12218. AppSetting in the applications config file to the fully qualified type name of the
  12219. selector to use.
  12220. </para>
  12221. </remarks>
  12222. <author>Nicko Cadell</author>
  12223. <author>Gert Driesen</author>
  12224. </member>
  12225. <member name="M:log4net.Core.LoggerManager.#ctor">
  12226. <summary>
  12227. Private constructor to prevent instances. Only static methods should be used.
  12228. </summary>
  12229. <remarks>
  12230. <para>
  12231. Private constructor to prevent instances. Only static methods should be used.
  12232. </para>
  12233. </remarks>
  12234. </member>
  12235. <member name="M:log4net.Core.LoggerManager.#cctor">
  12236. <summary>
  12237. Hook the shutdown event
  12238. </summary>
  12239. <remarks>
  12240. <para>
  12241. On the full .NET runtime, the static constructor hooks up the
  12242. <c>AppDomain.ProcessExit</c> and <c>AppDomain.DomainUnload</c>> events.
  12243. These are used to shutdown the log4net system as the application exits.
  12244. </para>
  12245. </remarks>
  12246. </member>
  12247. <member name="M:log4net.Core.LoggerManager.RegisterAppDomainEvents">
  12248. <summary>
  12249. Register for ProcessExit and DomainUnload events on the AppDomain
  12250. </summary>
  12251. <remarks>
  12252. <para>
  12253. This needs to be in a separate method because the events make
  12254. a LinkDemand for the ControlAppDomain SecurityPermission. Because
  12255. this is a LinkDemand it is demanded at JIT time. Therefore we cannot
  12256. catch the exception in the method itself, we have to catch it in the
  12257. caller.
  12258. </para>
  12259. </remarks>
  12260. </member>
  12261. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.String)">
  12262. <summary>
  12263. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12264. </summary>
  12265. <param name="repository">the repository to lookup in</param>
  12266. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  12267. <remarks>
  12268. <para>
  12269. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  12270. by the <paramref name="repository"/> argument.
  12271. </para>
  12272. </remarks>
  12273. </member>
  12274. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.Reflection.Assembly)">
  12275. <summary>
  12276. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12277. </summary>
  12278. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12279. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  12280. </member>
  12281. <member name="M:log4net.Core.LoggerManager.GetRepository(System.String)">
  12282. <summary>
  12283. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12284. </summary>
  12285. <param name="repository">the repository to lookup in</param>
  12286. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  12287. <remarks>
  12288. <para>
  12289. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  12290. by the <paramref name="repository"/> argument.
  12291. </para>
  12292. </remarks>
  12293. </member>
  12294. <member name="M:log4net.Core.LoggerManager.GetRepository(System.Reflection.Assembly)">
  12295. <summary>
  12296. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12297. </summary>
  12298. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12299. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  12300. <remarks>
  12301. <para>
  12302. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12303. </para>
  12304. </remarks>
  12305. </member>
  12306. <member name="M:log4net.Core.LoggerManager.Exists(System.String,System.String)">
  12307. <summary>
  12308. Returns the named logger if it exists.
  12309. </summary>
  12310. <param name="repository">The repository to lookup in.</param>
  12311. <param name="name">The fully qualified logger name to look for.</param>
  12312. <returns>
  12313. The logger found, or <c>null</c> if the named logger does not exist in the
  12314. specified repository.
  12315. </returns>
  12316. <remarks>
  12317. <para>
  12318. If the named logger exists (in the specified repository) then it
  12319. returns a reference to the logger, otherwise it returns
  12320. <c>null</c>.
  12321. </para>
  12322. </remarks>
  12323. </member>
  12324. <member name="M:log4net.Core.LoggerManager.Exists(System.Reflection.Assembly,System.String)">
  12325. <summary>
  12326. Returns the named logger if it exists.
  12327. </summary>
  12328. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12329. <param name="name">The fully qualified logger name to look for.</param>
  12330. <returns>
  12331. The logger found, or <c>null</c> if the named logger does not exist in the
  12332. specified assembly's repository.
  12333. </returns>
  12334. <remarks>
  12335. <para>
  12336. If the named logger exists (in the specified assembly's repository) then it
  12337. returns a reference to the logger, otherwise it returns
  12338. <c>null</c>.
  12339. </para>
  12340. </remarks>
  12341. </member>
  12342. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.String)">
  12343. <summary>
  12344. Returns all the currently defined loggers in the specified repository.
  12345. </summary>
  12346. <param name="repository">The repository to lookup in.</param>
  12347. <returns>All the defined loggers.</returns>
  12348. <remarks>
  12349. <para>
  12350. The root logger is <b>not</b> included in the returned array.
  12351. </para>
  12352. </remarks>
  12353. </member>
  12354. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.Reflection.Assembly)">
  12355. <summary>
  12356. Returns all the currently defined loggers in the specified assembly's repository.
  12357. </summary>
  12358. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12359. <returns>All the defined loggers.</returns>
  12360. <remarks>
  12361. <para>
  12362. The root logger is <b>not</b> included in the returned array.
  12363. </para>
  12364. </remarks>
  12365. </member>
  12366. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.String)">
  12367. <summary>
  12368. Retrieves or creates a named logger.
  12369. </summary>
  12370. <param name="repository">The repository to lookup in.</param>
  12371. <param name="name">The name of the logger to retrieve.</param>
  12372. <returns>The logger with the name specified.</returns>
  12373. <remarks>
  12374. <para>
  12375. Retrieves a logger named as the <paramref name="name"/>
  12376. parameter. If the named logger already exists, then the
  12377. existing instance will be returned. Otherwise, a new instance is
  12378. created.
  12379. </para>
  12380. <para>
  12381. By default, loggers do not have a set level but inherit
  12382. it from the hierarchy. This is one of the central features of
  12383. log4net.
  12384. </para>
  12385. </remarks>
  12386. </member>
  12387. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.String)">
  12388. <summary>
  12389. Retrieves or creates a named logger.
  12390. </summary>
  12391. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12392. <param name="name">The name of the logger to retrieve.</param>
  12393. <returns>The logger with the name specified.</returns>
  12394. <remarks>
  12395. <para>
  12396. Retrieves a logger named as the <paramref name="name"/>
  12397. parameter. If the named logger already exists, then the
  12398. existing instance will be returned. Otherwise, a new instance is
  12399. created.
  12400. </para>
  12401. <para>
  12402. By default, loggers do not have a set level but inherit
  12403. it from the hierarchy. This is one of the central features of
  12404. log4net.
  12405. </para>
  12406. </remarks>
  12407. </member>
  12408. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.Type)">
  12409. <summary>
  12410. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  12411. </summary>
  12412. <param name="repository">The repository to lookup in.</param>
  12413. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  12414. <returns>The logger with the name specified.</returns>
  12415. <remarks>
  12416. <para>
  12417. Gets the logger for the fully qualified name of the type specified.
  12418. </para>
  12419. </remarks>
  12420. </member>
  12421. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.Type)">
  12422. <summary>
  12423. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  12424. </summary>
  12425. <param name="repositoryAssembly">the assembly to use to lookup the repository</param>
  12426. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  12427. <returns>The logger with the name specified.</returns>
  12428. <remarks>
  12429. <para>
  12430. Gets the logger for the fully qualified name of the type specified.
  12431. </para>
  12432. </remarks>
  12433. </member>
  12434. <member name="M:log4net.Core.LoggerManager.Shutdown">
  12435. <summary>
  12436. Shuts down the log4net system.
  12437. </summary>
  12438. <remarks>
  12439. <para>
  12440. Calling this method will <b>safely</b> close and remove all
  12441. appenders in all the loggers including root contained in all the
  12442. default repositories.
  12443. </para>
  12444. <para>
  12445. Some appenders need to be closed before the application exists.
  12446. Otherwise, pending logging events might be lost.
  12447. </para>
  12448. <para>
  12449. The <c>shutdown</c> method is careful to close nested
  12450. appenders before closing regular appenders. This is allows
  12451. configurations where a regular appender is attached to a logger
  12452. and again to a nested appender.
  12453. </para>
  12454. </remarks>
  12455. </member>
  12456. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.String)">
  12457. <summary>
  12458. Shuts down the repository for the repository specified.
  12459. </summary>
  12460. <param name="repository">The repository to shutdown.</param>
  12461. <remarks>
  12462. <para>
  12463. Calling this method will <b>safely</b> close and remove all
  12464. appenders in all the loggers including root contained in the
  12465. repository for the <paramref name="repository"/> specified.
  12466. </para>
  12467. <para>
  12468. Some appenders need to be closed before the application exists.
  12469. Otherwise, pending logging events might be lost.
  12470. </para>
  12471. <para>
  12472. The <c>shutdown</c> method is careful to close nested
  12473. appenders before closing regular appenders. This is allows
  12474. configurations where a regular appender is attached to a logger
  12475. and again to a nested appender.
  12476. </para>
  12477. </remarks>
  12478. </member>
  12479. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.Reflection.Assembly)">
  12480. <summary>
  12481. Shuts down the repository for the repository specified.
  12482. </summary>
  12483. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12484. <remarks>
  12485. <para>
  12486. Calling this method will <b>safely</b> close and remove all
  12487. appenders in all the loggers including root contained in the
  12488. repository for the repository. The repository is looked up using
  12489. the <paramref name="repositoryAssembly"/> specified.
  12490. </para>
  12491. <para>
  12492. Some appenders need to be closed before the application exists.
  12493. Otherwise, pending logging events might be lost.
  12494. </para>
  12495. <para>
  12496. The <c>shutdown</c> method is careful to close nested
  12497. appenders before closing regular appenders. This is allows
  12498. configurations where a regular appender is attached to a logger
  12499. and again to a nested appender.
  12500. </para>
  12501. </remarks>
  12502. </member>
  12503. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.String)">
  12504. <summary>
  12505. Resets all values contained in this repository instance to their defaults.
  12506. </summary>
  12507. <param name="repository">The repository to reset.</param>
  12508. <remarks>
  12509. <para>
  12510. Resets all values contained in the repository instance to their
  12511. defaults. This removes all appenders from all loggers, sets
  12512. the level of all non-root loggers to <c>null</c>,
  12513. sets their additivity flag to <c>true</c> and sets the level
  12514. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  12515. message disabling is set its default "off" value.
  12516. </para>
  12517. </remarks>
  12518. </member>
  12519. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.Reflection.Assembly)">
  12520. <summary>
  12521. Resets all values contained in this repository instance to their defaults.
  12522. </summary>
  12523. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  12524. <remarks>
  12525. <para>
  12526. Resets all values contained in the repository instance to their
  12527. defaults. This removes all appenders from all loggers, sets
  12528. the level of all non-root loggers to <c>null</c>,
  12529. sets their additivity flag to <c>true</c> and sets the level
  12530. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  12531. message disabling is set its default "off" value.
  12532. </para>
  12533. </remarks>
  12534. </member>
  12535. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String)">
  12536. <summary>
  12537. Creates a repository with the specified name.
  12538. </summary>
  12539. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  12540. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12541. <remarks>
  12542. <para>
  12543. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12544. </para>
  12545. <para>
  12546. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  12547. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  12548. </para>
  12549. <para>
  12550. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12551. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  12552. </para>
  12553. </remarks>
  12554. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12555. </member>
  12556. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String)">
  12557. <summary>
  12558. Creates a repository with the specified name.
  12559. </summary>
  12560. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  12561. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12562. <remarks>
  12563. <para>
  12564. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  12565. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  12566. </para>
  12567. <para>
  12568. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12569. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  12570. </para>
  12571. </remarks>
  12572. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12573. </member>
  12574. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String,System.Type)">
  12575. <summary>
  12576. Creates a repository with the specified name and repository type.
  12577. </summary>
  12578. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  12579. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12580. and has a no arg constructor. An instance of this type will be created to act
  12581. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12582. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12583. <remarks>
  12584. <para>
  12585. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12586. </para>
  12587. <para>
  12588. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12589. An Exception will be thrown if the repository already exists.
  12590. </para>
  12591. </remarks>
  12592. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12593. </member>
  12594. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String,System.Type)">
  12595. <summary>
  12596. Creates a repository with the specified name and repository type.
  12597. </summary>
  12598. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  12599. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12600. and has a no arg constructor. An instance of this type will be created to act
  12601. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12602. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12603. <remarks>
  12604. <para>
  12605. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12606. An Exception will be thrown if the repository already exists.
  12607. </para>
  12608. </remarks>
  12609. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12610. </member>
  12611. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  12612. <summary>
  12613. Creates a repository for the specified assembly and repository type.
  12614. </summary>
  12615. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  12616. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12617. and has a no arg constructor. An instance of this type will be created to act
  12618. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12619. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12620. <remarks>
  12621. <para>
  12622. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12623. </para>
  12624. <para>
  12625. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  12626. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  12627. same assembly specified will return the same repository instance.
  12628. </para>
  12629. </remarks>
  12630. </member>
  12631. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  12632. <summary>
  12633. Creates a repository for the specified assembly and repository type.
  12634. </summary>
  12635. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  12636. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12637. and has a no arg constructor. An instance of this type will be created to act
  12638. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12639. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12640. <remarks>
  12641. <para>
  12642. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  12643. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  12644. same assembly specified will return the same repository instance.
  12645. </para>
  12646. </remarks>
  12647. </member>
  12648. <member name="M:log4net.Core.LoggerManager.GetAllRepositories">
  12649. <summary>
  12650. Gets an array of all currently defined repositories.
  12651. </summary>
  12652. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  12653. <remarks>
  12654. <para>
  12655. Gets an array of all currently defined repositories.
  12656. </para>
  12657. </remarks>
  12658. </member>
  12659. <member name="M:log4net.Core.LoggerManager.GetVersionInfo">
  12660. <summary>
  12661. Internal method to get pertinent version info.
  12662. </summary>
  12663. <returns>A string of version info.</returns>
  12664. </member>
  12665. <member name="M:log4net.Core.LoggerManager.OnDomainUnload(System.Object,System.EventArgs)">
  12666. <summary>
  12667. Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires
  12668. </summary>
  12669. <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
  12670. <param name="e">null</param>
  12671. <remarks>
  12672. <para>
  12673. Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires.
  12674. </para>
  12675. <para>
  12676. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  12677. </para>
  12678. </remarks>
  12679. </member>
  12680. <member name="M:log4net.Core.LoggerManager.OnProcessExit(System.Object,System.EventArgs)">
  12681. <summary>
  12682. Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires
  12683. </summary>
  12684. <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
  12685. <param name="e">null</param>
  12686. <remarks>
  12687. <para>
  12688. Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires.
  12689. </para>
  12690. <para>
  12691. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  12692. </para>
  12693. </remarks>
  12694. </member>
  12695. <member name="F:log4net.Core.LoggerManager.declaringType">
  12696. <summary>
  12697. The fully qualified type of the LoggerManager class.
  12698. </summary>
  12699. <remarks>
  12700. Used by the internal logger to record the Type of the
  12701. log message.
  12702. </remarks>
  12703. </member>
  12704. <member name="F:log4net.Core.LoggerManager.s_repositorySelector">
  12705. <summary>
  12706. Initialize the default repository selector
  12707. </summary>
  12708. </member>
  12709. <member name="P:log4net.Core.LoggerManager.RepositorySelector">
  12710. <summary>
  12711. Gets or sets the repository selector used by the <see cref="T:log4net.LogManager"/>.
  12712. </summary>
  12713. <value>
  12714. The repository selector used by the <see cref="T:log4net.LogManager"/>.
  12715. </value>
  12716. <remarks>
  12717. <para>
  12718. The repository selector (<see cref="T:log4net.Core.IRepositorySelector"/>) is used by
  12719. the <see cref="T:log4net.LogManager"/> to create and select repositories
  12720. (<see cref="T:log4net.Repository.ILoggerRepository"/>).
  12721. </para>
  12722. <para>
  12723. The caller to <see cref="T:log4net.LogManager"/> supplies either a string name
  12724. or an assembly (if not supplied the assembly is inferred using
  12725. <see cref="M:Assembly.GetCallingAssembly()"/>).
  12726. </para>
  12727. <para>
  12728. This context is used by the selector to lookup a specific repository.
  12729. </para>
  12730. <para>
  12731. For the full .NET Framework, the default repository is <c>DefaultRepositorySelector</c>;
  12732. for the .NET Compact Framework <c>CompactRepositorySelector</c> is the default
  12733. repository.
  12734. </para>
  12735. </remarks>
  12736. </member>
  12737. <member name="T:log4net.Core.LoggerWrapperImpl">
  12738. <summary>
  12739. Implementation of the <see cref="T:log4net.Core.ILoggerWrapper"/> interface.
  12740. </summary>
  12741. <remarks>
  12742. <para>
  12743. This class should be used as the base for all wrapper implementations.
  12744. </para>
  12745. </remarks>
  12746. <author>Nicko Cadell</author>
  12747. <author>Gert Driesen</author>
  12748. </member>
  12749. <member name="M:log4net.Core.LoggerWrapperImpl.#ctor(log4net.Core.ILogger)">
  12750. <summary>
  12751. Constructs a new wrapper for the specified logger.
  12752. </summary>
  12753. <param name="logger">The logger to wrap.</param>
  12754. <remarks>
  12755. <para>
  12756. Constructs a new wrapper for the specified logger.
  12757. </para>
  12758. </remarks>
  12759. </member>
  12760. <member name="F:log4net.Core.LoggerWrapperImpl.m_logger">
  12761. <summary>
  12762. The logger that this object is wrapping
  12763. </summary>
  12764. </member>
  12765. <member name="P:log4net.Core.LoggerWrapperImpl.Logger">
  12766. <summary>
  12767. Gets the implementation behind this wrapper object.
  12768. </summary>
  12769. <value>
  12770. The <see cref="T:log4net.Core.ILogger"/> object that this object is implementing.
  12771. </value>
  12772. <remarks>
  12773. <para>
  12774. The <c>Logger</c> object may not be the same object as this object
  12775. because of logger decorators.
  12776. </para>
  12777. <para>
  12778. This gets the actual underlying objects that is used to process
  12779. the log events.
  12780. </para>
  12781. </remarks>
  12782. </member>
  12783. <member name="T:log4net.Core.LoggingEventData">
  12784. <summary>
  12785. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  12786. </summary>
  12787. <remarks>
  12788. <para>
  12789. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  12790. </para>
  12791. </remarks>
  12792. <author>Nicko Cadell</author>
  12793. </member>
  12794. <member name="F:log4net.Core.LoggingEventData.LoggerName">
  12795. <summary>
  12796. The logger name.
  12797. </summary>
  12798. <remarks>
  12799. <para>
  12800. The logger name.
  12801. </para>
  12802. </remarks>
  12803. </member>
  12804. <member name="F:log4net.Core.LoggingEventData.Level">
  12805. <summary>
  12806. Level of logging event.
  12807. </summary>
  12808. <remarks>
  12809. <para>
  12810. Level of logging event. Level cannot be Serializable
  12811. because it is a flyweight. Due to its special serialization it
  12812. cannot be declared final either.
  12813. </para>
  12814. </remarks>
  12815. </member>
  12816. <member name="F:log4net.Core.LoggingEventData.Message">
  12817. <summary>
  12818. The application supplied message.
  12819. </summary>
  12820. <remarks>
  12821. <para>
  12822. The application supplied message of logging event.
  12823. </para>
  12824. </remarks>
  12825. </member>
  12826. <member name="F:log4net.Core.LoggingEventData.ThreadName">
  12827. <summary>
  12828. The name of thread
  12829. </summary>
  12830. <remarks>
  12831. <para>
  12832. The name of thread in which this logging event was generated
  12833. </para>
  12834. </remarks>
  12835. </member>
  12836. <member name="F:log4net.Core.LoggingEventData.TimeStamp">
  12837. <summary>
  12838. Gets or sets the local time the event was logged
  12839. </summary>
  12840. <remarks>
  12841. <para>
  12842. Prefer using the <see cref="P:log4net.Core.LoggingEventData.TimeStampUtc"/> setter, since local time can be ambiguous.
  12843. </para>
  12844. </remarks>
  12845. </member>
  12846. <member name="F:log4net.Core.LoggingEventData.LocationInfo">
  12847. <summary>
  12848. Location information for the caller.
  12849. </summary>
  12850. <remarks>
  12851. <para>
  12852. Location information for the caller.
  12853. </para>
  12854. </remarks>
  12855. </member>
  12856. <member name="F:log4net.Core.LoggingEventData.UserName">
  12857. <summary>
  12858. String representation of the user
  12859. </summary>
  12860. <remarks>
  12861. <para>
  12862. String representation of the user's windows name,
  12863. like DOMAIN\username
  12864. </para>
  12865. </remarks>
  12866. </member>
  12867. <member name="F:log4net.Core.LoggingEventData.Identity">
  12868. <summary>
  12869. String representation of the identity.
  12870. </summary>
  12871. <remarks>
  12872. <para>
  12873. String representation of the current thread's principal identity.
  12874. </para>
  12875. </remarks>
  12876. </member>
  12877. <member name="F:log4net.Core.LoggingEventData.ExceptionString">
  12878. <summary>
  12879. The string representation of the exception
  12880. </summary>
  12881. <remarks>
  12882. <para>
  12883. The string representation of the exception
  12884. </para>
  12885. </remarks>
  12886. </member>
  12887. <member name="F:log4net.Core.LoggingEventData.Domain">
  12888. <summary>
  12889. String representation of the AppDomain.
  12890. </summary>
  12891. <remarks>
  12892. <para>
  12893. String representation of the AppDomain.
  12894. </para>
  12895. </remarks>
  12896. </member>
  12897. <member name="F:log4net.Core.LoggingEventData.Properties">
  12898. <summary>
  12899. Additional event specific properties
  12900. </summary>
  12901. <remarks>
  12902. <para>
  12903. A logger or an appender may attach additional
  12904. properties to specific events. These properties
  12905. have a string key and an object value.
  12906. </para>
  12907. </remarks>
  12908. </member>
  12909. <member name="P:log4net.Core.LoggingEventData.TimeStampUtc">
  12910. <summary>
  12911. Gets or sets the UTC time the event was logged
  12912. </summary>
  12913. <remarks>
  12914. <para>
  12915. The TimeStamp is stored in the UTC time zone.
  12916. </para>
  12917. </remarks>
  12918. </member>
  12919. <member name="T:log4net.Core.FixFlags">
  12920. <summary>
  12921. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  12922. </summary>
  12923. <remarks>
  12924. <para>
  12925. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  12926. </para>
  12927. </remarks>
  12928. <author>Nicko Cadell</author>
  12929. </member>
  12930. <member name="F:log4net.Core.FixFlags.Mdc">
  12931. <summary>
  12932. Fix the MDC
  12933. </summary>
  12934. </member>
  12935. <member name="F:log4net.Core.FixFlags.Ndc">
  12936. <summary>
  12937. Fix the NDC
  12938. </summary>
  12939. </member>
  12940. <member name="F:log4net.Core.FixFlags.Message">
  12941. <summary>
  12942. Fix the rendered message
  12943. </summary>
  12944. </member>
  12945. <member name="F:log4net.Core.FixFlags.ThreadName">
  12946. <summary>
  12947. Fix the thread name
  12948. </summary>
  12949. </member>
  12950. <member name="F:log4net.Core.FixFlags.LocationInfo">
  12951. <summary>
  12952. Fix the callers location information
  12953. </summary>
  12954. <remarks>
  12955. CAUTION: Very slow to generate
  12956. </remarks>
  12957. </member>
  12958. <member name="F:log4net.Core.FixFlags.UserName">
  12959. <summary>
  12960. Fix the callers windows user name
  12961. </summary>
  12962. <remarks>
  12963. CAUTION: Slow to generate
  12964. </remarks>
  12965. </member>
  12966. <member name="F:log4net.Core.FixFlags.Domain">
  12967. <summary>
  12968. Fix the domain friendly name
  12969. </summary>
  12970. </member>
  12971. <member name="F:log4net.Core.FixFlags.Identity">
  12972. <summary>
  12973. Fix the callers principal name
  12974. </summary>
  12975. <remarks>
  12976. CAUTION: May be slow to generate
  12977. </remarks>
  12978. </member>
  12979. <member name="F:log4net.Core.FixFlags.Exception">
  12980. <summary>
  12981. Fix the exception text
  12982. </summary>
  12983. </member>
  12984. <member name="F:log4net.Core.FixFlags.Properties">
  12985. <summary>
  12986. Fix the event properties. Active properties must implement <see cref="T:log4net.Core.IFixingRequired"/> in order to be eligible for fixing.
  12987. </summary>
  12988. </member>
  12989. <member name="F:log4net.Core.FixFlags.None">
  12990. <summary>
  12991. No fields fixed
  12992. </summary>
  12993. </member>
  12994. <member name="F:log4net.Core.FixFlags.All">
  12995. <summary>
  12996. All fields fixed
  12997. </summary>
  12998. </member>
  12999. <member name="F:log4net.Core.FixFlags.Partial">
  13000. <summary>
  13001. Partial fields fixed
  13002. </summary>
  13003. <remarks>
  13004. <para>
  13005. This set of partial fields gives good performance. The following fields are fixed:
  13006. </para>
  13007. <list type="bullet">
  13008. <item><description><see cref="F:log4net.Core.FixFlags.Message"/></description></item>
  13009. <item><description><see cref="F:log4net.Core.FixFlags.ThreadName"/></description></item>
  13010. <item><description><see cref="F:log4net.Core.FixFlags.Exception"/></description></item>
  13011. <item><description><see cref="F:log4net.Core.FixFlags.Domain"/></description></item>
  13012. <item><description><see cref="F:log4net.Core.FixFlags.Properties"/></description></item>
  13013. </list>
  13014. </remarks>
  13015. </member>
  13016. <member name="T:log4net.Core.LoggingEvent">
  13017. <summary>
  13018. The internal representation of logging events.
  13019. </summary>
  13020. <remarks>
  13021. <para>
  13022. When an affirmative decision is made to log then a
  13023. <see cref="T:log4net.Core.LoggingEvent"/> instance is created. This instance
  13024. is passed around to the different log4net components.
  13025. </para>
  13026. <para>
  13027. This class is of concern to those wishing to extend log4net.
  13028. </para>
  13029. <para>
  13030. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  13031. are considered volatile, that is the values are correct at the
  13032. time the event is delivered to appenders, but will not be consistent
  13033. at any time afterwards. If an event is to be stored and then processed
  13034. at a later time these volatile values must be fixed by calling
  13035. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  13036. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  13037. is essential to maintaining data consistency.
  13038. </para>
  13039. </remarks>
  13040. <author>Nicko Cadell</author>
  13041. <author>Gert Driesen</author>
  13042. <author>Douglas de la Torre</author>
  13043. <author>Daniel Cazzulino</author>
  13044. </member>
  13045. <member name="F:log4net.Core.LoggingEvent.HostNameProperty">
  13046. <summary>
  13047. The key into the Properties map for the host name value.
  13048. </summary>
  13049. </member>
  13050. <member name="F:log4net.Core.LoggingEvent.IdentityProperty">
  13051. <summary>
  13052. The key into the Properties map for the thread identity value.
  13053. </summary>
  13054. </member>
  13055. <member name="F:log4net.Core.LoggingEvent.UserNameProperty">
  13056. <summary>
  13057. The key into the Properties map for the user name value.
  13058. </summary>
  13059. </member>
  13060. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,System.String,log4net.Core.Level,System.Object,System.Exception)">
  13061. <summary>
  13062. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  13063. from the supplied parameters.
  13064. </summary>
  13065. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  13066. the stack boundary into the logging system for this call.</param>
  13067. <param name="repository">The repository this event is logged in.</param>
  13068. <param name="loggerName">The name of the logger of this event.</param>
  13069. <param name="level">The level of this event.</param>
  13070. <param name="message">The message of this event.</param>
  13071. <param name="exception">The exception for this event.</param>
  13072. <remarks>
  13073. <para>
  13074. Except <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>, <see cref="P:log4net.Core.LoggingEvent.Level"/> and <see cref="P:log4net.Core.LoggingEvent.LoggerName"/>,
  13075. all fields of <c>LoggingEvent</c> are filled when actually needed. Call
  13076. <see cref="M:FixVolatileData()"/> to cache all data locally
  13077. to prevent inconsistencies.
  13078. </para>
  13079. <para>This method is called by the log4net framework
  13080. to create a logging event.
  13081. </para>
  13082. </remarks>
  13083. </member>
  13084. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData,log4net.Core.FixFlags)">
  13085. <summary>
  13086. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  13087. using specific data.
  13088. </summary>
  13089. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  13090. the stack boundary into the logging system for this call.</param>
  13091. <param name="repository">The repository this event is logged in.</param>
  13092. <param name="data">Data used to initialize the logging event.</param>
  13093. <param name="fixedData">The fields in the <paranref name="data"/> struct that have already been fixed.</param>
  13094. <remarks>
  13095. <para>
  13096. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
  13097. to be created independently of the log4net framework. This can
  13098. be useful if you require a custom serialization scheme.
  13099. </para>
  13100. <para>
  13101. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  13102. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  13103. </para>
  13104. <para>
  13105. The <paramref name="fixedData"/> parameter should be used to specify which fields in the
  13106. <paramref name="data"/> struct have been preset. Fields not specified in the <paramref name="fixedData"/>
  13107. will be captured from the environment if requested or fixed.
  13108. </para>
  13109. </remarks>
  13110. </member>
  13111. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData)">
  13112. <summary>
  13113. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  13114. using specific data.
  13115. </summary>
  13116. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  13117. the stack boundary into the logging system for this call.</param>
  13118. <param name="repository">The repository this event is logged in.</param>
  13119. <param name="data">Data used to initialize the logging event.</param>
  13120. <remarks>
  13121. <para>
  13122. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
  13123. to be created independently of the log4net framework. This can
  13124. be useful if you require a custom serialization scheme.
  13125. </para>
  13126. <para>
  13127. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  13128. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  13129. </para>
  13130. <para>
  13131. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  13132. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  13133. parameter and no other data should be captured from the environment.
  13134. </para>
  13135. </remarks>
  13136. </member>
  13137. <member name="M:log4net.Core.LoggingEvent.#ctor(log4net.Core.LoggingEventData)">
  13138. <summary>
  13139. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  13140. using specific data.
  13141. </summary>
  13142. <param name="data">Data used to initialize the logging event.</param>
  13143. <remarks>
  13144. <para>
  13145. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
  13146. to be created independently of the log4net framework. This can
  13147. be useful if you require a custom serialization scheme.
  13148. </para>
  13149. <para>
  13150. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  13151. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  13152. </para>
  13153. <para>
  13154. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  13155. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  13156. parameter and no other data should be captured from the environment.
  13157. </para>
  13158. </remarks>
  13159. </member>
  13160. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13161. <summary>
  13162. Serialization constructor
  13163. </summary>
  13164. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
  13165. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  13166. <remarks>
  13167. <para>
  13168. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  13169. with serialized data.
  13170. </para>
  13171. </remarks>
  13172. </member>
  13173. <member name="M:log4net.Core.LoggingEvent.EnsureRepository(log4net.Repository.ILoggerRepository)">
  13174. <summary>
  13175. Ensure that the repository is set.
  13176. </summary>
  13177. <param name="repository">the value for the repository</param>
  13178. </member>
  13179. <member name="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)">
  13180. <summary>
  13181. Write the rendered message to a TextWriter
  13182. </summary>
  13183. <param name="writer">the writer to write the message to</param>
  13184. <remarks>
  13185. <para>
  13186. Unlike the <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property this method
  13187. does store the message data in the internal cache. Therefore
  13188. if called only once this method should be faster than the
  13189. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property, however if the message is
  13190. to be accessed multiple times then the property will be more efficient.
  13191. </para>
  13192. </remarks>
  13193. </member>
  13194. <member name="M:log4net.Core.LoggingEvent.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13195. <summary>
  13196. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
  13197. </summary>
  13198. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
  13199. <param name="context">The destination for this serialization.</param>
  13200. <remarks>
  13201. <para>
  13202. The data in this event must be fixed before it can be serialized.
  13203. </para>
  13204. <para>
  13205. The <see cref="M:FixVolatileData()"/> method must be called during the
  13206. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method call if this event
  13207. is to be used outside that method.
  13208. </para>
  13209. </remarks>
  13210. </member>
  13211. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData">
  13212. <summary>
  13213. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>.
  13214. </summary>
  13215. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  13216. <remarks>
  13217. <para>
  13218. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  13219. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  13220. </para>
  13221. <para>
  13222. Does a <see cref="F:log4net.Core.FixFlags.Partial"/> fix of the data
  13223. in the logging event before returning the event data.
  13224. </para>
  13225. </remarks>
  13226. </member>
  13227. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)">
  13228. <summary>
  13229. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>.
  13230. </summary>
  13231. <param name="fixFlags">The set of data to ensure is fixed in the LoggingEventData</param>
  13232. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  13233. <remarks>
  13234. <para>
  13235. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  13236. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  13237. </para>
  13238. </remarks>
  13239. </member>
  13240. <member name="M:log4net.Core.LoggingEvent.GetExceptionStrRep">
  13241. <summary>
  13242. Returns this event's exception's rendered using the
  13243. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13244. </summary>
  13245. <returns>
  13246. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13247. </returns>
  13248. <remarks>
  13249. <para>
  13250. <b>Obsolete. Use <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> instead.</b>
  13251. </para>
  13252. </remarks>
  13253. </member>
  13254. <member name="M:log4net.Core.LoggingEvent.GetExceptionString">
  13255. <summary>
  13256. Returns this event's exception's rendered using the
  13257. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13258. </summary>
  13259. <returns>
  13260. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13261. </returns>
  13262. <remarks>
  13263. <para>
  13264. Returns this event's exception's rendered using the
  13265. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13266. </para>
  13267. </remarks>
  13268. </member>
  13269. <member name="M:log4net.Core.LoggingEvent.FixVolatileData">
  13270. <summary>
  13271. Fix instance fields that hold volatile data.
  13272. </summary>
  13273. <remarks>
  13274. <para>
  13275. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  13276. are considered volatile, that is the values are correct at the
  13277. time the event is delivered to appenders, but will not be consistent
  13278. at any time afterwards. If an event is to be stored and then processed
  13279. at a later time these volatile values must be fixed by calling
  13280. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  13281. incurred by calling <see cref="M:FixVolatileData()"/> but it
  13282. is essential to maintaining data consistency.
  13283. </para>
  13284. <para>
  13285. Calling <see cref="M:FixVolatileData()"/> is equivalent to
  13286. calling <see cref="M:FixVolatileData(bool)"/> passing the parameter
  13287. <c>false</c>.
  13288. </para>
  13289. <para>
  13290. See <see cref="M:FixVolatileData(bool)"/> for more
  13291. information.
  13292. </para>
  13293. </remarks>
  13294. </member>
  13295. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)">
  13296. <summary>
  13297. Fixes instance fields that hold volatile data.
  13298. </summary>
  13299. <param name="fastButLoose">Set to <c>true</c> to not fix data that takes a long time to fix.</param>
  13300. <remarks>
  13301. <para>
  13302. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  13303. are considered volatile, that is the values are correct at the
  13304. time the event is delivered to appenders, but will not be consistent
  13305. at any time afterwards. If an event is to be stored and then processed
  13306. at a later time these volatile values must be fixed by calling
  13307. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  13308. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  13309. is essential to maintaining data consistency.
  13310. </para>
  13311. <para>
  13312. The <paramref name="fastButLoose"/> param controls the data that
  13313. is fixed. Some of the data that can be fixed takes a long time to
  13314. generate, therefore if you do not require those settings to be fixed
  13315. they can be ignored by setting the <paramref name="fastButLoose"/> param
  13316. to <c>true</c>. This setting will ignore the <see cref="P:log4net.Core.LoggingEvent.LocationInformation"/>
  13317. and <see cref="P:log4net.Core.LoggingEvent.UserName"/> settings.
  13318. </para>
  13319. <para>
  13320. Set <paramref name="fastButLoose"/> to <c>false</c> to ensure that all
  13321. settings are fixed.
  13322. </para>
  13323. </remarks>
  13324. </member>
  13325. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)">
  13326. <summary>
  13327. Fix the fields specified by the <see cref="T:log4net.Core.FixFlags"/> parameter
  13328. </summary>
  13329. <param name="flags">the fields to fix</param>
  13330. <remarks>
  13331. <para>
  13332. Only fields specified in the <paramref name="flags"/> will be fixed.
  13333. Fields will not be fixed if they have previously been fixed.
  13334. It is not possible to 'unfix' a field.
  13335. </para>
  13336. </remarks>
  13337. </member>
  13338. <member name="M:log4net.Core.LoggingEvent.LookupProperty(System.String)">
  13339. <summary>
  13340. Lookup a composite property in this event
  13341. </summary>
  13342. <param name="key">the key for the property to lookup</param>
  13343. <returns>the value for the property</returns>
  13344. <remarks>
  13345. <para>
  13346. This event has composite properties that combine together properties from
  13347. several different contexts in the following order:
  13348. <list type="definition">
  13349. <item>
  13350. <term>this events properties</term>
  13351. <description>
  13352. This event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  13353. properties are specific to this event only.
  13354. </description>
  13355. </item>
  13356. <item>
  13357. <term>the thread properties</term>
  13358. <description>
  13359. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  13360. thread. These properties are shared by all events logged on this thread.
  13361. </description>
  13362. </item>
  13363. <item>
  13364. <term>the global properties</term>
  13365. <description>
  13366. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  13367. properties are shared by all the threads in the AppDomain.
  13368. </description>
  13369. </item>
  13370. </list>
  13371. </para>
  13372. </remarks>
  13373. </member>
  13374. <member name="M:log4net.Core.LoggingEvent.GetProperties">
  13375. <summary>
  13376. Get all the composite properties in this event
  13377. </summary>
  13378. <returns>the <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the properties</returns>
  13379. <remarks>
  13380. <para>
  13381. See <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/> for details of the composite properties
  13382. stored by the event.
  13383. </para>
  13384. <para>
  13385. This method returns a single <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the
  13386. properties defined for this event.
  13387. </para>
  13388. </remarks>
  13389. </member>
  13390. <member name="F:log4net.Core.LoggingEvent.m_data">
  13391. <summary>
  13392. The internal logging event data.
  13393. </summary>
  13394. </member>
  13395. <member name="F:log4net.Core.LoggingEvent.m_compositeProperties">
  13396. <summary>
  13397. The internal logging event data.
  13398. </summary>
  13399. </member>
  13400. <member name="F:log4net.Core.LoggingEvent.m_eventProperties">
  13401. <summary>
  13402. The internal logging event data.
  13403. </summary>
  13404. </member>
  13405. <member name="F:log4net.Core.LoggingEvent.m_callerStackBoundaryDeclaringType">
  13406. <summary>
  13407. The fully qualified Type of the calling
  13408. logger class in the stack frame (i.e. the declaring type of the method).
  13409. </summary>
  13410. </member>
  13411. <member name="F:log4net.Core.LoggingEvent.m_message">
  13412. <summary>
  13413. The application supplied message of logging event.
  13414. </summary>
  13415. </member>
  13416. <member name="F:log4net.Core.LoggingEvent.m_thrownException">
  13417. <summary>
  13418. The exception that was thrown.
  13419. </summary>
  13420. <remarks>
  13421. This is not serialized. The string representation
  13422. is serialized instead.
  13423. </remarks>
  13424. </member>
  13425. <member name="F:log4net.Core.LoggingEvent.m_repository">
  13426. <summary>
  13427. The repository that generated the logging event
  13428. </summary>
  13429. <remarks>
  13430. This is not serialized.
  13431. </remarks>
  13432. </member>
  13433. <member name="F:log4net.Core.LoggingEvent.m_fixFlags">
  13434. <summary>
  13435. The fix state for this event
  13436. </summary>
  13437. <remarks>
  13438. These flags indicate which fields have been fixed.
  13439. Not serialized.
  13440. </remarks>
  13441. </member>
  13442. <member name="F:log4net.Core.LoggingEvent.m_cacheUpdatable">
  13443. <summary>
  13444. Indicated that the internal cache is updateable (ie not fixed)
  13445. </summary>
  13446. <remarks>
  13447. This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler
  13448. changes in the caching strategy.
  13449. </remarks>
  13450. </member>
  13451. <member name="P:log4net.Core.LoggingEvent.StartTime">
  13452. <summary>
  13453. Gets the time when the current process started.
  13454. </summary>
  13455. <value>
  13456. This is the time when this process started.
  13457. </value>
  13458. <remarks>
  13459. <para>
  13460. The TimeStamp is stored internally in UTC and converted to the local time zone for this computer.
  13461. </para>
  13462. <para>
  13463. Tries to get the start time for the current process.
  13464. Failing that it returns the time of the first call to
  13465. this property.
  13466. </para>
  13467. <para>
  13468. Note that AppDomains may be loaded and unloaded within the
  13469. same process without the process terminating and therefore
  13470. without the process start time being reset.
  13471. </para>
  13472. </remarks>
  13473. </member>
  13474. <member name="P:log4net.Core.LoggingEvent.StartTimeUtc">
  13475. <summary>
  13476. Gets the UTC time when the current process started.
  13477. </summary>
  13478. <value>
  13479. This is the UTC time when this process started.
  13480. </value>
  13481. <remarks>
  13482. <para>
  13483. Tries to get the start time for the current process.
  13484. Failing that it returns the time of the first call to
  13485. this property.
  13486. </para>
  13487. <para>
  13488. Note that AppDomains may be loaded and unloaded within the
  13489. same process without the process terminating and therefore
  13490. without the process start time being reset.
  13491. </para>
  13492. </remarks>
  13493. </member>
  13494. <member name="P:log4net.Core.LoggingEvent.Level">
  13495. <summary>
  13496. Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
  13497. </summary>
  13498. <value>
  13499. The <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
  13500. </value>
  13501. <remarks>
  13502. <para>
  13503. Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
  13504. </para>
  13505. </remarks>
  13506. </member>
  13507. <member name="P:log4net.Core.LoggingEvent.TimeStamp">
  13508. <summary>
  13509. Gets the time of the logging event.
  13510. </summary>
  13511. <value>
  13512. The time of the logging event.
  13513. </value>
  13514. <remarks>
  13515. <para>
  13516. The TimeStamp is stored in UTC and converted to the local time zone for this computer.
  13517. </para>
  13518. </remarks>
  13519. </member>
  13520. <member name="P:log4net.Core.LoggingEvent.TimeStampUtc">
  13521. <summary>
  13522. Gets UTC the time of the logging event.
  13523. </summary>
  13524. <value>
  13525. The UTC time of the logging event.
  13526. </value>
  13527. </member>
  13528. <member name="P:log4net.Core.LoggingEvent.LoggerName">
  13529. <summary>
  13530. Gets the name of the logger that logged the event.
  13531. </summary>
  13532. <value>
  13533. The name of the logger that logged the event.
  13534. </value>
  13535. <remarks>
  13536. <para>
  13537. Gets the name of the logger that logged the event.
  13538. </para>
  13539. </remarks>
  13540. </member>
  13541. <member name="P:log4net.Core.LoggingEvent.LocationInformation">
  13542. <summary>
  13543. Gets the location information for this logging event.
  13544. </summary>
  13545. <value>
  13546. The location information for this logging event.
  13547. </value>
  13548. <remarks>
  13549. <para>
  13550. The collected information is cached for future use.
  13551. </para>
  13552. <para>
  13553. See the <see cref="T:log4net.Core.LocationInfo"/> class for more information on
  13554. supported frameworks and the different behavior in Debug and
  13555. Release builds.
  13556. </para>
  13557. </remarks>
  13558. </member>
  13559. <member name="P:log4net.Core.LoggingEvent.MessageObject">
  13560. <summary>
  13561. Gets the message object used to initialize this event.
  13562. </summary>
  13563. <value>
  13564. The message object used to initialize this event.
  13565. </value>
  13566. <remarks>
  13567. <para>
  13568. Gets the message object used to initialize this event.
  13569. Note that this event may not have a valid message object.
  13570. If the event is serialized the message object will not
  13571. be transferred. To get the text of the message the
  13572. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property must be used
  13573. not this property.
  13574. </para>
  13575. <para>
  13576. If there is no defined message object for this event then
  13577. null will be returned.
  13578. </para>
  13579. </remarks>
  13580. </member>
  13581. <member name="P:log4net.Core.LoggingEvent.ExceptionObject">
  13582. <summary>
  13583. Gets the exception object used to initialize this event.
  13584. </summary>
  13585. <value>
  13586. The exception object used to initialize this event.
  13587. </value>
  13588. <remarks>
  13589. <para>
  13590. Gets the exception object used to initialize this event.
  13591. Note that this event may not have a valid exception object.
  13592. If the event is serialized the exception object will not
  13593. be transferred. To get the text of the exception the
  13594. <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> method must be used
  13595. not this property.
  13596. </para>
  13597. <para>
  13598. If there is no defined exception object for this event then
  13599. null will be returned.
  13600. </para>
  13601. </remarks>
  13602. </member>
  13603. <member name="P:log4net.Core.LoggingEvent.Repository">
  13604. <summary>
  13605. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  13606. </summary>
  13607. <remarks>
  13608. <para>
  13609. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  13610. </para>
  13611. </remarks>
  13612. </member>
  13613. <member name="P:log4net.Core.LoggingEvent.RenderedMessage">
  13614. <summary>
  13615. Gets the message, rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13616. </summary>
  13617. <value>
  13618. The message rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13619. </value>
  13620. <remarks>
  13621. <para>
  13622. The collected information is cached for future use.
  13623. </para>
  13624. </remarks>
  13625. </member>
  13626. <member name="P:log4net.Core.LoggingEvent.ThreadName">
  13627. <summary>
  13628. Gets the name of the current thread.
  13629. </summary>
  13630. <value>
  13631. The name of the current thread, or the thread ID when
  13632. the name is not available.
  13633. </value>
  13634. <remarks>
  13635. <para>
  13636. The collected information is cached for future use.
  13637. </para>
  13638. </remarks>
  13639. </member>
  13640. <member name="P:log4net.Core.LoggingEvent.UserName">
  13641. <summary>
  13642. Gets the name of the current user.
  13643. </summary>
  13644. <value>
  13645. The name of the current user, or <c>NOT AVAILABLE</c> when the
  13646. underlying runtime has no support for retrieving the name of the
  13647. current user.
  13648. </value>
  13649. <remarks>
  13650. <para>
  13651. Calls <c>WindowsIdentity.GetCurrent().Name</c> to get the name of
  13652. the current windows user.
  13653. </para>
  13654. <para>
  13655. To improve performance, we could cache the string representation of
  13656. the name, and reuse that as long as the identity stayed constant.
  13657. Once the identity changed, we would need to re-assign and re-render
  13658. the string.
  13659. </para>
  13660. <para>
  13661. However, the <c>WindowsIdentity.GetCurrent()</c> call seems to
  13662. return different objects every time, so the current implementation
  13663. doesn't do this type of caching.
  13664. </para>
  13665. <para>
  13666. Timing for these operations:
  13667. </para>
  13668. <list type="table">
  13669. <listheader>
  13670. <term>Method</term>
  13671. <description>Results</description>
  13672. </listheader>
  13673. <item>
  13674. <term><c>WindowsIdentity.GetCurrent()</c></term>
  13675. <description>10000 loops, 00:00:00.2031250 seconds</description>
  13676. </item>
  13677. <item>
  13678. <term><c>WindowsIdentity.GetCurrent().Name</c></term>
  13679. <description>10000 loops, 00:00:08.0468750 seconds</description>
  13680. </item>
  13681. </list>
  13682. <para>
  13683. This means we could speed things up almost 40 times by caching the
  13684. value of the <c>WindowsIdentity.GetCurrent().Name</c> property, since
  13685. this takes (8.04-0.20) = 7.84375 seconds.
  13686. </para>
  13687. </remarks>
  13688. </member>
  13689. <member name="P:log4net.Core.LoggingEvent.Identity">
  13690. <summary>
  13691. Gets the identity of the current thread principal.
  13692. </summary>
  13693. <value>
  13694. The string name of the identity of the current thread principal.
  13695. </value>
  13696. <remarks>
  13697. <para>
  13698. Calls <c>System.Threading.Thread.CurrentPrincipal.Identity.Name</c> to get
  13699. the name of the current thread principal.
  13700. </para>
  13701. </remarks>
  13702. </member>
  13703. <member name="P:log4net.Core.LoggingEvent.Domain">
  13704. <summary>
  13705. Gets the AppDomain friendly name.
  13706. </summary>
  13707. <value>
  13708. The AppDomain friendly name.
  13709. </value>
  13710. <remarks>
  13711. <para>
  13712. Gets the AppDomain friendly name.
  13713. </para>
  13714. </remarks>
  13715. </member>
  13716. <member name="P:log4net.Core.LoggingEvent.Properties">
  13717. <summary>
  13718. Additional event specific properties.
  13719. </summary>
  13720. <value>
  13721. Additional event specific properties.
  13722. </value>
  13723. <remarks>
  13724. <para>
  13725. A logger or an appender may attach additional
  13726. properties to specific events. These properties
  13727. have a string key and an object value.
  13728. </para>
  13729. <para>
  13730. This property is for events that have been added directly to
  13731. this event. The aggregate properties (which include these
  13732. event properties) can be retrieved using <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/>
  13733. and <see cref="M:log4net.Core.LoggingEvent.GetProperties"/>.
  13734. </para>
  13735. <para>
  13736. Once the properties have been fixed <see cref="P:log4net.Core.LoggingEvent.Fix"/> this property
  13737. returns the combined cached properties. This ensures that updates to
  13738. this property are always reflected in the underlying storage. When
  13739. returning the combined properties there may be more keys in the
  13740. Dictionary than expected.
  13741. </para>
  13742. </remarks>
  13743. </member>
  13744. <member name="P:log4net.Core.LoggingEvent.Fix">
  13745. <summary>
  13746. The fixed fields in this event
  13747. </summary>
  13748. <value>
  13749. The set of fields that are fixed in this event
  13750. </value>
  13751. <remarks>
  13752. <para>
  13753. Fields will not be fixed if they have previously been fixed.
  13754. It is not possible to 'unfix' a field.
  13755. </para>
  13756. </remarks>
  13757. </member>
  13758. <member name="T:log4net.Core.LogImpl">
  13759. <summary>
  13760. Implementation of <see cref="T:log4net.ILog"/> wrapper interface.
  13761. </summary>
  13762. <remarks>
  13763. <para>
  13764. This implementation of the <see cref="T:log4net.ILog"/> interface
  13765. forwards to the <see cref="T:log4net.Core.ILogger"/> held by the base class.
  13766. </para>
  13767. <para>
  13768. This logger has methods to allow the caller to log at the following
  13769. levels:
  13770. </para>
  13771. <list type="definition">
  13772. <item>
  13773. <term>DEBUG</term>
  13774. <description>
  13775. The <see cref="M:Debug(object)"/> and <see cref="M:DebugFormat(string, object[])"/> methods log messages
  13776. at the <c>DEBUG</c> level. That is the level with that name defined in the
  13777. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13778. for this level is <see cref="F:log4net.Core.Level.Debug"/>. The <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  13779. property tests if this level is enabled for logging.
  13780. </description>
  13781. </item>
  13782. <item>
  13783. <term>INFO</term>
  13784. <description>
  13785. The <see cref="M:Info(object)"/> and <see cref="M:InfoFormat(string, object[])"/> methods log messages
  13786. at the <c>INFO</c> level. That is the level with that name defined in the
  13787. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13788. for this level is <see cref="F:log4net.Core.Level.Info"/>. The <see cref="P:log4net.Core.LogImpl.IsInfoEnabled"/>
  13789. property tests if this level is enabled for logging.
  13790. </description>
  13791. </item>
  13792. <item>
  13793. <term>WARN</term>
  13794. <description>
  13795. The <see cref="M:Warn(object)"/> and <see cref="M:WarnFormat(string, object[])"/> methods log messages
  13796. at the <c>WARN</c> level. That is the level with that name defined in the
  13797. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13798. for this level is <see cref="F:log4net.Core.Level.Warn"/>. The <see cref="P:log4net.Core.LogImpl.IsWarnEnabled"/>
  13799. property tests if this level is enabled for logging.
  13800. </description>
  13801. </item>
  13802. <item>
  13803. <term>ERROR</term>
  13804. <description>
  13805. The <see cref="M:Error(object)"/> and <see cref="M:ErrorFormat(string, object[])"/> methods log messages
  13806. at the <c>ERROR</c> level. That is the level with that name defined in the
  13807. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13808. for this level is <see cref="F:log4net.Core.Level.Error"/>. The <see cref="P:log4net.Core.LogImpl.IsErrorEnabled"/>
  13809. property tests if this level is enabled for logging.
  13810. </description>
  13811. </item>
  13812. <item>
  13813. <term>FATAL</term>
  13814. <description>
  13815. The <see cref="M:Fatal(object)"/> and <see cref="M:FatalFormat(string, object[])"/> methods log messages
  13816. at the <c>FATAL</c> level. That is the level with that name defined in the
  13817. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13818. for this level is <see cref="F:log4net.Core.Level.Fatal"/>. The <see cref="P:log4net.Core.LogImpl.IsFatalEnabled"/>
  13819. property tests if this level is enabled for logging.
  13820. </description>
  13821. </item>
  13822. </list>
  13823. <para>
  13824. The values for these levels and their semantic meanings can be changed by
  13825. configuring the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> for the repository.
  13826. </para>
  13827. </remarks>
  13828. <author>Nicko Cadell</author>
  13829. <author>Gert Driesen</author>
  13830. </member>
  13831. <member name="T:log4net.ILog">
  13832. <summary>
  13833. The ILog interface is use by application to log messages into
  13834. the log4net framework.
  13835. </summary>
  13836. <remarks>
  13837. <para>
  13838. Use the <see cref="T:log4net.LogManager"/> to obtain logger instances
  13839. that implement this interface. The <see cref="M:LogManager.GetLogger(Assembly,Type)"/>
  13840. static method is used to get logger instances.
  13841. </para>
  13842. <para>
  13843. This class contains methods for logging at different levels and also
  13844. has properties for determining if those logging levels are
  13845. enabled in the current configuration.
  13846. </para>
  13847. <para>
  13848. This interface can be implemented in different ways. This documentation
  13849. specifies reasonable behavior that a caller can expect from the actual
  13850. implementation, however different implementations reserve the right to
  13851. do things differently.
  13852. </para>
  13853. </remarks>
  13854. <example>Simple example of logging messages
  13855. <code lang="C#">
  13856. ILog log = LogManager.GetLogger("application-log");
  13857. log.Info("Application Start");
  13858. log.Debug("This is a debug message");
  13859. if (log.IsDebugEnabled)
  13860. {
  13861. log.Debug("This is another debug message");
  13862. }
  13863. </code>
  13864. </example>
  13865. <seealso cref="T:log4net.LogManager"/>
  13866. <seealso cref="M:LogManager.GetLogger(Assembly, Type)"/>
  13867. <author>Nicko Cadell</author>
  13868. <author>Gert Driesen</author>
  13869. </member>
  13870. <member name="M:log4net.ILog.Debug(System.Object)">
  13871. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  13872. <summary>
  13873. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13874. </summary>
  13875. <param name="message">The message object to log.</param>
  13876. <remarks>
  13877. <para>
  13878. This method first checks if this logger is <c>DEBUG</c>
  13879. enabled by comparing the level of this logger with the
  13880. <see cref="F:log4net.Core.Level.Debug"/> level. If this logger is
  13881. <c>DEBUG</c> enabled, then it converts the message object
  13882. (passed as parameter) to a string by invoking the appropriate
  13883. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  13884. proceeds to call all the registered appenders in this logger
  13885. and also higher in the hierarchy depending on the value of
  13886. the additivity flag.
  13887. </para>
  13888. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  13889. to this method will print the name of the <see cref="T:System.Exception"/>
  13890. but no stack trace. To print a stack trace use the
  13891. <see cref="M:Debug(object,Exception)"/> form instead.
  13892. </para>
  13893. </remarks>
  13894. <seealso cref="M:Debug(object,Exception)"/>
  13895. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13896. </member>
  13897. <member name="M:log4net.ILog.Debug(System.Object,System.Exception)">
  13898. <summary>
  13899. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  13900. the stack trace of the <see cref="T:System.Exception"/> passed
  13901. as a parameter.
  13902. </summary>
  13903. <param name="message">The message object to log.</param>
  13904. <param name="exception">The exception to log, including its stack trace.</param>
  13905. <remarks>
  13906. <para>
  13907. See the <see cref="M:Debug(object)"/> form for more detailed information.
  13908. </para>
  13909. </remarks>
  13910. <seealso cref="M:Debug(object)"/>
  13911. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13912. </member>
  13913. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object[])">
  13914. <overloads>Log a formatted string with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  13915. <summary>
  13916. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13917. </summary>
  13918. <param name="format">A String containing zero or more format items</param>
  13919. <param name="args">An Object array containing zero or more objects to format</param>
  13920. <remarks>
  13921. <para>
  13922. The message is formatted using the <c>String.Format</c> method. See
  13923. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13924. of the formatting.
  13925. </para>
  13926. <para>
  13927. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13928. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13929. methods instead.
  13930. </para>
  13931. </remarks>
  13932. <seealso cref="M:Debug(object)"/>
  13933. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13934. </member>
  13935. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object)">
  13936. <summary>
  13937. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13938. </summary>
  13939. <param name="format">A String containing zero or more format items</param>
  13940. <param name="arg0">An Object to format</param>
  13941. <remarks>
  13942. <para>
  13943. The message is formatted using the <c>String.Format</c> method. See
  13944. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13945. of the formatting.
  13946. </para>
  13947. <para>
  13948. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13949. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13950. methods instead.
  13951. </para>
  13952. </remarks>
  13953. <seealso cref="M:Debug(object)"/>
  13954. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13955. </member>
  13956. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object)">
  13957. <summary>
  13958. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13959. </summary>
  13960. <param name="format">A String containing zero or more format items</param>
  13961. <param name="arg0">An Object to format</param>
  13962. <param name="arg1">An Object to format</param>
  13963. <remarks>
  13964. <para>
  13965. The message is formatted using the <c>String.Format</c> method. See
  13966. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13967. of the formatting.
  13968. </para>
  13969. <para>
  13970. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13971. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13972. methods instead.
  13973. </para>
  13974. </remarks>
  13975. <seealso cref="M:Debug(object)"/>
  13976. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13977. </member>
  13978. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  13979. <summary>
  13980. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13981. </summary>
  13982. <param name="format">A String containing zero or more format items</param>
  13983. <param name="arg0">An Object to format</param>
  13984. <param name="arg1">An Object to format</param>
  13985. <param name="arg2">An Object to format</param>
  13986. <remarks>
  13987. <para>
  13988. The message is formatted using the <c>String.Format</c> method. See
  13989. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13990. of the formatting.
  13991. </para>
  13992. <para>
  13993. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13994. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13995. methods instead.
  13996. </para>
  13997. </remarks>
  13998. <seealso cref="M:Debug(object)"/>
  13999. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14000. </member>
  14001. <member name="M:log4net.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  14002. <summary>
  14003. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14004. </summary>
  14005. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14006. <param name="format">A String containing zero or more format items</param>
  14007. <param name="args">An Object array containing zero or more objects to format</param>
  14008. <remarks>
  14009. <para>
  14010. The message is formatted using the <c>String.Format</c> method. See
  14011. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14012. of the formatting.
  14013. </para>
  14014. <para>
  14015. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14016. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  14017. methods instead.
  14018. </para>
  14019. </remarks>
  14020. <seealso cref="M:Debug(object)"/>
  14021. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14022. </member>
  14023. <member name="M:log4net.ILog.Info(System.Object)">
  14024. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  14025. <summary>
  14026. Logs a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  14027. </summary>
  14028. <remarks>
  14029. <para>
  14030. This method first checks if this logger is <c>INFO</c>
  14031. enabled by comparing the level of this logger with the
  14032. <see cref="F:log4net.Core.Level.Info"/> level. If this logger is
  14033. <c>INFO</c> enabled, then it converts the message object
  14034. (passed as parameter) to a string by invoking the appropriate
  14035. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14036. proceeds to call all the registered appenders in this logger
  14037. and also higher in the hierarchy depending on the value of the
  14038. additivity flag.
  14039. </para>
  14040. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14041. to this method will print the name of the <see cref="T:System.Exception"/>
  14042. but no stack trace. To print a stack trace use the
  14043. <see cref="M:Info(object,Exception)"/> form instead.
  14044. </para>
  14045. </remarks>
  14046. <param name="message">The message object to log.</param>
  14047. <seealso cref="M:Info(object,Exception)"/>
  14048. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14049. </member>
  14050. <member name="M:log4net.ILog.Info(System.Object,System.Exception)">
  14051. <summary>
  14052. Logs a message object with the <c>INFO</c> level including
  14053. the stack trace of the <see cref="T:System.Exception"/> passed
  14054. as a parameter.
  14055. </summary>
  14056. <param name="message">The message object to log.</param>
  14057. <param name="exception">The exception to log, including its stack trace.</param>
  14058. <remarks>
  14059. <para>
  14060. See the <see cref="M:Info(object)"/> form for more detailed information.
  14061. </para>
  14062. </remarks>
  14063. <seealso cref="M:Info(object)"/>
  14064. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14065. </member>
  14066. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])">
  14067. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  14068. <summary>
  14069. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14070. </summary>
  14071. <param name="format">A String containing zero or more format items</param>
  14072. <param name="args">An Object array containing zero or more objects to format</param>
  14073. <remarks>
  14074. <para>
  14075. The message is formatted using the <c>String.Format</c> method. See
  14076. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14077. of the formatting.
  14078. </para>
  14079. <para>
  14080. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14081. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14082. methods instead.
  14083. </para>
  14084. </remarks>
  14085. <seealso cref="M:Info(object,Exception)"/>
  14086. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14087. </member>
  14088. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object)">
  14089. <summary>
  14090. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14091. </summary>
  14092. <param name="format">A String containing zero or more format items</param>
  14093. <param name="arg0">An Object to format</param>
  14094. <remarks>
  14095. <para>
  14096. The message is formatted using the <c>String.Format</c> method. See
  14097. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14098. of the formatting.
  14099. </para>
  14100. <para>
  14101. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14102. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14103. methods instead.
  14104. </para>
  14105. </remarks>
  14106. <seealso cref="M:Info(object)"/>
  14107. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14108. </member>
  14109. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object)">
  14110. <summary>
  14111. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14112. </summary>
  14113. <param name="format">A String containing zero or more format items</param>
  14114. <param name="arg0">An Object to format</param>
  14115. <param name="arg1">An Object to format</param>
  14116. <remarks>
  14117. <para>
  14118. The message is formatted using the <c>String.Format</c> method. See
  14119. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14120. of the formatting.
  14121. </para>
  14122. <para>
  14123. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14124. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14125. methods instead.
  14126. </para>
  14127. </remarks>
  14128. <seealso cref="M:Info(object)"/>
  14129. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14130. </member>
  14131. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  14132. <summary>
  14133. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14134. </summary>
  14135. <param name="format">A String containing zero or more format items</param>
  14136. <param name="arg0">An Object to format</param>
  14137. <param name="arg1">An Object to format</param>
  14138. <param name="arg2">An Object to format</param>
  14139. <remarks>
  14140. <para>
  14141. The message is formatted using the <c>String.Format</c> method. See
  14142. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14143. of the formatting.
  14144. </para>
  14145. <para>
  14146. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14147. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14148. methods instead.
  14149. </para>
  14150. </remarks>
  14151. <seealso cref="M:Info(object)"/>
  14152. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14153. </member>
  14154. <member name="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  14155. <summary>
  14156. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14157. </summary>
  14158. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14159. <param name="format">A String containing zero or more format items</param>
  14160. <param name="args">An Object array containing zero or more objects to format</param>
  14161. <remarks>
  14162. <para>
  14163. The message is formatted using the <c>String.Format</c> method. See
  14164. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14165. of the formatting.
  14166. </para>
  14167. <para>
  14168. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14169. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14170. methods instead.
  14171. </para>
  14172. </remarks>
  14173. <seealso cref="M:Info(object,Exception)"/>
  14174. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14175. </member>
  14176. <member name="M:log4net.ILog.Warn(System.Object)">
  14177. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  14178. <summary>
  14179. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14180. </summary>
  14181. <remarks>
  14182. <para>
  14183. This method first checks if this logger is <c>WARN</c>
  14184. enabled by comparing the level of this logger with the
  14185. <see cref="F:log4net.Core.Level.Warn"/> level. If this logger is
  14186. <c>WARN</c> enabled, then it converts the message object
  14187. (passed as parameter) to a string by invoking the appropriate
  14188. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14189. proceeds to call all the registered appenders in this logger
  14190. and also higher in the hierarchy depending on the value of the
  14191. additivity flag.
  14192. </para>
  14193. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14194. to this method will print the name of the <see cref="T:System.Exception"/>
  14195. but no stack trace. To print a stack trace use the
  14196. <see cref="M:Warn(object,Exception)"/> form instead.
  14197. </para>
  14198. </remarks>
  14199. <param name="message">The message object to log.</param>
  14200. <seealso cref="M:Warn(object,Exception)"/>
  14201. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14202. </member>
  14203. <member name="M:log4net.ILog.Warn(System.Object,System.Exception)">
  14204. <summary>
  14205. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  14206. the stack trace of the <see cref="T:System.Exception"/> passed
  14207. as a parameter.
  14208. </summary>
  14209. <param name="message">The message object to log.</param>
  14210. <param name="exception">The exception to log, including its stack trace.</param>
  14211. <remarks>
  14212. <para>
  14213. See the <see cref="M:Warn(object)"/> form for more detailed information.
  14214. </para>
  14215. </remarks>
  14216. <seealso cref="M:Warn(object)"/>
  14217. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14218. </member>
  14219. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object[])">
  14220. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  14221. <summary>
  14222. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14223. </summary>
  14224. <param name="format">A String containing zero or more format items</param>
  14225. <param name="args">An Object array containing zero or more objects to format</param>
  14226. <remarks>
  14227. <para>
  14228. The message is formatted using the <c>String.Format</c> method. See
  14229. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14230. of the formatting.
  14231. </para>
  14232. <para>
  14233. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14234. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14235. methods instead.
  14236. </para>
  14237. </remarks>
  14238. <seealso cref="M:Warn(object,Exception)"/>
  14239. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14240. </member>
  14241. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object)">
  14242. <summary>
  14243. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14244. </summary>
  14245. <param name="format">A String containing zero or more format items</param>
  14246. <param name="arg0">An Object to format</param>
  14247. <remarks>
  14248. <para>
  14249. The message is formatted using the <c>String.Format</c> method. See
  14250. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14251. of the formatting.
  14252. </para>
  14253. <para>
  14254. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14255. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  14256. methods instead.
  14257. </para>
  14258. </remarks>
  14259. <seealso cref="M:Warn(object)"/>
  14260. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14261. </member>
  14262. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object)">
  14263. <summary>
  14264. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14265. </summary>
  14266. <param name="format">A String containing zero or more format items</param>
  14267. <param name="arg0">An Object to format</param>
  14268. <param name="arg1">An Object to format</param>
  14269. <remarks>
  14270. <para>
  14271. The message is formatted using the <c>String.Format</c> method. See
  14272. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14273. of the formatting.
  14274. </para>
  14275. <para>
  14276. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14277. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  14278. methods instead.
  14279. </para>
  14280. </remarks>
  14281. <seealso cref="M:Warn(object)"/>
  14282. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14283. </member>
  14284. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  14285. <summary>
  14286. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14287. </summary>
  14288. <param name="format">A String containing zero or more format items</param>
  14289. <param name="arg0">An Object to format</param>
  14290. <param name="arg1">An Object to format</param>
  14291. <param name="arg2">An Object to format</param>
  14292. <remarks>
  14293. <para>
  14294. The message is formatted using the <c>String.Format</c> method. See
  14295. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14296. of the formatting.
  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:Warn(object,Exception)"/>
  14301. methods instead.
  14302. </para>
  14303. </remarks>
  14304. <seealso cref="M:Warn(object)"/>
  14305. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14306. </member>
  14307. <member name="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  14308. <summary>
  14309. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14310. </summary>
  14311. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14312. <param name="format">A String containing zero or more format items</param>
  14313. <param name="args">An Object array containing zero or more objects to format</param>
  14314. <remarks>
  14315. <para>
  14316. The message is formatted using the <c>String.Format</c> method. See
  14317. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14318. of the formatting.
  14319. </para>
  14320. <para>
  14321. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14322. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14323. methods instead.
  14324. </para>
  14325. </remarks>
  14326. <seealso cref="M:Warn(object,Exception)"/>
  14327. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14328. </member>
  14329. <member name="M:log4net.ILog.Error(System.Object)">
  14330. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  14331. <summary>
  14332. Logs a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  14333. </summary>
  14334. <param name="message">The message object to log.</param>
  14335. <remarks>
  14336. <para>
  14337. This method first checks if this logger is <c>ERROR</c>
  14338. enabled by comparing the level of this logger with the
  14339. <see cref="F:log4net.Core.Level.Error"/> level. If this logger is
  14340. <c>ERROR</c> enabled, then it converts the message object
  14341. (passed as parameter) to a string by invoking the appropriate
  14342. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14343. proceeds to call all the registered appenders in this logger
  14344. and also higher in the hierarchy depending on the value of the
  14345. additivity flag.
  14346. </para>
  14347. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14348. to this method will print the name of the <see cref="T:System.Exception"/>
  14349. but no stack trace. To print a stack trace use the
  14350. <see cref="M:Error(object,Exception)"/> form instead.
  14351. </para>
  14352. </remarks>
  14353. <seealso cref="M:Error(object,Exception)"/>
  14354. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14355. </member>
  14356. <member name="M:log4net.ILog.Error(System.Object,System.Exception)">
  14357. <summary>
  14358. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  14359. the stack trace of the <see cref="T:System.Exception"/> passed
  14360. as a parameter.
  14361. </summary>
  14362. <param name="message">The message object to log.</param>
  14363. <param name="exception">The exception to log, including its stack trace.</param>
  14364. <remarks>
  14365. <para>
  14366. See the <see cref="M:Error(object)"/> form for more detailed information.
  14367. </para>
  14368. </remarks>
  14369. <seealso cref="M:Error(object)"/>
  14370. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14371. </member>
  14372. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object[])">
  14373. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  14374. <summary>
  14375. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14376. </summary>
  14377. <param name="format">A String containing zero or more format items</param>
  14378. <param name="args">An Object array containing zero or more objects to format</param>
  14379. <remarks>
  14380. <para>
  14381. The message is formatted using the <c>String.Format</c> method. See
  14382. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14383. of the formatting.
  14384. </para>
  14385. <para>
  14386. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14387. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14388. methods instead.
  14389. </para>
  14390. </remarks>
  14391. <seealso cref="M:Error(object,Exception)"/>
  14392. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14393. </member>
  14394. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object)">
  14395. <summary>
  14396. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14397. </summary>
  14398. <param name="format">A String containing zero or more format items</param>
  14399. <param name="arg0">An Object to format</param>
  14400. <remarks>
  14401. <para>
  14402. The message is formatted using the <c>String.Format</c> method. See
  14403. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14404. of the formatting.
  14405. </para>
  14406. <para>
  14407. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14408. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  14409. methods instead.
  14410. </para>
  14411. </remarks>
  14412. <seealso cref="M:Error(object)"/>
  14413. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14414. </member>
  14415. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object)">
  14416. <summary>
  14417. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14418. </summary>
  14419. <param name="format">A String containing zero or more format items</param>
  14420. <param name="arg0">An Object to format</param>
  14421. <param name="arg1">An Object to format</param>
  14422. <remarks>
  14423. <para>
  14424. The message is formatted using the <c>String.Format</c> method. See
  14425. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14426. of the formatting.
  14427. </para>
  14428. <para>
  14429. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14430. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  14431. methods instead.
  14432. </para>
  14433. </remarks>
  14434. <seealso cref="M:Error(object)"/>
  14435. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14436. </member>
  14437. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  14438. <summary>
  14439. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14440. </summary>
  14441. <param name="format">A String containing zero or more format items</param>
  14442. <param name="arg0">An Object to format</param>
  14443. <param name="arg1">An Object to format</param>
  14444. <param name="arg2">An Object to format</param>
  14445. <remarks>
  14446. <para>
  14447. The message is formatted using the <c>String.Format</c> method. See
  14448. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14449. of the formatting.
  14450. </para>
  14451. <para>
  14452. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14453. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  14454. methods instead.
  14455. </para>
  14456. </remarks>
  14457. <seealso cref="M:Error(object)"/>
  14458. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14459. </member>
  14460. <member name="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  14461. <summary>
  14462. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14463. </summary>
  14464. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14465. <param name="format">A String containing zero or more format items</param>
  14466. <param name="args">An Object array containing zero or more objects to format</param>
  14467. <remarks>
  14468. <para>
  14469. The message is formatted using the <c>String.Format</c> method. See
  14470. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14471. of the formatting.
  14472. </para>
  14473. <para>
  14474. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14475. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14476. methods instead.
  14477. </para>
  14478. </remarks>
  14479. <seealso cref="M:Error(object,Exception)"/>
  14480. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14481. </member>
  14482. <member name="M:log4net.ILog.Fatal(System.Object)">
  14483. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  14484. <summary>
  14485. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14486. </summary>
  14487. <remarks>
  14488. <para>
  14489. This method first checks if this logger is <c>FATAL</c>
  14490. enabled by comparing the level of this logger with the
  14491. <see cref="F:log4net.Core.Level.Fatal"/> level. If this logger is
  14492. <c>FATAL</c> enabled, then it converts the message object
  14493. (passed as parameter) to a string by invoking the appropriate
  14494. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14495. proceeds to call all the registered appenders in this logger
  14496. and also higher in the hierarchy depending on the value of the
  14497. additivity flag.
  14498. </para>
  14499. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14500. to this method will print the name of the <see cref="T:System.Exception"/>
  14501. but no stack trace. To print a stack trace use the
  14502. <see cref="M:Fatal(object,Exception)"/> form instead.
  14503. </para>
  14504. </remarks>
  14505. <param name="message">The message object to log.</param>
  14506. <seealso cref="M:Fatal(object,Exception)"/>
  14507. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14508. </member>
  14509. <member name="M:log4net.ILog.Fatal(System.Object,System.Exception)">
  14510. <summary>
  14511. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  14512. the stack trace of the <see cref="T:System.Exception"/> passed
  14513. as a parameter.
  14514. </summary>
  14515. <param name="message">The message object to log.</param>
  14516. <param name="exception">The exception to log, including its stack trace.</param>
  14517. <remarks>
  14518. <para>
  14519. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  14520. </para>
  14521. </remarks>
  14522. <seealso cref="M:Fatal(object)"/>
  14523. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14524. </member>
  14525. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object[])">
  14526. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  14527. <summary>
  14528. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14529. </summary>
  14530. <param name="format">A String containing zero or more format items</param>
  14531. <param name="args">An Object array containing zero or more objects to format</param>
  14532. <remarks>
  14533. <para>
  14534. The message is formatted using the <c>String.Format</c> method. See
  14535. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14536. of the formatting.
  14537. </para>
  14538. <para>
  14539. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14540. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14541. methods instead.
  14542. </para>
  14543. </remarks>
  14544. <seealso cref="M:Fatal(object,Exception)"/>
  14545. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14546. </member>
  14547. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object)">
  14548. <summary>
  14549. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14550. </summary>
  14551. <param name="format">A String containing zero or more format items</param>
  14552. <param name="arg0">An Object to format</param>
  14553. <remarks>
  14554. <para>
  14555. The message is formatted using the <c>String.Format</c> method. See
  14556. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14557. of the formatting.
  14558. </para>
  14559. <para>
  14560. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14561. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  14562. methods instead.
  14563. </para>
  14564. </remarks>
  14565. <seealso cref="M:Fatal(object)"/>
  14566. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14567. </member>
  14568. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object)">
  14569. <summary>
  14570. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14571. </summary>
  14572. <param name="format">A String containing zero or more format items</param>
  14573. <param name="arg0">An Object to format</param>
  14574. <param name="arg1">An Object to format</param>
  14575. <remarks>
  14576. <para>
  14577. The message is formatted using the <c>String.Format</c> method. See
  14578. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14579. of the formatting.
  14580. </para>
  14581. <para>
  14582. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14583. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  14584. methods instead.
  14585. </para>
  14586. </remarks>
  14587. <seealso cref="M:Fatal(object)"/>
  14588. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14589. </member>
  14590. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  14591. <summary>
  14592. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14593. </summary>
  14594. <param name="format">A String containing zero or more format items</param>
  14595. <param name="arg0">An Object to format</param>
  14596. <param name="arg1">An Object to format</param>
  14597. <param name="arg2">An Object to format</param>
  14598. <remarks>
  14599. <para>
  14600. The message is formatted using the <c>String.Format</c> method. See
  14601. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14602. of the formatting.
  14603. </para>
  14604. <para>
  14605. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14606. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  14607. methods instead.
  14608. </para>
  14609. </remarks>
  14610. <seealso cref="M:Fatal(object)"/>
  14611. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14612. </member>
  14613. <member name="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  14614. <summary>
  14615. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14616. </summary>
  14617. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14618. <param name="format">A String containing zero or more format items</param>
  14619. <param name="args">An Object array containing zero or more objects to format</param>
  14620. <remarks>
  14621. <para>
  14622. The message is formatted using the <c>String.Format</c> method. See
  14623. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14624. of the formatting.
  14625. </para>
  14626. <para>
  14627. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14628. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14629. methods instead.
  14630. </para>
  14631. </remarks>
  14632. <seealso cref="M:Fatal(object,Exception)"/>
  14633. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14634. </member>
  14635. <member name="P:log4net.ILog.IsDebugEnabled">
  14636. <summary>
  14637. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Debug"/> level.
  14638. </summary>
  14639. <value>
  14640. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Debug"/> events, <c>false</c> otherwise.
  14641. </value>
  14642. <remarks>
  14643. <para>
  14644. This function is intended to lessen the computational cost of
  14645. disabled log debug statements.
  14646. </para>
  14647. <para> For some ILog interface <c>log</c>, when you write:</para>
  14648. <code lang="C#">
  14649. log.Debug("This is entry number: " + i );
  14650. </code>
  14651. <para>
  14652. You incur the cost constructing the message, string construction and concatenation in
  14653. this case, regardless of whether the message is logged or not.
  14654. </para>
  14655. <para>
  14656. If you are worried about speed (who isn't), then you should write:
  14657. </para>
  14658. <code lang="C#">
  14659. if (log.IsDebugEnabled)
  14660. {
  14661. log.Debug("This is entry number: " + i );
  14662. }
  14663. </code>
  14664. <para>
  14665. This way you will not incur the cost of parameter
  14666. construction if debugging is disabled for <c>log</c>. On
  14667. the other hand, if the <c>log</c> is debug enabled, you
  14668. will incur the cost of evaluating whether the logger is debug
  14669. enabled twice. Once in <see cref="P:log4net.ILog.IsDebugEnabled"/> and once in
  14670. the <see cref="M:Debug(object)"/>. This is an insignificant overhead
  14671. since evaluating a logger takes about 1% of the time it
  14672. takes to actually log. This is the preferred style of logging.
  14673. </para>
  14674. <para>Alternatively if your logger is available statically then the is debug
  14675. enabled state can be stored in a static variable like this:
  14676. </para>
  14677. <code lang="C#">
  14678. private static readonly bool isDebugEnabled = log.IsDebugEnabled;
  14679. </code>
  14680. <para>
  14681. Then when you come to log you can write:
  14682. </para>
  14683. <code lang="C#">
  14684. if (isDebugEnabled)
  14685. {
  14686. log.Debug("This is entry number: " + i );
  14687. }
  14688. </code>
  14689. <para>
  14690. This way the debug enabled state is only queried once
  14691. when the class is loaded. Using a <c>private static readonly</c>
  14692. variable is the most efficient because it is a run time constant
  14693. and can be heavily optimized by the JIT compiler.
  14694. </para>
  14695. <para>
  14696. Of course if you use a static readonly variable to
  14697. hold the enabled state of the logger then you cannot
  14698. change the enabled state at runtime to vary the logging
  14699. that is produced. You have to decide if you need absolute
  14700. speed or runtime flexibility.
  14701. </para>
  14702. </remarks>
  14703. <seealso cref="M:Debug(object)"/>
  14704. <seealso cref="M:DebugFormat(IFormatProvider, string, object[])"/>
  14705. </member>
  14706. <member name="P:log4net.ILog.IsInfoEnabled">
  14707. <summary>
  14708. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Info"/> level.
  14709. </summary>
  14710. <value>
  14711. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Info"/> events, <c>false</c> otherwise.
  14712. </value>
  14713. <remarks>
  14714. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14715. </remarks>
  14716. <seealso cref="M:Info(object)"/>
  14717. <seealso cref="M:InfoFormat(IFormatProvider, string, object[])"/>
  14718. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14719. </member>
  14720. <member name="P:log4net.ILog.IsWarnEnabled">
  14721. <summary>
  14722. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Warn"/> level.
  14723. </summary>
  14724. <value>
  14725. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Warn"/> events, <c>false</c> otherwise.
  14726. </value>
  14727. <remarks>
  14728. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14729. </remarks>
  14730. <seealso cref="M:Warn(object)"/>
  14731. <seealso cref="M:WarnFormat(IFormatProvider, string, object[])"/>
  14732. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14733. </member>
  14734. <member name="P:log4net.ILog.IsErrorEnabled">
  14735. <summary>
  14736. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Error"/> level.
  14737. </summary>
  14738. <value>
  14739. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Error"/> events, <c>false</c> otherwise.
  14740. </value>
  14741. <remarks>
  14742. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14743. </remarks>
  14744. <seealso cref="M:Error(object)"/>
  14745. <seealso cref="M:ErrorFormat(IFormatProvider, string, object[])"/>
  14746. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14747. </member>
  14748. <member name="P:log4net.ILog.IsFatalEnabled">
  14749. <summary>
  14750. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14751. </summary>
  14752. <value>
  14753. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Fatal"/> events, <c>false</c> otherwise.
  14754. </value>
  14755. <remarks>
  14756. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14757. </remarks>
  14758. <seealso cref="M:Fatal(object)"/>
  14759. <seealso cref="M:FatalFormat(IFormatProvider, string, object[])"/>
  14760. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14761. </member>
  14762. <member name="M:log4net.Core.LogImpl.#ctor(log4net.Core.ILogger)">
  14763. <summary>
  14764. Construct a new wrapper for the specified logger.
  14765. </summary>
  14766. <param name="logger">The logger to wrap.</param>
  14767. <remarks>
  14768. <para>
  14769. Construct a new wrapper for the specified logger.
  14770. </para>
  14771. </remarks>
  14772. </member>
  14773. <member name="M:log4net.Core.LogImpl.ReloadLevels(log4net.Repository.ILoggerRepository)">
  14774. <summary>
  14775. Virtual method called when the configuration of the repository changes
  14776. </summary>
  14777. <param name="repository">the repository holding the levels</param>
  14778. <remarks>
  14779. <para>
  14780. Virtual method called when the configuration of the repository changes
  14781. </para>
  14782. </remarks>
  14783. </member>
  14784. <member name="M:log4net.Core.LogImpl.Debug(System.Object)">
  14785. <summary>
  14786. Logs a message object with the <c>DEBUG</c> level.
  14787. </summary>
  14788. <param name="message">The message object to log.</param>
  14789. <remarks>
  14790. <para>
  14791. This method first checks if this logger is <c>DEBUG</c>
  14792. enabled by comparing the level of this logger with the
  14793. <c>DEBUG</c> level. If this logger is
  14794. <c>DEBUG</c> enabled, then it converts the message object
  14795. (passed as parameter) to a string by invoking the appropriate
  14796. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14797. proceeds to call all the registered appenders in this logger
  14798. and also higher in the hierarchy depending on the value of the
  14799. additivity flag.
  14800. </para>
  14801. <para>
  14802. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14803. to this method will print the name of the <see cref="T:System.Exception"/>
  14804. but no stack trace. To print a stack trace use the
  14805. <see cref="M:Debug(object,Exception)"/> form instead.
  14806. </para>
  14807. </remarks>
  14808. </member>
  14809. <member name="M:log4net.Core.LogImpl.Debug(System.Object,System.Exception)">
  14810. <summary>
  14811. Logs a message object with the <c>DEBUG</c> level
  14812. </summary>
  14813. <param name="message">The message object to log.</param>
  14814. <param name="exception">The exception to log, including its stack trace.</param>
  14815. <remarks>
  14816. <para>
  14817. Logs a message object with the <c>DEBUG</c> level including
  14818. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> passed
  14819. as a parameter.
  14820. </para>
  14821. <para>
  14822. See the <see cref="M:Debug(object)"/> form for more detailed information.
  14823. </para>
  14824. </remarks>
  14825. <seealso cref="M:Debug(object)"/>
  14826. </member>
  14827. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])">
  14828. <summary>
  14829. Logs a formatted message string with the <c>DEBUG</c> level.
  14830. </summary>
  14831. <param name="format">A String containing zero or more format items</param>
  14832. <param name="args">An Object array containing zero or more objects to format</param>
  14833. <remarks>
  14834. <para>
  14835. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14836. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14837. of the formatting.
  14838. </para>
  14839. <para>
  14840. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14841. format provider. To specify a localized provider use the
  14842. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14843. </para>
  14844. <para>
  14845. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14846. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14847. methods instead.
  14848. </para>
  14849. </remarks>
  14850. </member>
  14851. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)">
  14852. <summary>
  14853. Logs a formatted message string with the <c>DEBUG</c> level.
  14854. </summary>
  14855. <param name="format">A String containing zero or more format items</param>
  14856. <param name="arg0">An Object to format</param>
  14857. <remarks>
  14858. <para>
  14859. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14860. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14861. of the formatting.
  14862. </para>
  14863. <para>
  14864. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14865. format provider. To specify a localized provider use the
  14866. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14867. </para>
  14868. <para>
  14869. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14870. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14871. methods instead.
  14872. </para>
  14873. </remarks>
  14874. </member>
  14875. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)">
  14876. <summary>
  14877. Logs a formatted message string with the <c>DEBUG</c> level.
  14878. </summary>
  14879. <param name="format">A String containing zero or more format items</param>
  14880. <param name="arg0">An Object to format</param>
  14881. <param name="arg1">An Object to format</param>
  14882. <remarks>
  14883. <para>
  14884. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14885. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14886. of the formatting.
  14887. </para>
  14888. <para>
  14889. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14890. format provider. To specify a localized provider use the
  14891. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14892. </para>
  14893. <para>
  14894. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14895. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14896. methods instead.
  14897. </para>
  14898. </remarks>
  14899. </member>
  14900. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  14901. <summary>
  14902. Logs a formatted message string with the <c>DEBUG</c> level.
  14903. </summary>
  14904. <param name="format">A String containing zero or more format items</param>
  14905. <param name="arg0">An Object to format</param>
  14906. <param name="arg1">An Object to format</param>
  14907. <param name="arg2">An Object to format</param>
  14908. <remarks>
  14909. <para>
  14910. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14911. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14912. of the formatting.
  14913. </para>
  14914. <para>
  14915. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14916. format provider. To specify a localized provider use the
  14917. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14918. </para>
  14919. <para>
  14920. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14921. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14922. methods instead.
  14923. </para>
  14924. </remarks>
  14925. </member>
  14926. <member name="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  14927. <summary>
  14928. Logs a formatted message string with the <c>DEBUG</c> level.
  14929. </summary>
  14930. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14931. <param name="format">A String containing zero or more format items</param>
  14932. <param name="args">An Object array containing zero or more objects to format</param>
  14933. <remarks>
  14934. <para>
  14935. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14936. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14937. of the formatting.
  14938. </para>
  14939. <para>
  14940. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14941. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14942. methods instead.
  14943. </para>
  14944. </remarks>
  14945. </member>
  14946. <member name="M:log4net.Core.LogImpl.Info(System.Object)">
  14947. <summary>
  14948. Logs a message object with the <c>INFO</c> level.
  14949. </summary>
  14950. <param name="message">The message object to log.</param>
  14951. <remarks>
  14952. <para>
  14953. This method first checks if this logger is <c>INFO</c>
  14954. enabled by comparing the level of this logger with the
  14955. <c>INFO</c> level. If this logger is
  14956. <c>INFO</c> enabled, then it converts the message object
  14957. (passed as parameter) to a string by invoking the appropriate
  14958. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14959. proceeds to call all the registered appenders in this logger
  14960. and also higher in the hierarchy depending on the value of
  14961. the additivity flag.
  14962. </para>
  14963. <para>
  14964. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14965. to this method will print the name of the <see cref="T:System.Exception"/>
  14966. but no stack trace. To print a stack trace use the
  14967. <see cref="M:Info(object,Exception)"/> form instead.
  14968. </para>
  14969. </remarks>
  14970. </member>
  14971. <member name="M:log4net.Core.LogImpl.Info(System.Object,System.Exception)">
  14972. <summary>
  14973. Logs a message object with the <c>INFO</c> level.
  14974. </summary>
  14975. <param name="message">The message object to log.</param>
  14976. <param name="exception">The exception to log, including its stack trace.</param>
  14977. <remarks>
  14978. <para>
  14979. Logs a message object with the <c>INFO</c> level including
  14980. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  14981. passed as a parameter.
  14982. </para>
  14983. <para>
  14984. See the <see cref="M:Info(object)"/> form for more detailed information.
  14985. </para>
  14986. </remarks>
  14987. <seealso cref="M:Info(object)"/>
  14988. </member>
  14989. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object[])">
  14990. <summary>
  14991. Logs a formatted message string with the <c>INFO</c> level.
  14992. </summary>
  14993. <param name="format">A String containing zero or more format items</param>
  14994. <param name="args">An Object array containing zero or more objects to format</param>
  14995. <remarks>
  14996. <para>
  14997. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14998. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14999. of the formatting.
  15000. </para>
  15001. <para>
  15002. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15003. format provider. To specify a localized provider use the
  15004. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  15005. </para>
  15006. <para>
  15007. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15008. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  15009. methods instead.
  15010. </para>
  15011. </remarks>
  15012. </member>
  15013. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)">
  15014. <summary>
  15015. Logs a formatted message string with the <c>INFO</c> level.
  15016. </summary>
  15017. <param name="format">A String containing zero or more format items</param>
  15018. <param name="arg0">An Object to format</param>
  15019. <remarks>
  15020. <para>
  15021. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15022. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15023. of the formatting.
  15024. </para>
  15025. <para>
  15026. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15027. format provider. To specify a localized provider use the
  15028. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  15029. </para>
  15030. <para>
  15031. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15032. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  15033. methods instead.
  15034. </para>
  15035. </remarks>
  15036. </member>
  15037. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)">
  15038. <summary>
  15039. Logs a formatted message string with the <c>INFO</c> level.
  15040. </summary>
  15041. <param name="format">A String containing zero or more format items</param>
  15042. <param name="arg0">An Object to format</param>
  15043. <param name="arg1">An Object to format</param>
  15044. <remarks>
  15045. <para>
  15046. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15047. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15048. of the formatting.
  15049. </para>
  15050. <para>
  15051. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15052. format provider. To specify a localized provider use the
  15053. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  15054. </para>
  15055. <para>
  15056. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15057. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  15058. methods instead.
  15059. </para>
  15060. </remarks>
  15061. </member>
  15062. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  15063. <summary>
  15064. Logs a formatted message string with the <c>INFO</c> level.
  15065. </summary>
  15066. <param name="format">A String containing zero or more format items</param>
  15067. <param name="arg0">An Object to format</param>
  15068. <param name="arg1">An Object to format</param>
  15069. <param name="arg2">An Object to format</param>
  15070. <remarks>
  15071. <para>
  15072. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15073. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15074. of the formatting.
  15075. </para>
  15076. <para>
  15077. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15078. format provider. To specify a localized provider use the
  15079. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  15080. </para>
  15081. <para>
  15082. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15083. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  15084. methods instead.
  15085. </para>
  15086. </remarks>
  15087. </member>
  15088. <member name="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  15089. <summary>
  15090. Logs a formatted message string with the <c>INFO</c> level.
  15091. </summary>
  15092. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15093. <param name="format">A String containing zero or more format items</param>
  15094. <param name="args">An Object array containing zero or more objects to format</param>
  15095. <remarks>
  15096. <para>
  15097. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15098. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15099. of the formatting.
  15100. </para>
  15101. <para>
  15102. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15103. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  15104. methods instead.
  15105. </para>
  15106. </remarks>
  15107. </member>
  15108. <member name="M:log4net.Core.LogImpl.Warn(System.Object)">
  15109. <summary>
  15110. Logs a message object with the <c>WARN</c> level.
  15111. </summary>
  15112. <param name="message">the message object to log</param>
  15113. <remarks>
  15114. <para>
  15115. This method first checks if this logger is <c>WARN</c>
  15116. enabled by comparing the level of this logger with the
  15117. <c>WARN</c> level. If this logger is
  15118. <c>WARN</c> enabled, then it converts the message object
  15119. (passed as parameter) to a string by invoking the appropriate
  15120. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  15121. proceeds to call all the registered appenders in this logger and
  15122. also higher in the hierarchy depending on the value of the
  15123. additivity flag.
  15124. </para>
  15125. <para>
  15126. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  15127. method will print the name of the <see cref="T:System.Exception"/> but no
  15128. stack trace. To print a stack trace use the
  15129. <see cref="M:Warn(object,Exception)"/> form instead.
  15130. </para>
  15131. </remarks>
  15132. </member>
  15133. <member name="M:log4net.Core.LogImpl.Warn(System.Object,System.Exception)">
  15134. <summary>
  15135. Logs a message object with the <c>WARN</c> level
  15136. </summary>
  15137. <param name="message">The message object to log.</param>
  15138. <param name="exception">The exception to log, including its stack trace.</param>
  15139. <remarks>
  15140. <para>
  15141. Logs a message object with the <c>WARN</c> level including
  15142. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  15143. passed as a parameter.
  15144. </para>
  15145. <para>
  15146. See the <see cref="M:Warn(object)"/> form for more detailed information.
  15147. </para>
  15148. </remarks>
  15149. <seealso cref="M:Warn(object)"/>
  15150. </member>
  15151. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object[])">
  15152. <summary>
  15153. Logs a formatted message string with the <c>WARN</c> level.
  15154. </summary>
  15155. <param name="format">A String containing zero or more format items</param>
  15156. <param name="args">An Object array containing zero or more objects to format</param>
  15157. <remarks>
  15158. <para>
  15159. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15160. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15161. of the formatting.
  15162. </para>
  15163. <para>
  15164. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15165. format provider. To specify a localized provider use the
  15166. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  15167. </para>
  15168. <para>
  15169. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15170. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  15171. methods instead.
  15172. </para>
  15173. </remarks>
  15174. </member>
  15175. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)">
  15176. <summary>
  15177. Logs a formatted message string with the <c>WARN</c> level.
  15178. </summary>
  15179. <param name="format">A String containing zero or more format items</param>
  15180. <param name="arg0">An Object to format</param>
  15181. <remarks>
  15182. <para>
  15183. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15184. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15185. of the formatting.
  15186. </para>
  15187. <para>
  15188. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15189. format provider. To specify a localized provider use the
  15190. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  15191. </para>
  15192. <para>
  15193. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15194. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  15195. methods instead.
  15196. </para>
  15197. </remarks>
  15198. </member>
  15199. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)">
  15200. <summary>
  15201. Logs a formatted message string with the <c>WARN</c> level.
  15202. </summary>
  15203. <param name="format">A String containing zero or more format items</param>
  15204. <param name="arg0">An Object to format</param>
  15205. <param name="arg1">An Object to format</param>
  15206. <remarks>
  15207. <para>
  15208. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15209. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15210. of the formatting.
  15211. </para>
  15212. <para>
  15213. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15214. format provider. To specify a localized provider use the
  15215. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  15216. </para>
  15217. <para>
  15218. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15219. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  15220. methods instead.
  15221. </para>
  15222. </remarks>
  15223. </member>
  15224. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  15225. <summary>
  15226. Logs a formatted message string with the <c>WARN</c> level.
  15227. </summary>
  15228. <param name="format">A String containing zero or more format items</param>
  15229. <param name="arg0">An Object to format</param>
  15230. <param name="arg1">An Object to format</param>
  15231. <param name="arg2">An Object to format</param>
  15232. <remarks>
  15233. <para>
  15234. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15235. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15236. of the formatting.
  15237. </para>
  15238. <para>
  15239. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15240. format provider. To specify a localized provider use the
  15241. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  15242. </para>
  15243. <para>
  15244. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15245. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  15246. methods instead.
  15247. </para>
  15248. </remarks>
  15249. </member>
  15250. <member name="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  15251. <summary>
  15252. Logs a formatted message string with the <c>WARN</c> level.
  15253. </summary>
  15254. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15255. <param name="format">A String containing zero or more format items</param>
  15256. <param name="args">An Object array containing zero or more objects to format</param>
  15257. <remarks>
  15258. <para>
  15259. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15260. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15261. of the formatting.
  15262. </para>
  15263. <para>
  15264. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15265. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  15266. methods instead.
  15267. </para>
  15268. </remarks>
  15269. </member>
  15270. <member name="M:log4net.Core.LogImpl.Error(System.Object)">
  15271. <summary>
  15272. Logs a message object with the <c>ERROR</c> level.
  15273. </summary>
  15274. <param name="message">The message object to log.</param>
  15275. <remarks>
  15276. <para>
  15277. This method first checks if this logger is <c>ERROR</c>
  15278. enabled by comparing the level of this logger with the
  15279. <c>ERROR</c> level. If this logger is
  15280. <c>ERROR</c> enabled, then it converts the message object
  15281. (passed as parameter) to a string by invoking the appropriate
  15282. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  15283. proceeds to call all the registered appenders in this logger and
  15284. also higher in the hierarchy depending on the value of the
  15285. additivity flag.
  15286. </para>
  15287. <para>
  15288. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  15289. method will print the name of the <see cref="T:System.Exception"/> but no
  15290. stack trace. To print a stack trace use the
  15291. <see cref="M:Error(object,Exception)"/> form instead.
  15292. </para>
  15293. </remarks>
  15294. </member>
  15295. <member name="M:log4net.Core.LogImpl.Error(System.Object,System.Exception)">
  15296. <summary>
  15297. Logs a message object with the <c>ERROR</c> level
  15298. </summary>
  15299. <param name="message">The message object to log.</param>
  15300. <param name="exception">The exception to log, including its stack trace.</param>
  15301. <remarks>
  15302. <para>
  15303. Logs a message object with the <c>ERROR</c> level including
  15304. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  15305. passed as a parameter.
  15306. </para>
  15307. <para>
  15308. See the <see cref="M:Error(object)"/> form for more detailed information.
  15309. </para>
  15310. </remarks>
  15311. <seealso cref="M:Error(object)"/>
  15312. </member>
  15313. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object[])">
  15314. <summary>
  15315. Logs a formatted message string with the <c>ERROR</c> level.
  15316. </summary>
  15317. <param name="format">A String containing zero or more format items</param>
  15318. <param name="args">An Object array containing zero or more objects to format</param>
  15319. <remarks>
  15320. <para>
  15321. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15322. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15323. of the formatting.
  15324. </para>
  15325. <para>
  15326. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15327. format provider. To specify a localized provider use the
  15328. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  15329. </para>
  15330. <para>
  15331. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15332. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15333. methods instead.
  15334. </para>
  15335. </remarks>
  15336. </member>
  15337. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)">
  15338. <summary>
  15339. Logs a formatted message string with the <c>ERROR</c> level.
  15340. </summary>
  15341. <param name="format">A String containing zero or more format items</param>
  15342. <param name="arg0">An Object to format</param>
  15343. <remarks>
  15344. <para>
  15345. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15346. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15347. of the formatting.
  15348. </para>
  15349. <para>
  15350. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15351. format provider. To specify a localized provider use the
  15352. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  15353. </para>
  15354. <para>
  15355. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15356. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15357. methods instead.
  15358. </para>
  15359. </remarks>
  15360. </member>
  15361. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)">
  15362. <summary>
  15363. Logs a formatted message string with the <c>ERROR</c> level.
  15364. </summary>
  15365. <param name="format">A String containing zero or more format items</param>
  15366. <param name="arg0">An Object to format</param>
  15367. <param name="arg1">An Object to format</param>
  15368. <remarks>
  15369. <para>
  15370. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15371. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15372. of the formatting.
  15373. </para>
  15374. <para>
  15375. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15376. format provider. To specify a localized provider use the
  15377. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  15378. </para>
  15379. <para>
  15380. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15381. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15382. methods instead.
  15383. </para>
  15384. </remarks>
  15385. </member>
  15386. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  15387. <summary>
  15388. Logs a formatted message string with the <c>ERROR</c> level.
  15389. </summary>
  15390. <param name="format">A String containing zero or more format items</param>
  15391. <param name="arg0">An Object to format</param>
  15392. <param name="arg1">An Object to format</param>
  15393. <param name="arg2">An Object to format</param>
  15394. <remarks>
  15395. <para>
  15396. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15397. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15398. of the formatting.
  15399. </para>
  15400. <para>
  15401. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15402. format provider. To specify a localized provider use the
  15403. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  15404. </para>
  15405. <para>
  15406. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15407. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15408. methods instead.
  15409. </para>
  15410. </remarks>
  15411. </member>
  15412. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  15413. <summary>
  15414. Logs a formatted message string with the <c>ERROR</c> level.
  15415. </summary>
  15416. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15417. <param name="format">A String containing zero or more format items</param>
  15418. <param name="args">An Object array containing zero or more objects to format</param>
  15419. <remarks>
  15420. <para>
  15421. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15422. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15423. of the formatting.
  15424. </para>
  15425. <para>
  15426. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15427. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15428. methods instead.
  15429. </para>
  15430. </remarks>
  15431. </member>
  15432. <member name="M:log4net.Core.LogImpl.Fatal(System.Object)">
  15433. <summary>
  15434. Logs a message object with the <c>FATAL</c> level.
  15435. </summary>
  15436. <param name="message">The message object to log.</param>
  15437. <remarks>
  15438. <para>
  15439. This method first checks if this logger is <c>FATAL</c>
  15440. enabled by comparing the level of this logger with the
  15441. <c>FATAL</c> level. If this logger is
  15442. <c>FATAL</c> enabled, then it converts the message object
  15443. (passed as parameter) to a string by invoking the appropriate
  15444. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  15445. proceeds to call all the registered appenders in this logger and
  15446. also higher in the hierarchy depending on the value of the
  15447. additivity flag.
  15448. </para>
  15449. <para>
  15450. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  15451. method will print the name of the <see cref="T:System.Exception"/> but no
  15452. stack trace. To print a stack trace use the
  15453. <see cref="M:Fatal(object,Exception)"/> form instead.
  15454. </para>
  15455. </remarks>
  15456. </member>
  15457. <member name="M:log4net.Core.LogImpl.Fatal(System.Object,System.Exception)">
  15458. <summary>
  15459. Logs a message object with the <c>FATAL</c> level
  15460. </summary>
  15461. <param name="message">The message object to log.</param>
  15462. <param name="exception">The exception to log, including its stack trace.</param>
  15463. <remarks>
  15464. <para>
  15465. Logs a message object with the <c>FATAL</c> level including
  15466. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  15467. passed as a parameter.
  15468. </para>
  15469. <para>
  15470. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  15471. </para>
  15472. </remarks>
  15473. <seealso cref="M:Fatal(object)"/>
  15474. </member>
  15475. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])">
  15476. <summary>
  15477. Logs a formatted message string with the <c>FATAL</c> level.
  15478. </summary>
  15479. <param name="format">A String containing zero or more format items</param>
  15480. <param name="args">An Object array containing zero or more objects to format</param>
  15481. <remarks>
  15482. <para>
  15483. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15484. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15485. of the formatting.
  15486. </para>
  15487. <para>
  15488. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15489. format provider. To specify a localized provider use the
  15490. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15491. </para>
  15492. <para>
  15493. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15494. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15495. methods instead.
  15496. </para>
  15497. </remarks>
  15498. </member>
  15499. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)">
  15500. <summary>
  15501. Logs a formatted message string with the <c>FATAL</c> level.
  15502. </summary>
  15503. <param name="format">A String containing zero or more format items</param>
  15504. <param name="arg0">An Object to format</param>
  15505. <remarks>
  15506. <para>
  15507. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15508. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15509. of the formatting.
  15510. </para>
  15511. <para>
  15512. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15513. format provider. To specify a localized provider use the
  15514. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15515. </para>
  15516. <para>
  15517. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15518. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15519. methods instead.
  15520. </para>
  15521. </remarks>
  15522. </member>
  15523. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)">
  15524. <summary>
  15525. Logs a formatted message string with the <c>FATAL</c> level.
  15526. </summary>
  15527. <param name="format">A String containing zero or more format items</param>
  15528. <param name="arg0">An Object to format</param>
  15529. <param name="arg1">An Object to format</param>
  15530. <remarks>
  15531. <para>
  15532. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15533. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15534. of the formatting.
  15535. </para>
  15536. <para>
  15537. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15538. format provider. To specify a localized provider use the
  15539. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15540. </para>
  15541. <para>
  15542. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15543. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15544. methods instead.
  15545. </para>
  15546. </remarks>
  15547. </member>
  15548. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  15549. <summary>
  15550. Logs a formatted message string with the <c>FATAL</c> level.
  15551. </summary>
  15552. <param name="format">A String containing zero or more format items</param>
  15553. <param name="arg0">An Object to format</param>
  15554. <param name="arg1">An Object to format</param>
  15555. <param name="arg2">An Object to format</param>
  15556. <remarks>
  15557. <para>
  15558. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15559. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15560. of the formatting.
  15561. </para>
  15562. <para>
  15563. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15564. format provider. To specify a localized provider use the
  15565. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15566. </para>
  15567. <para>
  15568. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15569. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15570. methods instead.
  15571. </para>
  15572. </remarks>
  15573. </member>
  15574. <member name="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  15575. <summary>
  15576. Logs a formatted message string with the <c>FATAL</c> level.
  15577. </summary>
  15578. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15579. <param name="format">A String containing zero or more format items</param>
  15580. <param name="args">An Object array containing zero or more objects to format</param>
  15581. <remarks>
  15582. <para>
  15583. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15584. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15585. of the formatting.
  15586. </para>
  15587. <para>
  15588. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15589. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15590. methods instead.
  15591. </para>
  15592. </remarks>
  15593. </member>
  15594. <member name="M:log4net.Core.LogImpl.LoggerRepositoryConfigurationChanged(System.Object,System.EventArgs)">
  15595. <summary>
  15596. Event handler for the <see cref="E:log4net.Repository.ILoggerRepository.ConfigurationChanged"/> event
  15597. </summary>
  15598. <param name="sender">the repository</param>
  15599. <param name="e">Empty</param>
  15600. </member>
  15601. <member name="F:log4net.Core.LogImpl.ThisDeclaringType">
  15602. <summary>
  15603. The fully qualified name of this declaring type not the type of any subclass.
  15604. </summary>
  15605. </member>
  15606. <member name="P:log4net.Core.LogImpl.IsDebugEnabled">
  15607. <summary>
  15608. Checks if this logger is enabled for the <c>DEBUG</c>
  15609. level.
  15610. </summary>
  15611. <value>
  15612. <c>true</c> if this logger is enabled for <c>DEBUG</c> events,
  15613. <c>false</c> otherwise.
  15614. </value>
  15615. <remarks>
  15616. <para>
  15617. This function is intended to lessen the computational cost of
  15618. disabled log debug statements.
  15619. </para>
  15620. <para>
  15621. For some <c>log</c> Logger object, when you write:
  15622. </para>
  15623. <code lang="C#">
  15624. log.Debug("This is entry number: " + i );
  15625. </code>
  15626. <para>
  15627. You incur the cost constructing the message, concatenation in
  15628. this case, regardless of whether the message is logged or not.
  15629. </para>
  15630. <para>
  15631. If you are worried about speed, then you should write:
  15632. </para>
  15633. <code lang="C#">
  15634. if (log.IsDebugEnabled())
  15635. {
  15636. log.Debug("This is entry number: " + i );
  15637. }
  15638. </code>
  15639. <para>
  15640. This way you will not incur the cost of parameter
  15641. construction if debugging is disabled for <c>log</c>. On
  15642. the other hand, if the <c>log</c> is debug enabled, you
  15643. will incur the cost of evaluating whether the logger is debug
  15644. enabled twice. Once in <c>IsDebugEnabled</c> and once in
  15645. the <c>Debug</c>. This is an insignificant overhead
  15646. since evaluating a logger takes about 1% of the time it
  15647. takes to actually log.
  15648. </para>
  15649. </remarks>
  15650. </member>
  15651. <member name="P:log4net.Core.LogImpl.IsInfoEnabled">
  15652. <summary>
  15653. Checks if this logger is enabled for the <c>INFO</c> level.
  15654. </summary>
  15655. <value>
  15656. <c>true</c> if this logger is enabled for <c>INFO</c> events,
  15657. <c>false</c> otherwise.
  15658. </value>
  15659. <remarks>
  15660. <para>
  15661. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  15662. of using this method.
  15663. </para>
  15664. </remarks>
  15665. <seealso cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  15666. </member>
  15667. <member name="P:log4net.Core.LogImpl.IsWarnEnabled">
  15668. <summary>
  15669. Checks if this logger is enabled for the <c>WARN</c> level.
  15670. </summary>
  15671. <value>
  15672. <c>true</c> if this logger is enabled for <c>WARN</c> events,
  15673. <c>false</c> otherwise.
  15674. </value>
  15675. <remarks>
  15676. <para>
  15677. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  15678. of using this method.
  15679. </para>
  15680. </remarks>
  15681. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15682. </member>
  15683. <member name="P:log4net.Core.LogImpl.IsErrorEnabled">
  15684. <summary>
  15685. Checks if this logger is enabled for the <c>ERROR</c> level.
  15686. </summary>
  15687. <value>
  15688. <c>true</c> if this logger is enabled for <c>ERROR</c> events,
  15689. <c>false</c> otherwise.
  15690. </value>
  15691. <remarks>
  15692. <para>
  15693. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  15694. </para>
  15695. </remarks>
  15696. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15697. </member>
  15698. <member name="P:log4net.Core.LogImpl.IsFatalEnabled">
  15699. <summary>
  15700. Checks if this logger is enabled for the <c>FATAL</c> level.
  15701. </summary>
  15702. <value>
  15703. <c>true</c> if this logger is enabled for <c>FATAL</c> events,
  15704. <c>false</c> otherwise.
  15705. </value>
  15706. <remarks>
  15707. <para>
  15708. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  15709. </para>
  15710. </remarks>
  15711. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15712. </member>
  15713. <member name="T:log4net.Core.MethodItem">
  15714. <summary>
  15715. provides method information without actually referencing a System.Reflection.MethodBase
  15716. as that would require that the containing assembly is loaded.
  15717. </summary>
  15718. </member>
  15719. <member name="F:log4net.Core.MethodItem.NA">
  15720. <summary>
  15721. When location information is not available the constant
  15722. <c>NA</c> is returned. Current value of this string
  15723. constant is <b>?</b>.
  15724. </summary>
  15725. </member>
  15726. <member name="M:log4net.Core.MethodItem.#ctor">
  15727. <summary>
  15728. constructs a method item for an unknown method.
  15729. </summary>
  15730. </member>
  15731. <member name="M:log4net.Core.MethodItem.#ctor(System.String)">
  15732. <summary>
  15733. constructs a method item from the name of the method.
  15734. </summary>
  15735. <param name="name"></param>
  15736. </member>
  15737. <member name="M:log4net.Core.MethodItem.#ctor(System.String,System.String[])">
  15738. <summary>
  15739. constructs a method item from the name of the method and its parameters.
  15740. </summary>
  15741. <param name="name"></param>
  15742. <param name="parameters"></param>
  15743. </member>
  15744. <member name="M:log4net.Core.MethodItem.#ctor(System.Reflection.MethodBase)">
  15745. <summary>
  15746. constructs a method item from a method base by determining the method name and its parameters.
  15747. </summary>
  15748. <param name="methodBase"></param>
  15749. </member>
  15750. <member name="F:log4net.Core.MethodItem.declaringType">
  15751. <summary>
  15752. The fully qualified type of the StackFrameItem class.
  15753. </summary>
  15754. <remarks>
  15755. Used by the internal logger to record the Type of the
  15756. log message.
  15757. </remarks>
  15758. </member>
  15759. <member name="P:log4net.Core.MethodItem.Name">
  15760. <summary>
  15761. Gets the method name of the caller making the logging
  15762. request.
  15763. </summary>
  15764. <value>
  15765. The method name of the caller making the logging
  15766. request.
  15767. </value>
  15768. <remarks>
  15769. <para>
  15770. Gets the method name of the caller making the logging
  15771. request.
  15772. </para>
  15773. </remarks>
  15774. </member>
  15775. <member name="P:log4net.Core.MethodItem.Parameters">
  15776. <summary>
  15777. Gets the method parameters of the caller making
  15778. the logging request.
  15779. </summary>
  15780. <value>
  15781. The method parameters of the caller making
  15782. the logging request
  15783. </value>
  15784. <remarks>
  15785. <para>
  15786. Gets the method parameters of the caller making
  15787. the logging request.
  15788. </para>
  15789. </remarks>
  15790. </member>
  15791. <member name="T:log4net.Core.SecurityContext">
  15792. <summary>
  15793. A SecurityContext used by log4net when interacting with protected resources
  15794. </summary>
  15795. <remarks>
  15796. <para>
  15797. A SecurityContext used by log4net when interacting with protected resources
  15798. for example with operating system services. This can be used to impersonate
  15799. a principal that has been granted privileges on the system resources.
  15800. </para>
  15801. </remarks>
  15802. <author>Nicko Cadell</author>
  15803. </member>
  15804. <member name="M:log4net.Core.SecurityContext.Impersonate(System.Object)">
  15805. <summary>
  15806. Impersonate this SecurityContext
  15807. </summary>
  15808. <param name="state">State supplied by the caller</param>
  15809. <returns>An <see cref="T:System.IDisposable"/> instance that will
  15810. revoke the impersonation of this SecurityContext, or <c>null</c></returns>
  15811. <remarks>
  15812. <para>
  15813. Impersonate this security context. Further calls on the current
  15814. thread should now be made in the security context provided
  15815. by this object. When the <see cref="T:System.IDisposable"/> result
  15816. <see cref="M:System.IDisposable.Dispose"/> method is called the security
  15817. context of the thread should be reverted to the state it was in
  15818. before <see cref="M:log4net.Core.SecurityContext.Impersonate(System.Object)"/> was called.
  15819. </para>
  15820. </remarks>
  15821. </member>
  15822. <member name="T:log4net.Core.SecurityContextProvider">
  15823. <summary>
  15824. The <see cref="T:log4net.Core.SecurityContextProvider"/> providers default <see cref="T:log4net.Core.SecurityContext"/> instances.
  15825. </summary>
  15826. <remarks>
  15827. <para>
  15828. A configured component that interacts with potentially protected system
  15829. resources uses a <see cref="T:log4net.Core.SecurityContext"/> to provide the elevated
  15830. privileges required. If the <see cref="T:log4net.Core.SecurityContext"/> object has
  15831. been not been explicitly provided to the component then the component
  15832. will request one from this <see cref="T:log4net.Core.SecurityContextProvider"/>.
  15833. </para>
  15834. <para>
  15835. By default the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is
  15836. an instance of <see cref="T:log4net.Core.SecurityContextProvider"/> which returns only
  15837. <see cref="T:log4net.Util.NullSecurityContext"/> objects. This is a reasonable default
  15838. where the privileges required are not know by the system.
  15839. </para>
  15840. <para>
  15841. This default behavior can be overridden by subclassing the <see cref="T:log4net.Core.SecurityContextProvider"/>
  15842. and overriding the <see cref="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)"/> method to return
  15843. the desired <see cref="T:log4net.Core.SecurityContext"/> objects. The default provider
  15844. can be replaced by programmatically setting the value of the
  15845. <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> property.
  15846. </para>
  15847. <para>
  15848. An alternative is to use the <c>log4net.Config.SecurityContextProviderAttribute</c>
  15849. This attribute can be applied to an assembly in the same way as the
  15850. <c>log4net.Config.XmlConfiguratorAttribute"</c>. The attribute takes
  15851. the type to use as the <see cref="T:log4net.Core.SecurityContextProvider"/> as an argument.
  15852. </para>
  15853. </remarks>
  15854. <author>Nicko Cadell</author>
  15855. </member>
  15856. <member name="F:log4net.Core.SecurityContextProvider.s_defaultProvider">
  15857. <summary>
  15858. The default provider
  15859. </summary>
  15860. </member>
  15861. <member name="M:log4net.Core.SecurityContextProvider.#ctor">
  15862. <summary>
  15863. Protected default constructor to allow subclassing
  15864. </summary>
  15865. <remarks>
  15866. <para>
  15867. Protected default constructor to allow subclassing
  15868. </para>
  15869. </remarks>
  15870. </member>
  15871. <member name="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)">
  15872. <summary>
  15873. Create a SecurityContext for a consumer
  15874. </summary>
  15875. <param name="consumer">The consumer requesting the SecurityContext</param>
  15876. <returns>An impersonation context</returns>
  15877. <remarks>
  15878. <para>
  15879. The default implementation is to return a <see cref="T:log4net.Util.NullSecurityContext"/>.
  15880. </para>
  15881. <para>
  15882. Subclasses should override this method to provide their own
  15883. behavior.
  15884. </para>
  15885. </remarks>
  15886. </member>
  15887. <member name="P:log4net.Core.SecurityContextProvider.DefaultProvider">
  15888. <summary>
  15889. Gets or sets the default SecurityContextProvider
  15890. </summary>
  15891. <value>
  15892. The default SecurityContextProvider
  15893. </value>
  15894. <remarks>
  15895. <para>
  15896. The default provider is used by configured components that
  15897. require a <see cref="T:log4net.Core.SecurityContext"/> and have not had one
  15898. given to them.
  15899. </para>
  15900. <para>
  15901. By default this is an instance of <see cref="T:log4net.Core.SecurityContextProvider"/>
  15902. that returns <see cref="T:log4net.Util.NullSecurityContext"/> objects.
  15903. </para>
  15904. <para>
  15905. The default provider can be set programmatically by setting
  15906. the value of this property to a sub class of <see cref="T:log4net.Core.SecurityContextProvider"/>
  15907. that has the desired behavior.
  15908. </para>
  15909. </remarks>
  15910. </member>
  15911. <member name="T:log4net.Core.StackFrameItem">
  15912. <summary>
  15913. provides stack frame information without actually referencing a System.Diagnostics.StackFrame
  15914. as that would require that the containing assembly is loaded.
  15915. </summary>
  15916. </member>
  15917. <member name="F:log4net.Core.StackFrameItem.NA">
  15918. <summary>
  15919. When location information is not available the constant
  15920. <c>NA</c> is returned. Current value of this string
  15921. constant is <b>?</b>.
  15922. </summary>
  15923. </member>
  15924. <member name="M:log4net.Core.StackFrameItem.#ctor(System.Diagnostics.StackFrame)">
  15925. <summary>
  15926. returns a stack frame item from a stack frame. This
  15927. </summary>
  15928. <param name="frame"></param>
  15929. <returns></returns>
  15930. </member>
  15931. <member name="F:log4net.Core.StackFrameItem.declaringType">
  15932. <summary>
  15933. The fully qualified type of the StackFrameItem class.
  15934. </summary>
  15935. <remarks>
  15936. Used by the internal logger to record the Type of the
  15937. log message.
  15938. </remarks>
  15939. </member>
  15940. <member name="P:log4net.Core.StackFrameItem.ClassName">
  15941. <summary>
  15942. Gets the fully qualified class name of the caller making the logging
  15943. request.
  15944. </summary>
  15945. <value>
  15946. The fully qualified class name of the caller making the logging
  15947. request.
  15948. </value>
  15949. <remarks>
  15950. <para>
  15951. Gets the fully qualified class name of the caller making the logging
  15952. request.
  15953. </para>
  15954. </remarks>
  15955. </member>
  15956. <member name="P:log4net.Core.StackFrameItem.FileName">
  15957. <summary>
  15958. Gets the file name of the caller.
  15959. </summary>
  15960. <value>
  15961. The file name of the caller.
  15962. </value>
  15963. <remarks>
  15964. <para>
  15965. Gets the file name of the caller.
  15966. </para>
  15967. </remarks>
  15968. </member>
  15969. <member name="P:log4net.Core.StackFrameItem.LineNumber">
  15970. <summary>
  15971. Gets the line number of the caller.
  15972. </summary>
  15973. <value>
  15974. The line number of the caller.
  15975. </value>
  15976. <remarks>
  15977. <para>
  15978. Gets the line number of the caller.
  15979. </para>
  15980. </remarks>
  15981. </member>
  15982. <member name="P:log4net.Core.StackFrameItem.Method">
  15983. <summary>
  15984. Gets the method name of the caller.
  15985. </summary>
  15986. <value>
  15987. The method name of the caller.
  15988. </value>
  15989. <remarks>
  15990. <para>
  15991. Gets the method name of the caller.
  15992. </para>
  15993. </remarks>
  15994. </member>
  15995. <member name="P:log4net.Core.StackFrameItem.FullInfo">
  15996. <summary>
  15997. Gets all available caller information
  15998. </summary>
  15999. <value>
  16000. All available caller information, in the format
  16001. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  16002. </value>
  16003. <remarks>
  16004. <para>
  16005. Gets all available caller information, in the format
  16006. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  16007. </para>
  16008. </remarks>
  16009. </member>
  16010. <member name="T:log4net.Core.TimeEvaluator">
  16011. <summary>
  16012. An evaluator that triggers after specified number of seconds.
  16013. </summary>
  16014. <remarks>
  16015. <para>
  16016. This evaluator will trigger if the specified time period
  16017. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  16018. </para>
  16019. </remarks>
  16020. <author>Robert Sevcik</author>
  16021. </member>
  16022. <member name="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL">
  16023. <summary>
  16024. The default time threshold for triggering in seconds. Zero means it won't trigger at all.
  16025. </summary>
  16026. </member>
  16027. <member name="F:log4net.Core.TimeEvaluator.m_interval">
  16028. <summary>
  16029. The time threshold for triggering in seconds. Zero means it won't trigger at all.
  16030. </summary>
  16031. </member>
  16032. <member name="F:log4net.Core.TimeEvaluator.m_lastTimeUtc">
  16033. <summary>
  16034. The UTC time of last check. This gets updated when the object is created and when the evaluator triggers.
  16035. </summary>
  16036. </member>
  16037. <member name="M:log4net.Core.TimeEvaluator.#ctor">
  16038. <summary>
  16039. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  16040. </summary>
  16041. <remarks>
  16042. <para>
  16043. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  16044. </para>
  16045. <para>
  16046. This evaluator will trigger if the specified time period
  16047. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  16048. </para>
  16049. </remarks>
  16050. </member>
  16051. <member name="M:log4net.Core.TimeEvaluator.#ctor(System.Int32)">
  16052. <summary>
  16053. Create a new evaluator using the specified time threshold in seconds.
  16054. </summary>
  16055. <param name="interval">
  16056. The time threshold in seconds to trigger after.
  16057. Zero means it won't trigger at all.
  16058. </param>
  16059. <remarks>
  16060. <para>
  16061. Create a new evaluator using the specified time threshold in seconds.
  16062. </para>
  16063. <para>
  16064. This evaluator will trigger if the specified time period
  16065. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  16066. </para>
  16067. </remarks>
  16068. </member>
  16069. <member name="M:log4net.Core.TimeEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  16070. <summary>
  16071. Is this <paramref name="loggingEvent"/> the triggering event?
  16072. </summary>
  16073. <param name="loggingEvent">The event to check</param>
  16074. <returns>This method returns <c>true</c>, if the specified time period
  16075. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check..
  16076. Otherwise it returns <c>false</c></returns>
  16077. <remarks>
  16078. <para>
  16079. This evaluator will trigger if the specified time period
  16080. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  16081. </para>
  16082. </remarks>
  16083. </member>
  16084. <member name="P:log4net.Core.TimeEvaluator.Interval">
  16085. <summary>
  16086. The time threshold in seconds to trigger after
  16087. </summary>
  16088. <value>
  16089. The time threshold in seconds to trigger after.
  16090. Zero means it won't trigger at all.
  16091. </value>
  16092. <remarks>
  16093. <para>
  16094. This evaluator will trigger if the specified time period
  16095. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  16096. </para>
  16097. </remarks>
  16098. </member>
  16099. <member name="T:log4net.Core.WrapperCreationHandler">
  16100. <summary>
  16101. Delegate used to handle creation of new wrappers.
  16102. </summary>
  16103. <param name="logger">The logger to wrap in a wrapper.</param>
  16104. <remarks>
  16105. <para>
  16106. Delegate used to handle creation of new wrappers. This delegate
  16107. is called from the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  16108. method to construct the wrapper for the specified logger.
  16109. </para>
  16110. <para>
  16111. The delegate to use is supplied to the <see cref="T:log4net.Core.WrapperMap"/>
  16112. constructor.
  16113. </para>
  16114. </remarks>
  16115. </member>
  16116. <member name="T:log4net.Core.WrapperMap">
  16117. <summary>
  16118. Maps between logger objects and wrapper objects.
  16119. </summary>
  16120. <remarks>
  16121. <para>
  16122. This class maintains a mapping between <see cref="T:log4net.Core.ILogger"/> objects and
  16123. <see cref="T:log4net.Core.ILoggerWrapper"/> objects. Use the <see cref="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)"/> method to
  16124. lookup the <see cref="T:log4net.Core.ILoggerWrapper"/> for the specified <see cref="T:log4net.Core.ILogger"/>.
  16125. </para>
  16126. <para>
  16127. New wrapper instances are created by the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  16128. method. The default behavior is for this method to delegate construction
  16129. of the wrapper to the <see cref="T:log4net.Core.WrapperCreationHandler"/> delegate supplied
  16130. to the constructor. This allows specialization of the behavior without
  16131. requiring subclassing of this type.
  16132. </para>
  16133. </remarks>
  16134. <author>Nicko Cadell</author>
  16135. <author>Gert Driesen</author>
  16136. </member>
  16137. <member name="M:log4net.Core.WrapperMap.#ctor(log4net.Core.WrapperCreationHandler)">
  16138. <summary>
  16139. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/>
  16140. </summary>
  16141. <param name="createWrapperHandler">The handler to use to create the wrapper objects.</param>
  16142. <remarks>
  16143. <para>
  16144. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/> class with
  16145. the specified handler to create the wrapper objects.
  16146. </para>
  16147. </remarks>
  16148. </member>
  16149. <member name="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)">
  16150. <summary>
  16151. Gets the wrapper object for the specified logger.
  16152. </summary>
  16153. <returns>The wrapper object for the specified logger</returns>
  16154. <remarks>
  16155. <para>
  16156. If the logger is null then the corresponding wrapper is null.
  16157. </para>
  16158. <para>
  16159. Looks up the wrapper it it has previously been requested and
  16160. returns it. If the wrapper has never been requested before then
  16161. the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> virtual method is
  16162. called.
  16163. </para>
  16164. </remarks>
  16165. </member>
  16166. <member name="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)">
  16167. <summary>
  16168. Creates the wrapper object for the specified logger.
  16169. </summary>
  16170. <param name="logger">The logger to wrap in a wrapper.</param>
  16171. <returns>The wrapper object for the logger.</returns>
  16172. <remarks>
  16173. <para>
  16174. This implementation uses the <see cref="T:log4net.Core.WrapperCreationHandler"/>
  16175. passed to the constructor to create the wrapper. This method
  16176. can be overridden in a subclass.
  16177. </para>
  16178. </remarks>
  16179. </member>
  16180. <member name="M:log4net.Core.WrapperMap.RepositoryShutdown(log4net.Repository.ILoggerRepository)">
  16181. <summary>
  16182. Called when a monitored repository shutdown event is received.
  16183. </summary>
  16184. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down</param>
  16185. <remarks>
  16186. <para>
  16187. This method is called when a <see cref="T:log4net.Repository.ILoggerRepository"/> that this
  16188. <see cref="T:log4net.Core.WrapperMap"/> is holding loggers for has signaled its shutdown
  16189. event <see cref="E:log4net.Repository.ILoggerRepository.ShutdownEvent"/>. The default
  16190. behavior of this method is to release the references to the loggers
  16191. and their wrappers generated for this repository.
  16192. </para>
  16193. </remarks>
  16194. </member>
  16195. <member name="M:log4net.Core.WrapperMap.ILoggerRepository_Shutdown(System.Object,System.EventArgs)">
  16196. <summary>
  16197. Event handler for repository shutdown event.
  16198. </summary>
  16199. <param name="sender">The sender of the event.</param>
  16200. <param name="e">The event args.</param>
  16201. </member>
  16202. <member name="F:log4net.Core.WrapperMap.m_repositories">
  16203. <summary>
  16204. Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings
  16205. </summary>
  16206. </member>
  16207. <member name="F:log4net.Core.WrapperMap.m_createWrapperHandler">
  16208. <summary>
  16209. The handler to use to create the extension wrapper objects.
  16210. </summary>
  16211. </member>
  16212. <member name="F:log4net.Core.WrapperMap.m_shutdownHandler">
  16213. <summary>
  16214. Internal reference to the delegate used to register for repository shutdown events.
  16215. </summary>
  16216. </member>
  16217. <member name="P:log4net.Core.WrapperMap.Repositories">
  16218. <summary>
  16219. Gets the map of logger repositories.
  16220. </summary>
  16221. <value>
  16222. Map of logger repositories.
  16223. </value>
  16224. <remarks>
  16225. <para>
  16226. Gets the hashtable that is keyed on <see cref="T:log4net.Repository.ILoggerRepository"/>. The
  16227. values are hashtables keyed on <see cref="T:log4net.Core.ILogger"/> with the
  16228. value being the corresponding <see cref="T:log4net.Core.ILoggerWrapper"/>.
  16229. </para>
  16230. </remarks>
  16231. </member>
  16232. <member name="T:log4net.DateFormatter.AbsoluteTimeDateFormatter">
  16233. <summary>
  16234. Formats a <see cref="T:System.DateTime"/> as <c>"HH:mm:ss,fff"</c>.
  16235. </summary>
  16236. <remarks>
  16237. <para>
  16238. Formats a <see cref="T:System.DateTime"/> in the format <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  16239. </para>
  16240. </remarks>
  16241. <author>Nicko Cadell</author>
  16242. <author>Gert Driesen</author>
  16243. </member>
  16244. <member name="T:log4net.DateFormatter.IDateFormatter">
  16245. <summary>
  16246. Render a <see cref="T:System.DateTime"/> as a string.
  16247. </summary>
  16248. <remarks>
  16249. <para>
  16250. Interface to abstract the rendering of a <see cref="T:System.DateTime"/>
  16251. instance into a string.
  16252. </para>
  16253. <para>
  16254. The <see cref="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/> method is used to render the
  16255. date to a text writer.
  16256. </para>
  16257. </remarks>
  16258. <author>Nicko Cadell</author>
  16259. <author>Gert Driesen</author>
  16260. </member>
  16261. <member name="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  16262. <summary>
  16263. Formats the specified date as a string.
  16264. </summary>
  16265. <param name="dateToFormat">The date to format.</param>
  16266. <param name="writer">The writer to write to.</param>
  16267. <remarks>
  16268. <para>
  16269. Format the <see cref="T:System.DateTime"/> as a string and write it
  16270. to the <see cref="T:System.IO.TextWriter"/> provided.
  16271. </para>
  16272. </remarks>
  16273. </member>
  16274. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.AbsoluteTimeDateFormat">
  16275. <summary>
  16276. String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is <b>ABSOLUTE</b>.
  16277. </summary>
  16278. </member>
  16279. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.DateAndTimeDateFormat">
  16280. <summary>
  16281. String constant used to specify DateTimeDateFormat in layouts. Current value is <b>DATE</b>.
  16282. </summary>
  16283. </member>
  16284. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.Iso8601TimeDateFormat">
  16285. <summary>
  16286. String constant used to specify ISO8601DateFormat in layouts. Current value is <b>ISO8601</b>.
  16287. </summary>
  16288. </member>
  16289. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  16290. <summary>
  16291. Renders the date into a string. Format is <c>"HH:mm:ss"</c>.
  16292. </summary>
  16293. <param name="dateToFormat">The date to render into a string.</param>
  16294. <param name="buffer">The string builder to write to.</param>
  16295. <remarks>
  16296. <para>
  16297. Subclasses should override this method to render the date
  16298. into a string using a precision up to the second. This method
  16299. will be called at most once per second and the result will be
  16300. reused if it is needed again during the same second.
  16301. </para>
  16302. </remarks>
  16303. </member>
  16304. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  16305. <summary>
  16306. Renders the date into a string. Format is "HH:mm:ss,fff".
  16307. </summary>
  16308. <param name="dateToFormat">The date to render into a string.</param>
  16309. <param name="writer">The writer to write to.</param>
  16310. <remarks>
  16311. <para>
  16312. Uses the <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> method to generate the
  16313. time string up to the seconds and then appends the current
  16314. milliseconds. The results from <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> are
  16315. cached and <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> is called at most once
  16316. per second.
  16317. </para>
  16318. <para>
  16319. Sub classes should override <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/>
  16320. rather than <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/>.
  16321. </para>
  16322. </remarks>
  16323. </member>
  16324. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeToTheSecond">
  16325. <summary>
  16326. Last stored time with precision up to the second.
  16327. </summary>
  16328. </member>
  16329. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeBuf">
  16330. <summary>
  16331. Last stored time with precision up to the second, formatted
  16332. as a string.
  16333. </summary>
  16334. </member>
  16335. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeStrings">
  16336. <summary>
  16337. Last stored time with precision up to the second, formatted
  16338. as a string.
  16339. </summary>
  16340. </member>
  16341. <member name="T:log4net.DateFormatter.DateTimeDateFormatter">
  16342. <summary>
  16343. Formats a <see cref="T:System.DateTime"/> as <c>"dd MMM yyyy HH:mm:ss,fff"</c>
  16344. </summary>
  16345. <remarks>
  16346. <para>
  16347. Formats a <see cref="T:System.DateTime"/> in the format
  16348. <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example,
  16349. <c>"06 Nov 1994 15:49:37,459"</c>.
  16350. </para>
  16351. </remarks>
  16352. <author>Nicko Cadell</author>
  16353. <author>Gert Driesen</author>
  16354. <author>Angelika Schnagl</author>
  16355. </member>
  16356. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.#ctor">
  16357. <summary>
  16358. Default constructor.
  16359. </summary>
  16360. <remarks>
  16361. <para>
  16362. Initializes a new instance of the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> class.
  16363. </para>
  16364. </remarks>
  16365. </member>
  16366. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  16367. <summary>
  16368. Formats the date without the milliseconds part
  16369. </summary>
  16370. <param name="dateToFormat">The date to format.</param>
  16371. <param name="buffer">The string builder to write to.</param>
  16372. <remarks>
  16373. <para>
  16374. Formats a DateTime in the format <c>"dd MMM yyyy HH:mm:ss"</c>
  16375. for example, <c>"06 Nov 1994 15:49:37"</c>.
  16376. </para>
  16377. <para>
  16378. The base class will append the <c>",fff"</c> milliseconds section.
  16379. This method will only be called at most once per second.
  16380. </para>
  16381. </remarks>
  16382. </member>
  16383. <member name="F:log4net.DateFormatter.DateTimeDateFormatter.m_dateTimeFormatInfo">
  16384. <summary>
  16385. The format info for the invariant culture.
  16386. </summary>
  16387. </member>
  16388. <member name="T:log4net.DateFormatter.Iso8601DateFormatter">
  16389. <summary>
  16390. Formats the <see cref="T:System.DateTime"/> as <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  16391. </summary>
  16392. <remarks>
  16393. <para>
  16394. Formats the <see cref="T:System.DateTime"/> specified as a string: <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  16395. </para>
  16396. </remarks>
  16397. <author>Nicko Cadell</author>
  16398. <author>Gert Driesen</author>
  16399. </member>
  16400. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.#ctor">
  16401. <summary>
  16402. Default constructor
  16403. </summary>
  16404. <remarks>
  16405. <para>
  16406. Initializes a new instance of the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> class.
  16407. </para>
  16408. </remarks>
  16409. </member>
  16410. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  16411. <summary>
  16412. Formats the date without the milliseconds part
  16413. </summary>
  16414. <param name="dateToFormat">The date to format.</param>
  16415. <param name="buffer">The string builder to write to.</param>
  16416. <remarks>
  16417. <para>
  16418. Formats the date specified as a string: <c>"yyyy-MM-dd HH:mm:ss"</c>.
  16419. </para>
  16420. <para>
  16421. The base class will append the <c>",fff"</c> milliseconds section.
  16422. This method will only be called at most once per second.
  16423. </para>
  16424. </remarks>
  16425. </member>
  16426. <member name="T:log4net.DateFormatter.SimpleDateFormatter">
  16427. <summary>
  16428. Formats the <see cref="T:System.DateTime"/> using the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  16429. </summary>
  16430. <remarks>
  16431. <para>
  16432. Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  16433. </para>
  16434. </remarks>
  16435. <author>Nicko Cadell</author>
  16436. <author>Gert Driesen</author>
  16437. </member>
  16438. <member name="M:log4net.DateFormatter.SimpleDateFormatter.#ctor(System.String)">
  16439. <summary>
  16440. Constructor
  16441. </summary>
  16442. <param name="format">The format string.</param>
  16443. <remarks>
  16444. <para>
  16445. Initializes a new instance of the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> class
  16446. with the specified format string.
  16447. </para>
  16448. <para>
  16449. The format string must be compatible with the options
  16450. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  16451. </para>
  16452. </remarks>
  16453. </member>
  16454. <member name="M:log4net.DateFormatter.SimpleDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  16455. <summary>
  16456. Formats the date using <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  16457. </summary>
  16458. <param name="dateToFormat">The date to convert to a string.</param>
  16459. <param name="writer">The writer to write to.</param>
  16460. <remarks>
  16461. <para>
  16462. Uses the date format string supplied to the constructor to call
  16463. the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method to format the date.
  16464. </para>
  16465. </remarks>
  16466. </member>
  16467. <member name="F:log4net.DateFormatter.SimpleDateFormatter.m_formatString">
  16468. <summary>
  16469. The format string used to format the <see cref="T:System.DateTime"/>.
  16470. </summary>
  16471. <remarks>
  16472. <para>
  16473. The format string must be compatible with the options
  16474. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  16475. </para>
  16476. </remarks>
  16477. </member>
  16478. <member name="T:log4net.Filter.DenyAllFilter">
  16479. <summary>
  16480. This filter drops all <see cref="T:log4net.Core.LoggingEvent"/>.
  16481. </summary>
  16482. <remarks>
  16483. <para>
  16484. You can add this filter to the end of a filter chain to
  16485. switch from the default "accept all unless instructed otherwise"
  16486. filtering behavior to a "deny all unless instructed otherwise"
  16487. behavior.
  16488. </para>
  16489. </remarks>
  16490. <author>Nicko Cadell</author>
  16491. <author>Gert Driesen</author>
  16492. </member>
  16493. <member name="T:log4net.Filter.FilterSkeleton">
  16494. <summary>
  16495. Subclass this type to implement customized logging event filtering
  16496. </summary>
  16497. <remarks>
  16498. <para>
  16499. Users should extend this class to implement customized logging
  16500. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  16501. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  16502. appenders, have built-in filtering rules. It is suggested that you
  16503. first use and understand the built-in rules before rushing to write
  16504. your own custom filters.
  16505. </para>
  16506. <para>
  16507. This abstract class assumes and also imposes that filters be
  16508. organized in a linear chain. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/>
  16509. method of each filter is called sequentially, in the order of their
  16510. addition to the chain.
  16511. </para>
  16512. <para>
  16513. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/> method must return one
  16514. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  16515. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  16516. </para>
  16517. <para>
  16518. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  16519. immediately without consulting with the remaining filters.
  16520. </para>
  16521. <para>
  16522. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  16523. in the chain is consulted. If there are no more filters in the
  16524. chain, then the log event is logged. Thus, in the presence of no
  16525. filters, the default behavior is to log all logging events.
  16526. </para>
  16527. <para>
  16528. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  16529. event is logged without consulting the remaining filters.
  16530. </para>
  16531. <para>
  16532. The philosophy of log4net filters is largely inspired from the
  16533. Linux ipchains.
  16534. </para>
  16535. </remarks>
  16536. <author>Nicko Cadell</author>
  16537. <author>Gert Driesen</author>
  16538. </member>
  16539. <member name="T:log4net.Filter.IFilter">
  16540. <summary>
  16541. Implement this interface to provide customized logging event filtering
  16542. </summary>
  16543. <remarks>
  16544. <para>
  16545. Users should implement this interface to implement customized logging
  16546. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  16547. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  16548. appenders, have built-in filtering rules. It is suggested that you
  16549. first use and understand the built-in rules before rushing to write
  16550. your own custom filters.
  16551. </para>
  16552. <para>
  16553. This abstract class assumes and also imposes that filters be
  16554. organized in a linear chain. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  16555. method of each filter is called sequentially, in the order of their
  16556. addition to the chain.
  16557. </para>
  16558. <para>
  16559. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> method must return one
  16560. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  16561. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  16562. </para>
  16563. <para>
  16564. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  16565. immediately without consulting with the remaining filters.
  16566. </para>
  16567. <para>
  16568. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  16569. in the chain is consulted. If there are no more filters in the
  16570. chain, then the log event is logged. Thus, in the presence of no
  16571. filters, the default behavior is to log all logging events.
  16572. </para>
  16573. <para>
  16574. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  16575. event is logged without consulting the remaining filters.
  16576. </para>
  16577. <para>
  16578. The philosophy of log4net filters is largely inspired from the
  16579. Linux ipchains.
  16580. </para>
  16581. </remarks>
  16582. <author>Nicko Cadell</author>
  16583. <author>Gert Driesen</author>
  16584. </member>
  16585. <member name="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)">
  16586. <summary>
  16587. Decide if the logging event should be logged through an appender.
  16588. </summary>
  16589. <param name="loggingEvent">The LoggingEvent to decide upon</param>
  16590. <returns>The decision of the filter</returns>
  16591. <remarks>
  16592. <para>
  16593. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  16594. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  16595. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  16596. the event will be logged without consulting with other filters in
  16597. the chain.
  16598. </para>
  16599. </remarks>
  16600. </member>
  16601. <member name="P:log4net.Filter.IFilter.Next">
  16602. <summary>
  16603. Property to get and set the next filter
  16604. </summary>
  16605. <value>
  16606. The next filter in the chain
  16607. </value>
  16608. <remarks>
  16609. <para>
  16610. Filters are typically composed into chains. This property allows the next filter in
  16611. the chain to be accessed.
  16612. </para>
  16613. </remarks>
  16614. </member>
  16615. <member name="F:log4net.Filter.FilterSkeleton.m_next">
  16616. <summary>
  16617. Points to the next filter in the filter chain.
  16618. </summary>
  16619. <remarks>
  16620. <para>
  16621. See <see cref="P:log4net.Filter.FilterSkeleton.Next"/> for more information.
  16622. </para>
  16623. </remarks>
  16624. </member>
  16625. <member name="M:log4net.Filter.FilterSkeleton.ActivateOptions">
  16626. <summary>
  16627. Initialize the filter with the options set
  16628. </summary>
  16629. <remarks>
  16630. <para>
  16631. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  16632. activation scheme. The <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> method must
  16633. be called on this object after the configuration properties have
  16634. been set. Until <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> is called this
  16635. object is in an undefined state and must not be used.
  16636. </para>
  16637. <para>
  16638. If any of the configuration properties are modified then
  16639. <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> must be called again.
  16640. </para>
  16641. <para>
  16642. Typically filter's options become active immediately on set,
  16643. however this method must still be called.
  16644. </para>
  16645. </remarks>
  16646. </member>
  16647. <member name="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)">
  16648. <summary>
  16649. Decide if the <see cref="T:log4net.Core.LoggingEvent"/> should be logged through an appender.
  16650. </summary>
  16651. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> to decide upon</param>
  16652. <returns>The decision of the filter</returns>
  16653. <remarks>
  16654. <para>
  16655. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  16656. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  16657. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  16658. the event will be logged without consulting with other filters in
  16659. the chain.
  16660. </para>
  16661. <para>
  16662. This method is marked <c>abstract</c> and must be implemented
  16663. in a subclass.
  16664. </para>
  16665. </remarks>
  16666. </member>
  16667. <member name="P:log4net.Filter.FilterSkeleton.Next">
  16668. <summary>
  16669. Property to get and set the next filter
  16670. </summary>
  16671. <value>
  16672. The next filter in the chain
  16673. </value>
  16674. <remarks>
  16675. <para>
  16676. Filters are typically composed into chains. This property allows the next filter in
  16677. the chain to be accessed.
  16678. </para>
  16679. </remarks>
  16680. </member>
  16681. <member name="M:log4net.Filter.DenyAllFilter.#ctor">
  16682. <summary>
  16683. Default constructor
  16684. </summary>
  16685. </member>
  16686. <member name="M:log4net.Filter.DenyAllFilter.Decide(log4net.Core.LoggingEvent)">
  16687. <summary>
  16688. Always returns the integer constant <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  16689. </summary>
  16690. <param name="loggingEvent">the LoggingEvent to filter</param>
  16691. <returns>Always returns <see cref="F:log4net.Filter.FilterDecision.Deny"/></returns>
  16692. <remarks>
  16693. <para>
  16694. Ignores the event being logged and just returns
  16695. <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This can be used to change the default filter
  16696. chain behavior from <see cref="F:log4net.Filter.FilterDecision.Accept"/> to <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This filter
  16697. should only be used as the last filter in the chain
  16698. as any further filters will be ignored!
  16699. </para>
  16700. </remarks>
  16701. </member>
  16702. <member name="T:log4net.Filter.FilterDecision">
  16703. <summary>
  16704. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  16705. </summary>
  16706. <remarks>
  16707. <para>
  16708. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  16709. </para>
  16710. </remarks>
  16711. </member>
  16712. <member name="F:log4net.Filter.FilterDecision.Deny">
  16713. <summary>
  16714. The log event must be dropped immediately without
  16715. consulting with the remaining filters, if any, in the chain.
  16716. </summary>
  16717. </member>
  16718. <member name="F:log4net.Filter.FilterDecision.Neutral">
  16719. <summary>
  16720. This filter is neutral with respect to the log event.
  16721. The remaining filters, if any, should be consulted for a final decision.
  16722. </summary>
  16723. </member>
  16724. <member name="F:log4net.Filter.FilterDecision.Accept">
  16725. <summary>
  16726. The log event must be logged immediately without
  16727. consulting with the remaining filters, if any, in the chain.
  16728. </summary>
  16729. </member>
  16730. <member name="T:log4net.Filter.LevelMatchFilter">
  16731. <summary>
  16732. This is a very simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  16733. </summary>
  16734. <remarks>
  16735. <para>
  16736. The filter admits two options <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> and
  16737. <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If there is an exact match between the value
  16738. of the <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> option and the <see cref="T:log4net.Core.Level"/> of the
  16739. <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
  16740. case the <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> option value is set
  16741. to <c>true</c>, if it is <c>false</c> then
  16742. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If the <see cref="T:log4net.Core.Level"/> does not match then
  16743. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  16744. </para>
  16745. </remarks>
  16746. <author>Nicko Cadell</author>
  16747. <author>Gert Driesen</author>
  16748. </member>
  16749. <member name="F:log4net.Filter.LevelMatchFilter.m_acceptOnMatch">
  16750. <summary>
  16751. flag to indicate if the filter should <see cref="F:log4net.Filter.FilterDecision.Accept"/> on a match
  16752. </summary>
  16753. </member>
  16754. <member name="F:log4net.Filter.LevelMatchFilter.m_levelToMatch">
  16755. <summary>
  16756. the <see cref="T:log4net.Core.Level"/> to match against
  16757. </summary>
  16758. </member>
  16759. <member name="M:log4net.Filter.LevelMatchFilter.#ctor">
  16760. <summary>
  16761. Default constructor
  16762. </summary>
  16763. </member>
  16764. <member name="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)">
  16765. <summary>
  16766. Tests if the <see cref="T:log4net.Core.Level"/> of the logging event matches that of the filter
  16767. </summary>
  16768. <param name="loggingEvent">the event to filter</param>
  16769. <returns>see remarks</returns>
  16770. <remarks>
  16771. <para>
  16772. If the <see cref="T:log4net.Core.Level"/> of the event matches the level of the
  16773. filter then the result of the function depends on the
  16774. value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If it is true then
  16775. the function will return <see cref="F:log4net.Filter.FilterDecision.Accept"/>, it it is false then it
  16776. will return <see cref="F:log4net.Filter.FilterDecision.Deny"/>. If the <see cref="T:log4net.Core.Level"/> does not match then
  16777. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  16778. </para>
  16779. </remarks>
  16780. </member>
  16781. <member name="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch">
  16782. <summary>
  16783. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/>
  16784. </summary>
  16785. <remarks>
  16786. <para>
  16787. The <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> property is a flag that determines
  16788. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16789. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16790. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  16791. </para>
  16792. <para>
  16793. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16794. </para>
  16795. </remarks>
  16796. </member>
  16797. <member name="P:log4net.Filter.LevelMatchFilter.LevelToMatch">
  16798. <summary>
  16799. The <see cref="T:log4net.Core.Level"/> that the filter will match
  16800. </summary>
  16801. <remarks>
  16802. <para>
  16803. The level that this filter will attempt to match against the
  16804. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  16805. the result depends on the value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>.
  16806. </para>
  16807. </remarks>
  16808. </member>
  16809. <member name="T:log4net.Filter.LevelRangeFilter">
  16810. <summary>
  16811. This is a simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  16812. </summary>
  16813. <remarks>
  16814. <para>
  16815. The filter admits three options <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  16816. that determine the range of priorities that are matched, and
  16817. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. If there is a match between the range
  16818. of priorities and the <see cref="T:log4net.Core.Level"/> of the <see cref="T:log4net.Core.LoggingEvent"/>, then the
  16819. <see cref="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in case the <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>
  16820. option value is set to <c>true</c>, if it is <c>false</c>
  16821. then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If there is no match, <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16822. </para>
  16823. </remarks>
  16824. <author>Nicko Cadell</author>
  16825. <author>Gert Driesen</author>
  16826. </member>
  16827. <member name="F:log4net.Filter.LevelRangeFilter.m_acceptOnMatch">
  16828. <summary>
  16829. Flag to indicate the behavior when matching a <see cref="T:log4net.Core.Level"/>
  16830. </summary>
  16831. </member>
  16832. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMin">
  16833. <summary>
  16834. the minimum <see cref="T:log4net.Core.Level"/> value to match
  16835. </summary>
  16836. </member>
  16837. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMax">
  16838. <summary>
  16839. the maximum <see cref="T:log4net.Core.Level"/> value to match
  16840. </summary>
  16841. </member>
  16842. <member name="M:log4net.Filter.LevelRangeFilter.#ctor">
  16843. <summary>
  16844. Default constructor
  16845. </summary>
  16846. </member>
  16847. <member name="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)">
  16848. <summary>
  16849. Check if the event should be logged.
  16850. </summary>
  16851. <param name="loggingEvent">the logging event to check</param>
  16852. <returns>see remarks</returns>
  16853. <remarks>
  16854. <para>
  16855. If the <see cref="T:log4net.Core.Level"/> of the logging event is outside the range
  16856. matched by this filter then <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  16857. is returned. If the <see cref="T:log4net.Core.Level"/> is matched then the value of
  16858. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> is checked. If it is true then
  16859. <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, otherwise
  16860. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned.
  16861. </para>
  16862. </remarks>
  16863. </member>
  16864. <member name="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch">
  16865. <summary>
  16866. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  16867. </summary>
  16868. <remarks>
  16869. <para>
  16870. The <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> property is a flag that determines
  16871. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16872. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16873. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  16874. </para>
  16875. <para>
  16876. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16877. </para>
  16878. </remarks>
  16879. </member>
  16880. <member name="P:log4net.Filter.LevelRangeFilter.LevelMin">
  16881. <summary>
  16882. Set the minimum matched <see cref="T:log4net.Core.Level"/>
  16883. </summary>
  16884. <remarks>
  16885. <para>
  16886. The minimum level that this filter will attempt to match against the
  16887. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  16888. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  16889. </para>
  16890. </remarks>
  16891. </member>
  16892. <member name="P:log4net.Filter.LevelRangeFilter.LevelMax">
  16893. <summary>
  16894. Sets the maximum matched <see cref="T:log4net.Core.Level"/>
  16895. </summary>
  16896. <remarks>
  16897. <para>
  16898. The maximum level that this filter will attempt to match against the
  16899. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  16900. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  16901. </para>
  16902. </remarks>
  16903. </member>
  16904. <member name="T:log4net.Filter.LoggerMatchFilter">
  16905. <summary>
  16906. Simple filter to match a string in the event's logger name.
  16907. </summary>
  16908. <remarks>
  16909. <para>
  16910. The works very similar to the <see cref="T:log4net.Filter.LevelMatchFilter"/>. It admits two
  16911. options <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> and <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>. If the
  16912. <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <see cref="T:log4net.Core.LoggingEvent"/> starts
  16913. with the value of the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> option, then the
  16914. <see cref="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
  16915. case the <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> option value is set to <c>true</c>,
  16916. if it is <c>false</c> then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16917. </para>
  16918. </remarks>
  16919. <author>Daniel Cazzulino</author>
  16920. </member>
  16921. <member name="F:log4net.Filter.LoggerMatchFilter.m_acceptOnMatch">
  16922. <summary>
  16923. Flag to indicate the behavior when we have a match
  16924. </summary>
  16925. </member>
  16926. <member name="F:log4net.Filter.LoggerMatchFilter.m_loggerToMatch">
  16927. <summary>
  16928. The logger name string to substring match against the event
  16929. </summary>
  16930. </member>
  16931. <member name="M:log4net.Filter.LoggerMatchFilter.#ctor">
  16932. <summary>
  16933. Default constructor
  16934. </summary>
  16935. </member>
  16936. <member name="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)">
  16937. <summary>
  16938. Check if this filter should allow the event to be logged
  16939. </summary>
  16940. <param name="loggingEvent">the event being logged</param>
  16941. <returns>see remarks</returns>
  16942. <remarks>
  16943. <para>
  16944. The rendered message is matched against the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>.
  16945. If the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> equals the beginning of
  16946. the incoming <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> (<see cref="M:String.StartsWith(string)"/>)
  16947. then a match will have occurred. If no match occurs
  16948. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  16949. allowing other filters to check the event. If a match occurs then
  16950. the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> is checked. If it is
  16951. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  16952. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16953. </para>
  16954. </remarks>
  16955. </member>
  16956. <member name="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch">
  16957. <summary>
  16958. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>
  16959. </summary>
  16960. <remarks>
  16961. <para>
  16962. The <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> property is a flag that determines
  16963. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16964. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16965. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  16966. </para>
  16967. <para>
  16968. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16969. </para>
  16970. </remarks>
  16971. </member>
  16972. <member name="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch">
  16973. <summary>
  16974. The <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> that the filter will match
  16975. </summary>
  16976. <remarks>
  16977. <para>
  16978. This filter will attempt to match this value against logger name in
  16979. the following way. The match will be done against the beginning of the
  16980. logger name (using <see cref="M:String.StartsWith(string)"/>). The match is
  16981. case sensitive. If a match is found then
  16982. the result depends on the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>.
  16983. </para>
  16984. </remarks>
  16985. </member>
  16986. <member name="T:log4net.Filter.MdcFilter">
  16987. <summary>
  16988. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  16989. </summary>
  16990. <remarks>
  16991. <para>
  16992. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  16993. </para>
  16994. <para>
  16995. As the MDC has been replaced with layered properties the
  16996. <see cref="T:log4net.Filter.PropertyFilter"/> should be used instead.
  16997. </para>
  16998. </remarks>
  16999. <author>Nicko Cadell</author>
  17000. <author>Gert Driesen</author>
  17001. </member>
  17002. <member name="T:log4net.Filter.PropertyFilter">
  17003. <summary>
  17004. Simple filter to match a string an event property
  17005. </summary>
  17006. <remarks>
  17007. <para>
  17008. Simple filter to match a string in the value for a
  17009. specific event property
  17010. </para>
  17011. </remarks>
  17012. <author>Nicko Cadell</author>
  17013. </member>
  17014. <member name="T:log4net.Filter.StringMatchFilter">
  17015. <summary>
  17016. Simple filter to match a string in the rendered message
  17017. </summary>
  17018. <remarks>
  17019. <para>
  17020. Simple filter to match a string in the rendered message
  17021. </para>
  17022. </remarks>
  17023. <author>Nicko Cadell</author>
  17024. <author>Gert Driesen</author>
  17025. </member>
  17026. <member name="F:log4net.Filter.StringMatchFilter.m_acceptOnMatch">
  17027. <summary>
  17028. Flag to indicate the behavior when we have a match
  17029. </summary>
  17030. </member>
  17031. <member name="F:log4net.Filter.StringMatchFilter.m_stringToMatch">
  17032. <summary>
  17033. The string to substring match against the message
  17034. </summary>
  17035. </member>
  17036. <member name="F:log4net.Filter.StringMatchFilter.m_stringRegexToMatch">
  17037. <summary>
  17038. A string regex to match
  17039. </summary>
  17040. </member>
  17041. <member name="F:log4net.Filter.StringMatchFilter.m_regexToMatch">
  17042. <summary>
  17043. A regex object to match (generated from m_stringRegexToMatch)
  17044. </summary>
  17045. </member>
  17046. <member name="M:log4net.Filter.StringMatchFilter.#ctor">
  17047. <summary>
  17048. Default constructor
  17049. </summary>
  17050. </member>
  17051. <member name="M:log4net.Filter.StringMatchFilter.ActivateOptions">
  17052. <summary>
  17053. Initialize and precompile the Regex if required
  17054. </summary>
  17055. <remarks>
  17056. <para>
  17057. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17058. activation scheme. The <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> method must
  17059. be called on this object after the configuration properties have
  17060. been set. Until <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> is called this
  17061. object is in an undefined state and must not be used.
  17062. </para>
  17063. <para>
  17064. If any of the configuration properties are modified then
  17065. <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> must be called again.
  17066. </para>
  17067. </remarks>
  17068. </member>
  17069. <member name="M:log4net.Filter.StringMatchFilter.Decide(log4net.Core.LoggingEvent)">
  17070. <summary>
  17071. Check if this filter should allow the event to be logged
  17072. </summary>
  17073. <param name="loggingEvent">the event being logged</param>
  17074. <returns>see remarks</returns>
  17075. <remarks>
  17076. <para>
  17077. The rendered message is matched against the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  17078. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  17079. the message then a match will have occurred. If no match occurs
  17080. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  17081. allowing other filters to check the event. If a match occurs then
  17082. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  17083. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  17084. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  17085. </para>
  17086. </remarks>
  17087. </member>
  17088. <member name="P:log4net.Filter.StringMatchFilter.AcceptOnMatch">
  17089. <summary>
  17090. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  17091. </summary>
  17092. <remarks>
  17093. <para>
  17094. The <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> property is a flag that determines
  17095. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  17096. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  17097. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  17098. </para>
  17099. <para>
  17100. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  17101. </para>
  17102. </remarks>
  17103. </member>
  17104. <member name="P:log4net.Filter.StringMatchFilter.StringToMatch">
  17105. <summary>
  17106. Sets the static string to match
  17107. </summary>
  17108. <remarks>
  17109. <para>
  17110. The string that will be substring matched against
  17111. the rendered message. If the message contains this
  17112. string then the filter will match. If a match is found then
  17113. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  17114. </para>
  17115. <para>
  17116. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  17117. must be specified.
  17118. </para>
  17119. </remarks>
  17120. </member>
  17121. <member name="P:log4net.Filter.StringMatchFilter.RegexToMatch">
  17122. <summary>
  17123. Sets the regular expression to match
  17124. </summary>
  17125. <remarks>
  17126. <para>
  17127. The regular expression pattern that will be matched against
  17128. the rendered message. If the message matches this
  17129. pattern then the filter will match. If a match is found then
  17130. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  17131. </para>
  17132. <para>
  17133. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  17134. must be specified.
  17135. </para>
  17136. </remarks>
  17137. </member>
  17138. <member name="F:log4net.Filter.PropertyFilter.m_key">
  17139. <summary>
  17140. The key to use to lookup the string from the event properties
  17141. </summary>
  17142. </member>
  17143. <member name="M:log4net.Filter.PropertyFilter.#ctor">
  17144. <summary>
  17145. Default constructor
  17146. </summary>
  17147. </member>
  17148. <member name="M:log4net.Filter.PropertyFilter.Decide(log4net.Core.LoggingEvent)">
  17149. <summary>
  17150. Check if this filter should allow the event to be logged
  17151. </summary>
  17152. <param name="loggingEvent">the event being logged</param>
  17153. <returns>see remarks</returns>
  17154. <remarks>
  17155. <para>
  17156. The event property for the <see cref="P:log4net.Filter.PropertyFilter.Key"/> is matched against
  17157. the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  17158. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  17159. the property value then a match will have occurred. If no match occurs
  17160. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  17161. allowing other filters to check the event. If a match occurs then
  17162. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  17163. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  17164. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  17165. </para>
  17166. </remarks>
  17167. </member>
  17168. <member name="P:log4net.Filter.PropertyFilter.Key">
  17169. <summary>
  17170. The key to lookup in the event properties and then match against.
  17171. </summary>
  17172. <remarks>
  17173. <para>
  17174. The key name to use to lookup in the properties map of the
  17175. <see cref="T:log4net.Core.LoggingEvent"/>. The match will be performed against
  17176. the value of this property if it exists.
  17177. </para>
  17178. </remarks>
  17179. </member>
  17180. <member name="T:log4net.Filter.NdcFilter">
  17181. <summary>
  17182. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  17183. </summary>
  17184. <remarks>
  17185. <para>
  17186. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  17187. </para>
  17188. <para>
  17189. As the MDC has been replaced with named stacks stored in the
  17190. properties collections the <see cref="T:log4net.Filter.PropertyFilter"/> should
  17191. be used instead.
  17192. </para>
  17193. </remarks>
  17194. <author>Nicko Cadell</author>
  17195. <author>Gert Driesen</author>
  17196. </member>
  17197. <member name="M:log4net.Filter.NdcFilter.#ctor">
  17198. <summary>
  17199. Default constructor
  17200. </summary>
  17201. <remarks>
  17202. <para>
  17203. Sets the <see cref="P:log4net.Filter.PropertyFilter.Key"/> to <c>"NDC"</c>.
  17204. </para>
  17205. </remarks>
  17206. </member>
  17207. <member name="T:log4net.Layout.Pattern.AppDomainPatternConverter">
  17208. <summary>
  17209. Write the event appdomain name to the output
  17210. </summary>
  17211. <remarks>
  17212. <para>
  17213. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output writer.
  17214. </para>
  17215. </remarks>
  17216. <author>Daniel Cazzulino</author>
  17217. <author>Nicko Cadell</author>
  17218. </member>
  17219. <member name="T:log4net.Layout.Pattern.PatternLayoutConverter">
  17220. <summary>
  17221. Abstract class that provides the formatting functionality that
  17222. derived classes need.
  17223. </summary>
  17224. <remarks>
  17225. Conversion specifiers in a conversion patterns are parsed to
  17226. individual PatternConverters. Each of which is responsible for
  17227. converting a logging event in a converter specific manner.
  17228. </remarks>
  17229. <author>Nicko Cadell</author>
  17230. </member>
  17231. <member name="T:log4net.Util.PatternConverter">
  17232. <summary>
  17233. Abstract class that provides the formatting functionality that
  17234. derived classes need.
  17235. </summary>
  17236. <remarks>
  17237. <para>
  17238. Conversion specifiers in a conversion patterns are parsed to
  17239. individual PatternConverters. Each of which is responsible for
  17240. converting a logging event in a converter specific manner.
  17241. </para>
  17242. </remarks>
  17243. <author>Nicko Cadell</author>
  17244. <author>Gert Driesen</author>
  17245. </member>
  17246. <member name="F:log4net.Util.PatternConverter.c_renderBufferSize">
  17247. <summary>
  17248. Initial buffer size
  17249. </summary>
  17250. </member>
  17251. <member name="F:log4net.Util.PatternConverter.c_renderBufferMaxCapacity">
  17252. <summary>
  17253. Maximum buffer size before it is recycled
  17254. </summary>
  17255. </member>
  17256. <member name="M:log4net.Util.PatternConverter.#ctor">
  17257. <summary>
  17258. Protected constructor
  17259. </summary>
  17260. <remarks>
  17261. <para>
  17262. Initializes a new instance of the <see cref="T:log4net.Util.PatternConverter"/> class.
  17263. </para>
  17264. </remarks>
  17265. </member>
  17266. <member name="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)">
  17267. <summary>
  17268. Evaluate this pattern converter and write the output to a writer.
  17269. </summary>
  17270. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17271. <param name="state">The state object on which the pattern converter should be executed.</param>
  17272. <remarks>
  17273. <para>
  17274. Derived pattern converters must override this method in order to
  17275. convert conversion specifiers in the appropriate way.
  17276. </para>
  17277. </remarks>
  17278. </member>
  17279. <member name="M:log4net.Util.PatternConverter.SetNext(log4net.Util.PatternConverter)">
  17280. <summary>
  17281. Set the next pattern converter in the chains
  17282. </summary>
  17283. <param name="patternConverter">the pattern converter that should follow this converter in the chain</param>
  17284. <returns>the next converter</returns>
  17285. <remarks>
  17286. <para>
  17287. The PatternConverter can merge with its neighbor during this method (or a sub class).
  17288. Therefore the return value may or may not be the value of the argument passed in.
  17289. </para>
  17290. </remarks>
  17291. </member>
  17292. <member name="M:log4net.Util.PatternConverter.Format(System.IO.TextWriter,System.Object)">
  17293. <summary>
  17294. Write the pattern converter to the writer with appropriate formatting
  17295. </summary>
  17296. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17297. <param name="state">The state object on which the pattern converter should be executed.</param>
  17298. <remarks>
  17299. <para>
  17300. This method calls <see cref="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)"/> to allow the subclass to perform
  17301. appropriate conversion of the pattern converter. If formatting options have
  17302. been specified via the <see cref="P:log4net.Util.PatternConverter.FormattingInfo"/> then this method will
  17303. apply those formattings before writing the output.
  17304. </para>
  17305. </remarks>
  17306. </member>
  17307. <member name="M:log4net.Util.PatternConverter.SpacePad(System.IO.TextWriter,System.Int32)">
  17308. <summary>
  17309. Fast space padding method.
  17310. </summary>
  17311. <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the spaces will be appended.</param>
  17312. <param name="length">The number of spaces to be padded.</param>
  17313. <remarks>
  17314. <para>
  17315. Fast space padding method.
  17316. </para>
  17317. </remarks>
  17318. </member>
  17319. <member name="F:log4net.Util.PatternConverter.m_option">
  17320. <summary>
  17321. The option string to the converter
  17322. </summary>
  17323. </member>
  17324. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionary)">
  17325. <summary>
  17326. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  17327. </summary>
  17328. <param name="writer">the writer to write to</param>
  17329. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  17330. <param name="value">the value to write to the writer</param>
  17331. <remarks>
  17332. <para>
  17333. Writes the <see cref="T:System.Collections.IDictionary"/> to a writer in the form:
  17334. </para>
  17335. <code>
  17336. {key1=value1, key2=value2, key3=value3}
  17337. </code>
  17338. <para>
  17339. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  17340. is not null then it is used to render the key and value to text, otherwise
  17341. the object's ToString method is called.
  17342. </para>
  17343. </remarks>
  17344. </member>
  17345. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionaryEnumerator)">
  17346. <summary>
  17347. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  17348. </summary>
  17349. <param name="writer">the writer to write to</param>
  17350. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  17351. <param name="value">the value to write to the writer</param>
  17352. <remarks>
  17353. <para>
  17354. Writes the <see cref="T:System.Collections.IDictionaryEnumerator"/> to a writer in the form:
  17355. </para>
  17356. <code>
  17357. {key1=value1, key2=value2, key3=value3}
  17358. </code>
  17359. <para>
  17360. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  17361. is not null then it is used to render the key and value to text, otherwise
  17362. the object's ToString method is called.
  17363. </para>
  17364. </remarks>
  17365. </member>
  17366. <member name="M:log4net.Util.PatternConverter.WriteObject(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Object)">
  17367. <summary>
  17368. Write an object to a <see cref="T:System.IO.TextWriter"/>
  17369. </summary>
  17370. <param name="writer">the writer to write to</param>
  17371. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  17372. <param name="value">the value to write to the writer</param>
  17373. <remarks>
  17374. <para>
  17375. Writes the Object to a writer. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  17376. is not null then it is used to render the object to text, otherwise
  17377. the object's ToString method is called.
  17378. </para>
  17379. </remarks>
  17380. </member>
  17381. <member name="P:log4net.Util.PatternConverter.Next">
  17382. <summary>
  17383. Get the next pattern converter in the chain
  17384. </summary>
  17385. <value>
  17386. the next pattern converter in the chain
  17387. </value>
  17388. <remarks>
  17389. <para>
  17390. Get the next pattern converter in the chain
  17391. </para>
  17392. </remarks>
  17393. </member>
  17394. <member name="P:log4net.Util.PatternConverter.FormattingInfo">
  17395. <summary>
  17396. Gets or sets the formatting info for this converter
  17397. </summary>
  17398. <value>
  17399. The formatting info for this converter
  17400. </value>
  17401. <remarks>
  17402. <para>
  17403. Gets or sets the formatting info for this converter
  17404. </para>
  17405. </remarks>
  17406. </member>
  17407. <member name="P:log4net.Util.PatternConverter.Option">
  17408. <summary>
  17409. Gets or sets the option value for this converter
  17410. </summary>
  17411. <summary>
  17412. The option for this converter
  17413. </summary>
  17414. <remarks>
  17415. <para>
  17416. Gets or sets the option value for this converter
  17417. </para>
  17418. </remarks>
  17419. </member>
  17420. <member name="P:log4net.Util.PatternConverter.Properties">
  17421. <summary>
  17422. </summary>
  17423. </member>
  17424. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.#ctor">
  17425. <summary>
  17426. Initializes a new instance of the <see cref="T:log4net.Layout.Pattern.PatternLayoutConverter"/> class.
  17427. </summary>
  17428. </member>
  17429. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17430. <summary>
  17431. Derived pattern converters must override this method in order to
  17432. convert conversion specifiers in the correct way.
  17433. </summary>
  17434. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17435. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17436. </member>
  17437. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,System.Object)">
  17438. <summary>
  17439. Derived pattern converters must override this method in order to
  17440. convert conversion specifiers in the correct way.
  17441. </summary>
  17442. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17443. <param name="state">The state object on which the pattern converter should be executed.</param>
  17444. </member>
  17445. <member name="F:log4net.Layout.Pattern.PatternLayoutConverter.m_ignoresException">
  17446. <summary>
  17447. Flag indicating if this converter handles exceptions
  17448. </summary>
  17449. <remarks>
  17450. <c>false</c> if this converter handles exceptions
  17451. </remarks>
  17452. </member>
  17453. <member name="P:log4net.Layout.Pattern.PatternLayoutConverter.IgnoresException">
  17454. <summary>
  17455. Flag indicating if this converter handles the logging event exception
  17456. </summary>
  17457. <value><c>false</c> if this converter handles the logging event exception</value>
  17458. <remarks>
  17459. <para>
  17460. If this converter handles the exception object contained within
  17461. <see cref="T:log4net.Core.LoggingEvent"/>, then this property should be set to
  17462. <c>false</c>. Otherwise, if the layout ignores the exception
  17463. object, then the property should be set to <c>true</c>.
  17464. </para>
  17465. <para>
  17466. Set this value to override a this default setting. The default
  17467. value is <c>true</c>, this converter does not handle the exception.
  17468. </para>
  17469. </remarks>
  17470. </member>
  17471. <member name="M:log4net.Layout.Pattern.AppDomainPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17472. <summary>
  17473. Write the event appdomain name to the output
  17474. </summary>
  17475. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17476. <param name="loggingEvent">the event being logged</param>
  17477. <remarks>
  17478. <para>
  17479. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output <paramref name="writer"/>.
  17480. </para>
  17481. </remarks>
  17482. </member>
  17483. <member name="T:log4net.Layout.Pattern.AspNetCachePatternConverter">
  17484. <summary>
  17485. Converter for items in the ASP.Net Cache.
  17486. </summary>
  17487. <remarks>
  17488. <para>
  17489. Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
  17490. </para>
  17491. </remarks>
  17492. <author>Ron Grabowski</author>
  17493. </member>
  17494. <member name="T:log4net.Layout.Pattern.AspNetPatternLayoutConverter">
  17495. <summary>
  17496. Abstract class that provides access to the current HttpContext (<see cref="P:System.Web.HttpContext.Current"/>) that
  17497. derived classes need.
  17498. </summary>
  17499. <remarks>
  17500. This class handles the case when HttpContext.Current is null by writing
  17501. <see cref="P:log4net.Util.SystemInfo.NotAvailableText"/> to the writer.
  17502. </remarks>
  17503. <author>Ron Grabowski</author>
  17504. </member>
  17505. <member name="M:log4net.Layout.Pattern.AspNetPatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
  17506. <summary>
  17507. Derived pattern converters must override this method in order to
  17508. convert conversion specifiers in the correct way.
  17509. </summary>
  17510. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17511. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17512. <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
  17513. </member>
  17514. <member name="M:log4net.Layout.Pattern.AspNetCachePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
  17515. <summary>
  17516. Write the ASP.Net Cache item to the output
  17517. </summary>
  17518. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17519. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17520. <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
  17521. <remarks>
  17522. <para>
  17523. Writes out the value of a named property. The property name
  17524. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17525. property. If no property has been set, all key value pairs from the Cache will
  17526. be written to the output.
  17527. </para>
  17528. </remarks>
  17529. </member>
  17530. <member name="T:log4net.Layout.Pattern.AspNetContextPatternConverter">
  17531. <summary>
  17532. Converter for items in the <see cref="T:System.Web.HttpContext"/>.
  17533. </summary>
  17534. <remarks>
  17535. <para>
  17536. Outputs an item from the <see cref="T:System.Web.HttpContext"/>.
  17537. </para>
  17538. </remarks>
  17539. <author>Ron Grabowski</author>
  17540. </member>
  17541. <member name="M:log4net.Layout.Pattern.AspNetContextPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
  17542. <summary>
  17543. Write the ASP.Net HttpContext item to the output
  17544. </summary>
  17545. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17546. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17547. <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
  17548. <remarks>
  17549. <para>
  17550. Writes out the value of a named property. The property name
  17551. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17552. property.
  17553. </para>
  17554. </remarks>
  17555. </member>
  17556. <member name="T:log4net.Layout.Pattern.AspNetRequestPatternConverter">
  17557. <summary>
  17558. Converter for items in the ASP.Net Cache.
  17559. </summary>
  17560. <remarks>
  17561. <para>
  17562. Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
  17563. </para>
  17564. </remarks>
  17565. <author>Ron Grabowski</author>
  17566. </member>
  17567. <member name="M:log4net.Layout.Pattern.AspNetRequestPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
  17568. <summary>
  17569. Write the ASP.Net Cache item to the output
  17570. </summary>
  17571. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17572. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17573. <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
  17574. <remarks>
  17575. <para>
  17576. Writes out the value of a named property. The property name
  17577. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17578. property.
  17579. </para>
  17580. </remarks>
  17581. </member>
  17582. <member name="T:log4net.Layout.Pattern.AspNetSessionPatternConverter">
  17583. <summary>
  17584. Converter for items in the ASP.Net Cache.
  17585. </summary>
  17586. <remarks>
  17587. <para>
  17588. Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
  17589. </para>
  17590. </remarks>
  17591. <author>Ron Grabowski</author>
  17592. </member>
  17593. <member name="M:log4net.Layout.Pattern.AspNetSessionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
  17594. <summary>
  17595. Write the ASP.Net Cache item to the output
  17596. </summary>
  17597. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17598. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17599. <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
  17600. <remarks>
  17601. <para>
  17602. Writes out the value of a named property. The property name
  17603. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17604. property. If no property has been set, all key value pairs from the Session will
  17605. be written to the output.
  17606. </para>
  17607. </remarks>
  17608. </member>
  17609. <member name="T:log4net.Layout.Pattern.DatePatternConverter">
  17610. <summary>
  17611. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  17612. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  17613. </summary>
  17614. <remarks>
  17615. <para>
  17616. Render the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the writer as a string.
  17617. </para>
  17618. <para>
  17619. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  17620. the formatting of the date. The following values are allowed:
  17621. <list type="definition">
  17622. <listheader>
  17623. <term>Option value</term>
  17624. <description>Output</description>
  17625. </listheader>
  17626. <item>
  17627. <term>ISO8601</term>
  17628. <description>
  17629. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  17630. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  17631. </description>
  17632. </item>
  17633. <item>
  17634. <term>DATE</term>
  17635. <description>
  17636. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  17637. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  17638. </description>
  17639. </item>
  17640. <item>
  17641. <term>ABSOLUTE</term>
  17642. <description>
  17643. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  17644. Formats using the <c>"HH:mm:ss,yyyy"</c> for example, <c>"15:49:37,459"</c>.
  17645. </description>
  17646. </item>
  17647. <item>
  17648. <term>other</term>
  17649. <description>
  17650. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  17651. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  17652. <see cref="M:DateTime.ToString(string)"/> method.
  17653. For details on valid patterns see
  17654. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  17655. </description>
  17656. </item>
  17657. </list>
  17658. </para>
  17659. <para>
  17660. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> is in the local time zone and is rendered in that zone.
  17661. To output the time in Universal time see <see cref="T:log4net.Layout.Pattern.UtcDatePatternConverter"/>.
  17662. </para>
  17663. </remarks>
  17664. <author>Nicko Cadell</author>
  17665. </member>
  17666. <member name="F:log4net.Layout.Pattern.DatePatternConverter.m_dateFormatter">
  17667. <summary>
  17668. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  17669. </summary>
  17670. <remarks>
  17671. <para>
  17672. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  17673. </para>
  17674. </remarks>
  17675. </member>
  17676. <member name="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions">
  17677. <summary>
  17678. Initialize the converter pattern based on the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  17679. </summary>
  17680. <remarks>
  17681. <para>
  17682. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17683. activation scheme. The <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> method must
  17684. be called on this object after the configuration properties have
  17685. been set. Until <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> is called this
  17686. object is in an undefined state and must not be used.
  17687. </para>
  17688. <para>
  17689. If any of the configuration properties are modified then
  17690. <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> must be called again.
  17691. </para>
  17692. </remarks>
  17693. </member>
  17694. <member name="M:log4net.Layout.Pattern.DatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17695. <summary>
  17696. Convert the pattern into the rendered message
  17697. </summary>
  17698. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17699. <param name="loggingEvent">the event being logged</param>
  17700. <remarks>
  17701. <para>
  17702. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  17703. for it to render it to the writer.
  17704. </para>
  17705. <para>
  17706. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone.
  17707. </para>
  17708. </remarks>
  17709. </member>
  17710. <member name="F:log4net.Layout.Pattern.DatePatternConverter.declaringType">
  17711. <summary>
  17712. The fully qualified type of the DatePatternConverter class.
  17713. </summary>
  17714. <remarks>
  17715. Used by the internal logger to record the Type of the
  17716. log message.
  17717. </remarks>
  17718. </member>
  17719. <member name="T:log4net.Layout.Pattern.ExceptionPatternConverter">
  17720. <summary>
  17721. Write the exception text to the output
  17722. </summary>
  17723. <remarks>
  17724. <para>
  17725. If an exception object is stored in the logging event
  17726. it will be rendered into the pattern output with a
  17727. trailing newline.
  17728. </para>
  17729. <para>
  17730. If there is no exception then nothing will be output
  17731. and no trailing newline will be appended.
  17732. It is typical to put a newline before the exception
  17733. and to have the exception as the last data in the pattern.
  17734. </para>
  17735. </remarks>
  17736. <author>Nicko Cadell</author>
  17737. </member>
  17738. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.#ctor">
  17739. <summary>
  17740. Default constructor
  17741. </summary>
  17742. </member>
  17743. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17744. <summary>
  17745. Write the exception text to the output
  17746. </summary>
  17747. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17748. <param name="loggingEvent">the event being logged</param>
  17749. <remarks>
  17750. <para>
  17751. If an exception object is stored in the logging event
  17752. it will be rendered into the pattern output with a
  17753. trailing newline.
  17754. </para>
  17755. <para>
  17756. If there is no exception or the exception property specified
  17757. by the Option value does not exist then nothing will be output
  17758. and no trailing newline will be appended.
  17759. It is typical to put a newline before the exception
  17760. and to have the exception as the last data in the pattern.
  17761. </para>
  17762. <para>
  17763. Recognized values for the Option parameter are:
  17764. </para>
  17765. <list type="bullet">
  17766. <item>
  17767. <description>Message</description>
  17768. </item>
  17769. <item>
  17770. <description>Source</description>
  17771. </item>
  17772. <item>
  17773. <description>StackTrace</description>
  17774. </item>
  17775. <item>
  17776. <description>TargetSite</description>
  17777. </item>
  17778. <item>
  17779. <description>HelpLink</description>
  17780. </item>
  17781. </list>
  17782. </remarks>
  17783. </member>
  17784. <member name="T:log4net.Layout.Pattern.FileLocationPatternConverter">
  17785. <summary>
  17786. Writes the caller location file name to the output
  17787. </summary>
  17788. <remarks>
  17789. <para>
  17790. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  17791. the event to the output writer.
  17792. </para>
  17793. </remarks>
  17794. <author>Nicko Cadell</author>
  17795. </member>
  17796. <member name="M:log4net.Layout.Pattern.FileLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17797. <summary>
  17798. Write the caller location file name to the output
  17799. </summary>
  17800. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17801. <param name="loggingEvent">the event being logged</param>
  17802. <remarks>
  17803. <para>
  17804. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  17805. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  17806. </para>
  17807. </remarks>
  17808. </member>
  17809. <member name="T:log4net.Layout.Pattern.FullLocationPatternConverter">
  17810. <summary>
  17811. Write the caller location info to the output
  17812. </summary>
  17813. <remarks>
  17814. <para>
  17815. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  17816. </para>
  17817. </remarks>
  17818. <author>Nicko Cadell</author>
  17819. </member>
  17820. <member name="M:log4net.Layout.Pattern.FullLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17821. <summary>
  17822. Write the caller location info to the output
  17823. </summary>
  17824. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17825. <param name="loggingEvent">the event being logged</param>
  17826. <remarks>
  17827. <para>
  17828. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  17829. </para>
  17830. </remarks>
  17831. </member>
  17832. <member name="T:log4net.Layout.Pattern.IdentityPatternConverter">
  17833. <summary>
  17834. Writes the event identity to the output
  17835. </summary>
  17836. <remarks>
  17837. <para>
  17838. Writes the value of the <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  17839. the output writer.
  17840. </para>
  17841. </remarks>
  17842. <author>Daniel Cazzulino</author>
  17843. <author>Nicko Cadell</author>
  17844. </member>
  17845. <member name="M:log4net.Layout.Pattern.IdentityPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17846. <summary>
  17847. Writes the event identity to the output
  17848. </summary>
  17849. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17850. <param name="loggingEvent">the event being logged</param>
  17851. <remarks>
  17852. <para>
  17853. Writes the value of the <paramref name="loggingEvent"/>
  17854. <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  17855. the output <paramref name="writer"/>.
  17856. </para>
  17857. </remarks>
  17858. </member>
  17859. <member name="T:log4net.Layout.Pattern.LevelPatternConverter">
  17860. <summary>
  17861. Write the event level to the output
  17862. </summary>
  17863. <remarks>
  17864. <para>
  17865. Writes the display name of the event <see cref="P:log4net.Core.LoggingEvent.Level"/>
  17866. to the writer.
  17867. </para>
  17868. </remarks>
  17869. <author>Nicko Cadell</author>
  17870. </member>
  17871. <member name="M:log4net.Layout.Pattern.LevelPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17872. <summary>
  17873. Write the event level to the output
  17874. </summary>
  17875. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17876. <param name="loggingEvent">the event being logged</param>
  17877. <remarks>
  17878. <para>
  17879. Writes the <see cref="P:log4net.Core.Level.DisplayName"/> of the <paramref name="loggingEvent"/> <see cref="P:log4net.Core.LoggingEvent.Level"/>
  17880. to the <paramref name="writer"/>.
  17881. </para>
  17882. </remarks>
  17883. </member>
  17884. <member name="T:log4net.Layout.Pattern.LineLocationPatternConverter">
  17885. <summary>
  17886. Write the caller location line number to the output
  17887. </summary>
  17888. <remarks>
  17889. <para>
  17890. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  17891. the event to the output writer.
  17892. </para>
  17893. </remarks>
  17894. <author>Nicko Cadell</author>
  17895. </member>
  17896. <member name="M:log4net.Layout.Pattern.LineLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17897. <summary>
  17898. Write the caller location line number to the output
  17899. </summary>
  17900. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17901. <param name="loggingEvent">the event being logged</param>
  17902. <remarks>
  17903. <para>
  17904. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  17905. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  17906. </para>
  17907. </remarks>
  17908. </member>
  17909. <member name="T:log4net.Layout.Pattern.LoggerPatternConverter">
  17910. <summary>
  17911. Converter for logger name
  17912. </summary>
  17913. <remarks>
  17914. <para>
  17915. Outputs the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the event.
  17916. </para>
  17917. </remarks>
  17918. <author>Nicko Cadell</author>
  17919. </member>
  17920. <member name="T:log4net.Layout.Pattern.NamedPatternConverter">
  17921. <summary>
  17922. Converter to output and truncate <c>'.'</c> separated strings
  17923. </summary>
  17924. <remarks>
  17925. <para>
  17926. This abstract class supports truncating a <c>'.'</c> separated string
  17927. to show a specified number of elements from the right hand side.
  17928. This is used to truncate class names that are fully qualified.
  17929. </para>
  17930. <para>
  17931. Subclasses should override the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> method to
  17932. return the fully qualified string.
  17933. </para>
  17934. </remarks>
  17935. <author>Nicko Cadell</author>
  17936. </member>
  17937. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions">
  17938. <summary>
  17939. Initialize the converter
  17940. </summary>
  17941. <remarks>
  17942. <para>
  17943. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17944. activation scheme. The <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> method must
  17945. be called on this object after the configuration properties have
  17946. been set. Until <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> is called this
  17947. object is in an undefined state and must not be used.
  17948. </para>
  17949. <para>
  17950. If any of the configuration properties are modified then
  17951. <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> must be called again.
  17952. </para>
  17953. </remarks>
  17954. </member>
  17955. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17956. <summary>
  17957. Get the fully qualified string data
  17958. </summary>
  17959. <param name="loggingEvent">the event being logged</param>
  17960. <returns>the fully qualified name</returns>
  17961. <remarks>
  17962. <para>
  17963. Overridden by subclasses to get the fully qualified name before the
  17964. precision is applied to it.
  17965. </para>
  17966. <para>
  17967. Return the fully qualified <c>'.'</c> (dot/period) separated string.
  17968. </para>
  17969. </remarks>
  17970. </member>
  17971. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17972. <summary>
  17973. Convert the pattern to the rendered message
  17974. </summary>
  17975. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17976. <param name="loggingEvent">the event being logged</param>
  17977. <remarks>
  17978. Render the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> to the precision
  17979. specified by the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  17980. </remarks>
  17981. </member>
  17982. <member name="F:log4net.Layout.Pattern.NamedPatternConverter.declaringType">
  17983. <summary>
  17984. The fully qualified type of the NamedPatternConverter class.
  17985. </summary>
  17986. <remarks>
  17987. Used by the internal logger to record the Type of the
  17988. log message.
  17989. </remarks>
  17990. </member>
  17991. <member name="M:log4net.Layout.Pattern.LoggerPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17992. <summary>
  17993. Gets the fully qualified name of the logger
  17994. </summary>
  17995. <param name="loggingEvent">the event being logged</param>
  17996. <returns>The fully qualified logger name</returns>
  17997. <remarks>
  17998. <para>
  17999. Returns the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <paramref name="loggingEvent"/>.
  18000. </para>
  18001. </remarks>
  18002. </member>
  18003. <member name="T:log4net.Layout.Pattern.MessagePatternConverter">
  18004. <summary>
  18005. Writes the event message to the output
  18006. </summary>
  18007. <remarks>
  18008. <para>
  18009. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  18010. to write out the event message.
  18011. </para>
  18012. </remarks>
  18013. <author>Nicko Cadell</author>
  18014. </member>
  18015. <member name="M:log4net.Layout.Pattern.MessagePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18016. <summary>
  18017. Writes the event message to the output
  18018. </summary>
  18019. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18020. <param name="loggingEvent">the event being logged</param>
  18021. <remarks>
  18022. <para>
  18023. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  18024. to write out the event message.
  18025. </para>
  18026. </remarks>
  18027. </member>
  18028. <member name="T:log4net.Layout.Pattern.MethodLocationPatternConverter">
  18029. <summary>
  18030. Write the method name to the output
  18031. </summary>
  18032. <remarks>
  18033. <para>
  18034. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  18035. the output.
  18036. </para>
  18037. </remarks>
  18038. <author>Nicko Cadell</author>
  18039. </member>
  18040. <member name="M:log4net.Layout.Pattern.MethodLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18041. <summary>
  18042. Write the method name to the output
  18043. </summary>
  18044. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18045. <param name="loggingEvent">the event being logged</param>
  18046. <remarks>
  18047. <para>
  18048. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  18049. the output.
  18050. </para>
  18051. </remarks>
  18052. </member>
  18053. <member name="T:log4net.Layout.Pattern.NdcPatternConverter">
  18054. <summary>
  18055. Converter to include event NDC
  18056. </summary>
  18057. <remarks>
  18058. <para>
  18059. Outputs the value of the event property named <c>NDC</c>.
  18060. </para>
  18061. <para>
  18062. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  18063. </para>
  18064. </remarks>
  18065. <author>Nicko Cadell</author>
  18066. </member>
  18067. <member name="M:log4net.Layout.Pattern.NdcPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18068. <summary>
  18069. Write the event NDC to the output
  18070. </summary>
  18071. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18072. <param name="loggingEvent">the event being logged</param>
  18073. <remarks>
  18074. <para>
  18075. As the thread context stacks are now stored in named event properties
  18076. this converter simply looks up the value of the <c>NDC</c> property.
  18077. </para>
  18078. <para>
  18079. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  18080. </para>
  18081. </remarks>
  18082. </member>
  18083. <member name="T:log4net.Layout.Pattern.PropertyPatternConverter">
  18084. <summary>
  18085. Property pattern converter
  18086. </summary>
  18087. <remarks>
  18088. <para>
  18089. Writes out the value of a named property. The property name
  18090. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  18091. property.
  18092. </para>
  18093. <para>
  18094. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  18095. then all the properties are written as key value pairs.
  18096. </para>
  18097. </remarks>
  18098. <author>Nicko Cadell</author>
  18099. </member>
  18100. <member name="M:log4net.Layout.Pattern.PropertyPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18101. <summary>
  18102. Write the property value to the output
  18103. </summary>
  18104. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18105. <param name="loggingEvent">the event being logged</param>
  18106. <remarks>
  18107. <para>
  18108. Writes out the value of a named property. The property name
  18109. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  18110. property.
  18111. </para>
  18112. <para>
  18113. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  18114. then all the properties are written as key value pairs.
  18115. </para>
  18116. </remarks>
  18117. </member>
  18118. <member name="T:log4net.Layout.Pattern.RelativeTimePatternConverter">
  18119. <summary>
  18120. Converter to output the relative time of the event
  18121. </summary>
  18122. <remarks>
  18123. <para>
  18124. Converter to output the time of the event relative to the start of the program.
  18125. </para>
  18126. </remarks>
  18127. <author>Nicko Cadell</author>
  18128. </member>
  18129. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18130. <summary>
  18131. Write the relative time to the output
  18132. </summary>
  18133. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18134. <param name="loggingEvent">the event being logged</param>
  18135. <remarks>
  18136. <para>
  18137. Writes out the relative time of the event in milliseconds.
  18138. That is the number of milliseconds between the event <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  18139. and the <see cref="P:log4net.Core.LoggingEvent.StartTime"/>.
  18140. </para>
  18141. </remarks>
  18142. </member>
  18143. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.TimeDifferenceInMillis(System.DateTime,System.DateTime)">
  18144. <summary>
  18145. Helper method to get the time difference between two DateTime objects
  18146. </summary>
  18147. <param name="start">start time (in the current local time zone)</param>
  18148. <param name="end">end time (in the current local time zone)</param>
  18149. <returns>the time difference in milliseconds</returns>
  18150. </member>
  18151. <member name="T:log4net.Layout.Pattern.StackTraceDetailPatternConverter">
  18152. <summary>
  18153. Write the caller stack frames to the output
  18154. </summary>
  18155. <remarks>
  18156. <para>
  18157. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
  18158. type3.MethodCall3(type param,...) &gt; type2.MethodCall2(type param,...) &gt; type1.MethodCall1(type param,...)
  18159. </para>
  18160. </remarks>
  18161. <author>Adam Davies</author>
  18162. </member>
  18163. <member name="T:log4net.Layout.Pattern.StackTracePatternConverter">
  18164. <summary>
  18165. Write the caller stack frames to the output
  18166. </summary>
  18167. <remarks>
  18168. <para>
  18169. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
  18170. type3.MethodCall3 &gt; type2.MethodCall2 &gt; type1.MethodCall1
  18171. </para>
  18172. </remarks>
  18173. <author>Michael Cromwell</author>
  18174. </member>
  18175. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions">
  18176. <summary>
  18177. Initialize the converter
  18178. </summary>
  18179. <remarks>
  18180. <para>
  18181. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  18182. activation scheme. The <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> method must
  18183. be called on this object after the configuration properties have
  18184. been set. Until <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> is called this
  18185. object is in an undefined state and must not be used.
  18186. </para>
  18187. <para>
  18188. If any of the configuration properties are modified then
  18189. <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> must be called again.
  18190. </para>
  18191. </remarks>
  18192. </member>
  18193. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18194. <summary>
  18195. Write the strack frames to the output
  18196. </summary>
  18197. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18198. <param name="loggingEvent">the event being logged</param>
  18199. <remarks>
  18200. <para>
  18201. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer.
  18202. </para>
  18203. </remarks>
  18204. </member>
  18205. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.GetMethodInformation(log4net.Core.MethodItem)">
  18206. <summary>
  18207. Returns the Name of the method
  18208. </summary>
  18209. <param name="method"></param>
  18210. <remarks>This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter</remarks>
  18211. <returns>string</returns>
  18212. </member>
  18213. <member name="F:log4net.Layout.Pattern.StackTracePatternConverter.declaringType">
  18214. <summary>
  18215. The fully qualified type of the StackTracePatternConverter class.
  18216. </summary>
  18217. <remarks>
  18218. Used by the internal logger to record the Type of the
  18219. log message.
  18220. </remarks>
  18221. </member>
  18222. <member name="F:log4net.Layout.Pattern.StackTraceDetailPatternConverter.declaringType">
  18223. <summary>
  18224. The fully qualified type of the StackTraceDetailPatternConverter class.
  18225. </summary>
  18226. <remarks>
  18227. Used by the internal logger to record the Type of the
  18228. log message.
  18229. </remarks>
  18230. </member>
  18231. <member name="T:log4net.Layout.Pattern.ThreadPatternConverter">
  18232. <summary>
  18233. Converter to include event thread name
  18234. </summary>
  18235. <remarks>
  18236. <para>
  18237. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the output.
  18238. </para>
  18239. </remarks>
  18240. <author>Nicko Cadell</author>
  18241. </member>
  18242. <member name="M:log4net.Layout.Pattern.ThreadPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18243. <summary>
  18244. Write the ThreadName to the output
  18245. </summary>
  18246. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18247. <param name="loggingEvent">the event being logged</param>
  18248. <remarks>
  18249. <para>
  18250. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the <paramref name="writer"/>.
  18251. </para>
  18252. </remarks>
  18253. </member>
  18254. <member name="T:log4net.Layout.Pattern.TypeNamePatternConverter">
  18255. <summary>
  18256. Pattern converter for the class name
  18257. </summary>
  18258. <remarks>
  18259. <para>
  18260. Outputs the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the event.
  18261. </para>
  18262. </remarks>
  18263. <author>Nicko Cadell</author>
  18264. </member>
  18265. <member name="M:log4net.Layout.Pattern.TypeNamePatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  18266. <summary>
  18267. Gets the fully qualified name of the class
  18268. </summary>
  18269. <param name="loggingEvent">the event being logged</param>
  18270. <returns>The fully qualified type name for the caller location</returns>
  18271. <remarks>
  18272. <para>
  18273. Returns the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the <paramref name="loggingEvent"/>.
  18274. </para>
  18275. </remarks>
  18276. </member>
  18277. <member name="T:log4net.Layout.Pattern.UserNamePatternConverter">
  18278. <summary>
  18279. Converter to include event user name
  18280. </summary>
  18281. <author>Douglas de la Torre</author>
  18282. <author>Nicko Cadell</author>
  18283. </member>
  18284. <member name="M:log4net.Layout.Pattern.UserNamePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18285. <summary>
  18286. Convert the pattern to the rendered message
  18287. </summary>
  18288. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18289. <param name="loggingEvent">the event being logged</param>
  18290. </member>
  18291. <member name="T:log4net.Layout.Pattern.UtcDatePatternConverter">
  18292. <summary>
  18293. Write the TimeStamp to the output
  18294. </summary>
  18295. <remarks>
  18296. <para>
  18297. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  18298. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  18299. </para>
  18300. <para>
  18301. Uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  18302. in Universal time.
  18303. </para>
  18304. <para>
  18305. See the <see cref="T:log4net.Layout.Pattern.DatePatternConverter"/> for details on the date pattern syntax.
  18306. </para>
  18307. </remarks>
  18308. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  18309. <author>Nicko Cadell</author>
  18310. </member>
  18311. <member name="M:log4net.Layout.Pattern.UtcDatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18312. <summary>
  18313. Write the TimeStamp to the output
  18314. </summary>
  18315. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18316. <param name="loggingEvent">the event being logged</param>
  18317. <remarks>
  18318. <para>
  18319. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  18320. for it to render it to the writer.
  18321. </para>
  18322. <para>
  18323. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone, this is converted
  18324. to Universal time before it is rendered.
  18325. </para>
  18326. </remarks>
  18327. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  18328. </member>
  18329. <member name="F:log4net.Layout.Pattern.UtcDatePatternConverter.declaringType">
  18330. <summary>
  18331. The fully qualified type of the UtcDatePatternConverter class.
  18332. </summary>
  18333. <remarks>
  18334. Used by the internal logger to record the Type of the
  18335. log message.
  18336. </remarks>
  18337. </member>
  18338. <member name="T:log4net.Layout.DynamicPatternLayout">
  18339. <summary>
  18340. A flexible layout configurable with pattern string that re-evaluates on each call.
  18341. </summary>
  18342. <remarks>
  18343. <para>This class is built on <see cref="T:log4net.Layout.PatternLayout"></see> and provides all the
  18344. features and capabilities of PatternLayout. PatternLayout is a 'static' class
  18345. in that its layout is done once at configuration time. This class will recreate
  18346. the layout on each reference.</para>
  18347. <para>One important difference between PatternLayout and DynamicPatternLayout is the
  18348. treatment of the Header and Footer parameters in the configuration. The Header and Footer
  18349. parameters for DynamicPatternLayout must be syntactically in the form of a PatternString,
  18350. but should not be marked as type log4net.Util.PatternString. Doing so causes the
  18351. pattern to be statically converted at configuration time and causes DynamicPatternLayout
  18352. to perform the same as PatternLayout.</para>
  18353. <para>Please see <see cref="T:log4net.Layout.PatternLayout"/> for complete documentation.</para>
  18354. <example>
  18355. &lt;layout type="log4net.Layout.DynamicPatternLayout"&gt;
  18356. &lt;param name="Header" value="%newline**** Trace Opened Local: %date{yyyy-MM-dd HH:mm:ss.fff} UTC: %utcdate{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /&gt;
  18357. &lt;param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /&gt;
  18358. &lt;/layout&gt;
  18359. </example>
  18360. </remarks>
  18361. </member>
  18362. <member name="T:log4net.Layout.PatternLayout">
  18363. <summary>
  18364. A flexible layout configurable with pattern string.
  18365. </summary>
  18366. <remarks>
  18367. <para>
  18368. The goal of this class is to <see cref="M:PatternLayout.Format(TextWriter,LoggingEvent)"/> a
  18369. <see cref="T:log4net.Core.LoggingEvent"/> as a string. The results
  18370. depend on the <i>conversion pattern</i>.
  18371. </para>
  18372. <para>
  18373. The conversion pattern is closely related to the conversion
  18374. pattern of the printf function in C. A conversion pattern is
  18375. composed of literal text and format control expressions called
  18376. <i>conversion specifiers</i>.
  18377. </para>
  18378. <para>
  18379. <i>You are free to insert any literal text within the conversion
  18380. pattern.</i>
  18381. </para>
  18382. <para>
  18383. Each conversion specifier starts with a percent sign (%) and is
  18384. followed by optional <i>format modifiers</i> and a <i>conversion
  18385. pattern name</i>. The conversion pattern name specifies the type of
  18386. data, e.g. logger, level, date, thread name. The format
  18387. modifiers control such things as field width, padding, left and
  18388. right justification. The following is a simple example.
  18389. </para>
  18390. <para>
  18391. Let the conversion pattern be <b>"%-5level [%thread]: %message%newline"</b> and assume
  18392. that the log4net environment was set to use a PatternLayout. Then the
  18393. statements
  18394. </para>
  18395. <code lang="C#">
  18396. ILog log = LogManager.GetLogger(typeof(TestApp));
  18397. log.Debug("Message 1");
  18398. log.Warn("Message 2");
  18399. </code>
  18400. <para>would yield the output</para>
  18401. <code>
  18402. DEBUG [main]: Message 1
  18403. WARN [main]: Message 2
  18404. </code>
  18405. <para>
  18406. Note that there is no explicit separator between text and
  18407. conversion specifiers. The pattern parser knows when it has reached
  18408. the end of a conversion specifier when it reads a conversion
  18409. character. In the example above the conversion specifier
  18410. <b>%-5level</b> means the level of the logging event should be left
  18411. justified to a width of five characters.
  18412. </para>
  18413. <para>
  18414. The recognized conversion pattern names are:
  18415. </para>
  18416. <list type="table">
  18417. <listheader>
  18418. <term>Conversion Pattern Name</term>
  18419. <description>Effect</description>
  18420. </listheader>
  18421. <item>
  18422. <term>a</term>
  18423. <description>Equivalent to <b>appdomain</b></description>
  18424. </item>
  18425. <item>
  18426. <term>appdomain</term>
  18427. <description>
  18428. Used to output the friendly name of the AppDomain where the
  18429. logging event was generated.
  18430. </description>
  18431. </item>
  18432. <item>
  18433. <term>aspnet-cache</term>
  18434. <description>
  18435. <para>
  18436. Used to output all cache items in the case of <b>%aspnet-cache</b> or just one named item if used as <b>%aspnet-cache{key}</b>
  18437. </para>
  18438. <para>
  18439. This pattern is not available for Compact Framework or Client Profile assemblies.
  18440. </para>
  18441. </description>
  18442. </item>
  18443. <item>
  18444. <term>aspnet-context</term>
  18445. <description>
  18446. <para>
  18447. Used to output all context items in the case of <b>%aspnet-context</b> or just one named item if used as <b>%aspnet-context{key}</b>
  18448. </para>
  18449. <para>
  18450. This pattern is not available for Compact Framework or Client Profile assemblies.
  18451. </para>
  18452. </description>
  18453. </item>
  18454. <item>
  18455. <term>aspnet-request</term>
  18456. <description>
  18457. <para>
  18458. Used to output all request parameters in the case of <b>%aspnet-request</b> or just one named param if used as <b>%aspnet-request{key}</b>
  18459. </para>
  18460. <para>
  18461. This pattern is not available for Compact Framework or Client Profile assemblies.
  18462. </para>
  18463. </description>
  18464. </item>
  18465. <item>
  18466. <term>aspnet-session</term>
  18467. <description>
  18468. <para>
  18469. Used to output all session items in the case of <b>%aspnet-session</b> or just one named item if used as <b>%aspnet-session{key}</b>
  18470. </para>
  18471. <para>
  18472. This pattern is not available for Compact Framework or Client Profile assemblies.
  18473. </para>
  18474. </description>
  18475. </item>
  18476. <item>
  18477. <term>c</term>
  18478. <description>Equivalent to <b>logger</b></description>
  18479. </item>
  18480. <item>
  18481. <term>C</term>
  18482. <description>Equivalent to <b>type</b></description>
  18483. </item>
  18484. <item>
  18485. <term>class</term>
  18486. <description>Equivalent to <b>type</b></description>
  18487. </item>
  18488. <item>
  18489. <term>d</term>
  18490. <description>Equivalent to <b>date</b></description>
  18491. </item>
  18492. <item>
  18493. <term>date</term>
  18494. <description>
  18495. <para>
  18496. Used to output the date of the logging event in the local time zone.
  18497. To output the date in universal time use the <c>%utcdate</c> pattern.
  18498. The date conversion
  18499. specifier may be followed by a <i>date format specifier</i> enclosed
  18500. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  18501. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  18502. given then ISO8601 format is
  18503. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  18504. </para>
  18505. <para>
  18506. The date format specifier admits the same syntax as the
  18507. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  18508. </para>
  18509. <para>
  18510. For better results it is recommended to use the log4net date
  18511. formatters. These can be specified using one of the strings
  18512. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  18513. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  18514. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  18515. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  18516. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  18517. </para>
  18518. <para>
  18519. These dedicated date formatters perform significantly
  18520. better than <see cref="M:DateTime.ToString(string)"/>.
  18521. </para>
  18522. </description>
  18523. </item>
  18524. <item>
  18525. <term>exception</term>
  18526. <description>
  18527. <para>
  18528. Used to output the exception passed in with the log message.
  18529. </para>
  18530. <para>
  18531. If an exception object is stored in the logging event
  18532. it will be rendered into the pattern output with a
  18533. trailing newline.
  18534. If there is no exception then nothing will be output
  18535. and no trailing newline will be appended.
  18536. It is typical to put a newline before the exception
  18537. and to have the exception as the last data in the pattern.
  18538. </para>
  18539. </description>
  18540. </item>
  18541. <item>
  18542. <term>F</term>
  18543. <description>Equivalent to <b>file</b></description>
  18544. </item>
  18545. <item>
  18546. <term>file</term>
  18547. <description>
  18548. <para>
  18549. Used to output the file name where the logging request was
  18550. issued.
  18551. </para>
  18552. <para>
  18553. <b>WARNING</b> Generating caller location information is
  18554. extremely slow. Its use should be avoided unless execution speed
  18555. is not an issue.
  18556. </para>
  18557. <para>
  18558. See the note below on the availability of caller location information.
  18559. </para>
  18560. </description>
  18561. </item>
  18562. <item>
  18563. <term>identity</term>
  18564. <description>
  18565. <para>
  18566. Used to output the user name for the currently active user
  18567. (Principal.Identity.Name).
  18568. </para>
  18569. <para>
  18570. <b>WARNING</b> Generating caller information is
  18571. extremely slow. Its use should be avoided unless execution speed
  18572. is not an issue.
  18573. </para>
  18574. </description>
  18575. </item>
  18576. <item>
  18577. <term>l</term>
  18578. <description>Equivalent to <b>location</b></description>
  18579. </item>
  18580. <item>
  18581. <term>L</term>
  18582. <description>Equivalent to <b>line</b></description>
  18583. </item>
  18584. <item>
  18585. <term>location</term>
  18586. <description>
  18587. <para>
  18588. Used to output location information of the caller which generated
  18589. the logging event.
  18590. </para>
  18591. <para>
  18592. The location information depends on the CLI implementation but
  18593. usually consists of the fully qualified name of the calling
  18594. method followed by the callers source the file name and line
  18595. number between parentheses.
  18596. </para>
  18597. <para>
  18598. The location information can be very useful. However, its
  18599. generation is <b>extremely</b> slow. Its use should be avoided
  18600. unless execution speed is not an issue.
  18601. </para>
  18602. <para>
  18603. See the note below on the availability of caller location information.
  18604. </para>
  18605. </description>
  18606. </item>
  18607. <item>
  18608. <term>level</term>
  18609. <description>
  18610. <para>
  18611. Used to output the level of the logging event.
  18612. </para>
  18613. </description>
  18614. </item>
  18615. <item>
  18616. <term>line</term>
  18617. <description>
  18618. <para>
  18619. Used to output the line number from where the logging request
  18620. was issued.
  18621. </para>
  18622. <para>
  18623. <b>WARNING</b> Generating caller location information is
  18624. extremely slow. Its use should be avoided unless execution speed
  18625. is not an issue.
  18626. </para>
  18627. <para>
  18628. See the note below on the availability of caller location information.
  18629. </para>
  18630. </description>
  18631. </item>
  18632. <item>
  18633. <term>logger</term>
  18634. <description>
  18635. <para>
  18636. Used to output the logger of the logging event. The
  18637. logger conversion specifier can be optionally followed by
  18638. <i>precision specifier</i>, that is a decimal constant in
  18639. brackets.
  18640. </para>
  18641. <para>
  18642. If a precision specifier is given, then only the corresponding
  18643. number of right most components of the logger name will be
  18644. printed. By default the logger name is printed in full.
  18645. </para>
  18646. <para>
  18647. For example, for the logger name "a.b.c" the pattern
  18648. <b>%logger{2}</b> will output "b.c".
  18649. </para>
  18650. </description>
  18651. </item>
  18652. <item>
  18653. <term>m</term>
  18654. <description>Equivalent to <b>message</b></description>
  18655. </item>
  18656. <item>
  18657. <term>M</term>
  18658. <description>Equivalent to <b>method</b></description>
  18659. </item>
  18660. <item>
  18661. <term>message</term>
  18662. <description>
  18663. <para>
  18664. Used to output the application supplied message associated with
  18665. the logging event.
  18666. </para>
  18667. </description>
  18668. </item>
  18669. <item>
  18670. <term>mdc</term>
  18671. <description>
  18672. <para>
  18673. The MDC (old name for the ThreadContext.Properties) is now part of the
  18674. combined event properties. This pattern is supported for compatibility
  18675. but is equivalent to <b>property</b>.
  18676. </para>
  18677. </description>
  18678. </item>
  18679. <item>
  18680. <term>method</term>
  18681. <description>
  18682. <para>
  18683. Used to output the method name where the logging request was
  18684. issued.
  18685. </para>
  18686. <para>
  18687. <b>WARNING</b> Generating caller location information is
  18688. extremely slow. Its use should be avoided unless execution speed
  18689. is not an issue.
  18690. </para>
  18691. <para>
  18692. See the note below on the availability of caller location information.
  18693. </para>
  18694. </description>
  18695. </item>
  18696. <item>
  18697. <term>n</term>
  18698. <description>Equivalent to <b>newline</b></description>
  18699. </item>
  18700. <item>
  18701. <term>newline</term>
  18702. <description>
  18703. <para>
  18704. Outputs the platform dependent line separator character or
  18705. characters.
  18706. </para>
  18707. <para>
  18708. This conversion pattern offers the same performance as using
  18709. non-portable line separator strings such as "\n", or "\r\n".
  18710. Thus, it is the preferred way of specifying a line separator.
  18711. </para>
  18712. </description>
  18713. </item>
  18714. <item>
  18715. <term>ndc</term>
  18716. <description>
  18717. <para>
  18718. Used to output the NDC (nested diagnostic context) associated
  18719. with the thread that generated the logging event.
  18720. </para>
  18721. </description>
  18722. </item>
  18723. <item>
  18724. <term>p</term>
  18725. <description>Equivalent to <b>level</b></description>
  18726. </item>
  18727. <item>
  18728. <term>P</term>
  18729. <description>Equivalent to <b>property</b></description>
  18730. </item>
  18731. <item>
  18732. <term>properties</term>
  18733. <description>Equivalent to <b>property</b></description>
  18734. </item>
  18735. <item>
  18736. <term>property</term>
  18737. <description>
  18738. <para>
  18739. Used to output the an event specific property. The key to
  18740. lookup must be specified within braces and directly following the
  18741. pattern specifier, e.g. <b>%property{user}</b> would include the value
  18742. from the property that is keyed by the string 'user'. Each property value
  18743. that is to be included in the log must be specified separately.
  18744. Properties are added to events by loggers or appenders. By default
  18745. the <c>log4net:HostName</c> property is set to the name of machine on
  18746. which the event was originally logged.
  18747. </para>
  18748. <para>
  18749. If no key is specified, e.g. <b>%property</b> then all the keys and their
  18750. values are printed in a comma separated list.
  18751. </para>
  18752. <para>
  18753. The properties of an event are combined from a number of different
  18754. contexts. These are listed below in the order in which they are searched.
  18755. </para>
  18756. <list type="definition">
  18757. <item>
  18758. <term>the event properties</term>
  18759. <description>
  18760. The event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  18761. properties are specific to this event only.
  18762. </description>
  18763. </item>
  18764. <item>
  18765. <term>the thread properties</term>
  18766. <description>
  18767. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  18768. thread. These properties are shared by all events logged on this thread.
  18769. </description>
  18770. </item>
  18771. <item>
  18772. <term>the global properties</term>
  18773. <description>
  18774. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  18775. properties are shared by all the threads in the AppDomain.
  18776. </description>
  18777. </item>
  18778. </list>
  18779. </description>
  18780. </item>
  18781. <item>
  18782. <term>r</term>
  18783. <description>Equivalent to <b>timestamp</b></description>
  18784. </item>
  18785. <item>
  18786. <term>stacktrace</term>
  18787. <description>
  18788. <para>
  18789. Used to output the stack trace of the logging event
  18790. The stack trace level specifier may be enclosed
  18791. between braces. For example, <b>%stacktrace{level}</b>.
  18792. If no stack trace level specifier is given then 1 is assumed
  18793. </para>
  18794. <para>
  18795. Output uses the format:
  18796. type3.MethodCall3 &gt; type2.MethodCall2 &gt; type1.MethodCall1
  18797. </para>
  18798. <para>
  18799. This pattern is not available for Compact Framework assemblies.
  18800. </para>
  18801. </description>
  18802. </item>
  18803. <item>
  18804. <term>stacktracedetail</term>
  18805. <description>
  18806. <para>
  18807. Used to output the stack trace of the logging event
  18808. The stack trace level specifier may be enclosed
  18809. between braces. For example, <b>%stacktracedetail{level}</b>.
  18810. If no stack trace level specifier is given then 1 is assumed
  18811. </para>
  18812. <para>
  18813. Output uses the format:
  18814. type3.MethodCall3(type param,...) &gt; type2.MethodCall2(type param,...) &gt; type1.MethodCall1(type param,...)
  18815. </para>
  18816. <para>
  18817. This pattern is not available for Compact Framework assemblies.
  18818. </para>
  18819. </description>
  18820. </item>
  18821. <item>
  18822. <term>t</term>
  18823. <description>Equivalent to <b>thread</b></description>
  18824. </item>
  18825. <item>
  18826. <term>timestamp</term>
  18827. <description>
  18828. <para>
  18829. Used to output the number of milliseconds elapsed since the start
  18830. of the application until the creation of the logging event.
  18831. </para>
  18832. </description>
  18833. </item>
  18834. <item>
  18835. <term>thread</term>
  18836. <description>
  18837. <para>
  18838. Used to output the name of the thread that generated the
  18839. logging event. Uses the thread number if no name is available.
  18840. </para>
  18841. </description>
  18842. </item>
  18843. <item>
  18844. <term>type</term>
  18845. <description>
  18846. <para>
  18847. Used to output the fully qualified type name of the caller
  18848. issuing the logging request. This conversion specifier
  18849. can be optionally followed by <i>precision specifier</i>, that
  18850. is a decimal constant in brackets.
  18851. </para>
  18852. <para>
  18853. If a precision specifier is given, then only the corresponding
  18854. number of right most components of the class name will be
  18855. printed. By default the class name is output in fully qualified form.
  18856. </para>
  18857. <para>
  18858. For example, for the class name "log4net.Layout.PatternLayout", the
  18859. pattern <b>%type{1}</b> will output "PatternLayout".
  18860. </para>
  18861. <para>
  18862. <b>WARNING</b> Generating the caller class information is
  18863. slow. Thus, its use should be avoided unless execution speed is
  18864. not an issue.
  18865. </para>
  18866. <para>
  18867. See the note below on the availability of caller location information.
  18868. </para>
  18869. </description>
  18870. </item>
  18871. <item>
  18872. <term>u</term>
  18873. <description>Equivalent to <b>identity</b></description>
  18874. </item>
  18875. <item>
  18876. <term>username</term>
  18877. <description>
  18878. <para>
  18879. Used to output the WindowsIdentity for the currently
  18880. active user.
  18881. </para>
  18882. <para>
  18883. <b>WARNING</b> Generating caller WindowsIdentity information is
  18884. extremely slow. Its use should be avoided unless execution speed
  18885. is not an issue.
  18886. </para>
  18887. </description>
  18888. </item>
  18889. <item>
  18890. <term>utcdate</term>
  18891. <description>
  18892. <para>
  18893. Used to output the date of the logging event in universal time.
  18894. The date conversion
  18895. specifier may be followed by a <i>date format specifier</i> enclosed
  18896. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  18897. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  18898. given then ISO8601 format is
  18899. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  18900. </para>
  18901. <para>
  18902. The date format specifier admits the same syntax as the
  18903. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  18904. </para>
  18905. <para>
  18906. For better results it is recommended to use the log4net date
  18907. formatters. These can be specified using one of the strings
  18908. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  18909. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  18910. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  18911. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  18912. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  18913. </para>
  18914. <para>
  18915. These dedicated date formatters perform significantly
  18916. better than <see cref="M:DateTime.ToString(string)"/>.
  18917. </para>
  18918. </description>
  18919. </item>
  18920. <item>
  18921. <term>w</term>
  18922. <description>Equivalent to <b>username</b></description>
  18923. </item>
  18924. <item>
  18925. <term>x</term>
  18926. <description>Equivalent to <b>ndc</b></description>
  18927. </item>
  18928. <item>
  18929. <term>X</term>
  18930. <description>Equivalent to <b>mdc</b></description>
  18931. </item>
  18932. <item>
  18933. <term>%</term>
  18934. <description>
  18935. <para>
  18936. The sequence %% outputs a single percent sign.
  18937. </para>
  18938. </description>
  18939. </item>
  18940. </list>
  18941. <para>
  18942. The single letter patterns are deprecated in favor of the
  18943. longer more descriptive pattern names.
  18944. </para>
  18945. <para>
  18946. By default the relevant information is output as is. However,
  18947. with the aid of format modifiers it is possible to change the
  18948. minimum field width, the maximum field width and justification.
  18949. </para>
  18950. <para>
  18951. The optional format modifier is placed between the percent sign
  18952. and the conversion pattern name.
  18953. </para>
  18954. <para>
  18955. The first optional format modifier is the <i>left justification
  18956. flag</i> which is just the minus (-) character. Then comes the
  18957. optional <i>minimum field width</i> modifier. This is a decimal
  18958. constant that represents the minimum number of characters to
  18959. output. If the data item requires fewer characters, it is padded on
  18960. either the left or the right until the minimum width is
  18961. reached. The default is to pad on the left (right justify) but you
  18962. can specify right padding with the left justification flag. The
  18963. padding character is space. If the data item is larger than the
  18964. minimum field width, the field is expanded to accommodate the
  18965. data. The value is never truncated.
  18966. </para>
  18967. <para>
  18968. This behavior can be changed using the <i>maximum field
  18969. width</i> modifier which is designated by a period followed by a
  18970. decimal constant. If the data item is longer than the maximum
  18971. field, then the extra characters are removed from the
  18972. <i>beginning</i> of the data item and not from the end. For
  18973. example, it the maximum field width is eight and the data item is
  18974. ten characters long, then the first two characters of the data item
  18975. are dropped. This behavior deviates from the printf function in C
  18976. where truncation is done from the end.
  18977. </para>
  18978. <para>
  18979. Below are various format modifier examples for the logger
  18980. conversion specifier.
  18981. </para>
  18982. <div class="tablediv">
  18983. <table class="dtTABLE" cellspacing="0">
  18984. <tr>
  18985. <th>Format modifier</th>
  18986. <th>left justify</th>
  18987. <th>minimum width</th>
  18988. <th>maximum width</th>
  18989. <th>comment</th>
  18990. </tr>
  18991. <tr>
  18992. <td align="center">%20logger</td>
  18993. <td align="center">false</td>
  18994. <td align="center">20</td>
  18995. <td align="center">none</td>
  18996. <td>
  18997. <para>
  18998. Left pad with spaces if the logger name is less than 20
  18999. characters long.
  19000. </para>
  19001. </td>
  19002. </tr>
  19003. <tr>
  19004. <td align="center">%-20logger</td>
  19005. <td align="center">true</td>
  19006. <td align="center">20</td>
  19007. <td align="center">none</td>
  19008. <td>
  19009. <para>
  19010. Right pad with spaces if the logger
  19011. name is less than 20 characters long.
  19012. </para>
  19013. </td>
  19014. </tr>
  19015. <tr>
  19016. <td align="center">%.30logger</td>
  19017. <td align="center">NA</td>
  19018. <td align="center">none</td>
  19019. <td align="center">30</td>
  19020. <td>
  19021. <para>
  19022. Truncate from the beginning if the logger
  19023. name is longer than 30 characters.
  19024. </para>
  19025. </td>
  19026. </tr>
  19027. <tr>
  19028. <td align="center"><nobr>%20.30logger</nobr></td>
  19029. <td align="center">false</td>
  19030. <td align="center">20</td>
  19031. <td align="center">30</td>
  19032. <td>
  19033. <para>
  19034. Left pad with spaces if the logger name is shorter than 20
  19035. characters. However, if logger name is longer than 30 characters,
  19036. then truncate from the beginning.
  19037. </para>
  19038. </td>
  19039. </tr>
  19040. <tr>
  19041. <td align="center">%-20.30logger</td>
  19042. <td align="center">true</td>
  19043. <td align="center">20</td>
  19044. <td align="center">30</td>
  19045. <td>
  19046. <para>
  19047. Right pad with spaces if the logger name is shorter than 20
  19048. characters. However, if logger name is longer than 30 characters,
  19049. then truncate from the beginning.
  19050. </para>
  19051. </td>
  19052. </tr>
  19053. </table>
  19054. </div>
  19055. <para>
  19056. <b>Note about caller location information.</b><br/>
  19057. The following patterns <c>%type %file %line %method %location %class %C %F %L %l %M</c>
  19058. all generate caller location information.
  19059. Location information uses the <c>System.Diagnostics.StackTrace</c> class to generate
  19060. a call stack. The caller's information is then extracted from this stack.
  19061. </para>
  19062. <note type="caution">
  19063. <para>
  19064. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  19065. .NET Compact Framework 1.0 therefore caller location information is not
  19066. available on that framework.
  19067. </para>
  19068. </note>
  19069. <note type="caution">
  19070. <para>
  19071. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  19072. </para>
  19073. <para>
  19074. "StackTrace information will be most informative with Debug build configurations.
  19075. By default, Debug builds include debug symbols, while Release builds do not. The
  19076. debug symbols contain most of the file, method name, line number, and column
  19077. information used in constructing StackFrame and StackTrace objects. StackTrace
  19078. might not report as many method calls as expected, due to code transformations
  19079. that occur during optimization."
  19080. </para>
  19081. <para>
  19082. This means that in a Release build the caller information may be incomplete or may
  19083. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  19084. </para>
  19085. </note>
  19086. <para>
  19087. Additional pattern converters may be registered with a specific <see cref="T:log4net.Layout.PatternLayout"/>
  19088. instance using the <see cref="M:AddConverter(string, Type)"/> method.
  19089. </para>
  19090. </remarks>
  19091. <example>
  19092. This is a more detailed pattern.
  19093. <code><b>%timestamp [%thread] %level %logger %ndc - %message%newline</b></code>
  19094. </example>
  19095. <example>
  19096. A similar pattern except that the relative time is
  19097. right padded if less than 6 digits, thread name is right padded if
  19098. less than 15 characters and truncated if longer and the logger
  19099. name is left padded if shorter than 30 characters and truncated if
  19100. longer.
  19101. <code><b>%-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline</b></code>
  19102. </example>
  19103. <author>Nicko Cadell</author>
  19104. <author>Gert Driesen</author>
  19105. <author>Douglas de la Torre</author>
  19106. <author>Daniel Cazzulino</author>
  19107. </member>
  19108. <member name="T:log4net.Layout.LayoutSkeleton">
  19109. <summary>
  19110. Extend this abstract class to create your own log layout format.
  19111. </summary>
  19112. <remarks>
  19113. <para>
  19114. This is the base implementation of the <see cref="T:log4net.Layout.ILayout"/>
  19115. interface. Most layout objects should extend this class.
  19116. </para>
  19117. </remarks>
  19118. <remarks>
  19119. <note type="inheritinfo">
  19120. <para>
  19121. Subclasses must implement the <see cref="M:Format(TextWriter,LoggingEvent)"/>
  19122. method.
  19123. </para>
  19124. <para>
  19125. Subclasses should set the <see cref="P:log4net.Layout.LayoutSkeleton.IgnoresException"/> in their default
  19126. constructor.
  19127. </para>
  19128. </note>
  19129. </remarks>
  19130. <author>Nicko Cadell</author>
  19131. <author>Gert Driesen</author>
  19132. </member>
  19133. <member name="T:log4net.Layout.ILayout">
  19134. <summary>
  19135. Interface implemented by layout objects
  19136. </summary>
  19137. <remarks>
  19138. <para>
  19139. An <see cref="T:log4net.Layout.ILayout"/> object is used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  19140. as text. The <see cref="M:Format(TextWriter,LoggingEvent)"/> method is called by an
  19141. appender to transform the <see cref="T:log4net.Core.LoggingEvent"/> into a string.
  19142. </para>
  19143. <para>
  19144. The layout can also supply <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  19145. text that is appender before any events and after all the events respectively.
  19146. </para>
  19147. </remarks>
  19148. <author>Nicko Cadell</author>
  19149. <author>Gert Driesen</author>
  19150. </member>
  19151. <member name="M:log4net.Layout.ILayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19152. <summary>
  19153. Implement this method to create your own layout format.
  19154. </summary>
  19155. <param name="writer">The TextWriter to write the formatted event to</param>
  19156. <param name="loggingEvent">The event to format</param>
  19157. <remarks>
  19158. <para>
  19159. This method is called by an appender to format
  19160. the <paramref name="loggingEvent"/> as text and output to a writer.
  19161. </para>
  19162. <para>
  19163. If the caller does not have a <see cref="T:System.IO.TextWriter"/> and prefers the
  19164. event to be formatted as a <see cref="T:System.String"/> then the following
  19165. code can be used to format the event into a <see cref="T:System.IO.StringWriter"/>.
  19166. </para>
  19167. <code lang="C#">
  19168. StringWriter writer = new StringWriter();
  19169. Layout.Format(writer, loggingEvent);
  19170. string formattedEvent = writer.ToString();
  19171. </code>
  19172. </remarks>
  19173. </member>
  19174. <member name="P:log4net.Layout.ILayout.ContentType">
  19175. <summary>
  19176. The content type output by this layout.
  19177. </summary>
  19178. <value>The content type</value>
  19179. <remarks>
  19180. <para>
  19181. The content type output by this layout.
  19182. </para>
  19183. <para>
  19184. This is a MIME type e.g. <c>"text/plain"</c>.
  19185. </para>
  19186. </remarks>
  19187. </member>
  19188. <member name="P:log4net.Layout.ILayout.Header">
  19189. <summary>
  19190. The header for the layout format.
  19191. </summary>
  19192. <value>the layout header</value>
  19193. <remarks>
  19194. <para>
  19195. The Header text will be appended before any logging events
  19196. are formatted and appended.
  19197. </para>
  19198. </remarks>
  19199. </member>
  19200. <member name="P:log4net.Layout.ILayout.Footer">
  19201. <summary>
  19202. The footer for the layout format.
  19203. </summary>
  19204. <value>the layout footer</value>
  19205. <remarks>
  19206. <para>
  19207. The Footer text will be appended after all the logging events
  19208. have been formatted and appended.
  19209. </para>
  19210. </remarks>
  19211. </member>
  19212. <member name="P:log4net.Layout.ILayout.IgnoresException">
  19213. <summary>
  19214. Flag indicating if this layout handle exceptions
  19215. </summary>
  19216. <value><c>false</c> if this layout handles exceptions</value>
  19217. <remarks>
  19218. <para>
  19219. If this layout handles the exception object contained within
  19220. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  19221. <c>false</c>. Otherwise, if the layout ignores the exception
  19222. object, then the layout should return <c>true</c>.
  19223. </para>
  19224. </remarks>
  19225. </member>
  19226. <member name="F:log4net.Layout.LayoutSkeleton.m_header">
  19227. <summary>
  19228. The header text
  19229. </summary>
  19230. <remarks>
  19231. <para>
  19232. See <see cref="P:log4net.Layout.LayoutSkeleton.Header"/> for more information.
  19233. </para>
  19234. </remarks>
  19235. </member>
  19236. <member name="F:log4net.Layout.LayoutSkeleton.m_footer">
  19237. <summary>
  19238. The footer text
  19239. </summary>
  19240. <remarks>
  19241. <para>
  19242. See <see cref="P:log4net.Layout.LayoutSkeleton.Footer"/> for more information.
  19243. </para>
  19244. </remarks>
  19245. </member>
  19246. <member name="F:log4net.Layout.LayoutSkeleton.m_ignoresException">
  19247. <summary>
  19248. Flag indicating if this layout handles exceptions
  19249. </summary>
  19250. <remarks>
  19251. <para>
  19252. <c>false</c> if this layout handles exceptions
  19253. </para>
  19254. </remarks>
  19255. </member>
  19256. <member name="M:log4net.Layout.LayoutSkeleton.#ctor">
  19257. <summary>
  19258. Empty default constructor
  19259. </summary>
  19260. <remarks>
  19261. <para>
  19262. Empty default constructor
  19263. </para>
  19264. </remarks>
  19265. </member>
  19266. <member name="M:log4net.Layout.LayoutSkeleton.ActivateOptions">
  19267. <summary>
  19268. Activate component options
  19269. </summary>
  19270. <remarks>
  19271. <para>
  19272. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19273. activation scheme. The <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> method must
  19274. be called on this object after the configuration properties have
  19275. been set. Until <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> is called this
  19276. object is in an undefined state and must not be used.
  19277. </para>
  19278. <para>
  19279. If any of the configuration properties are modified then
  19280. <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> must be called again.
  19281. </para>
  19282. <para>
  19283. This method must be implemented by the subclass.
  19284. </para>
  19285. </remarks>
  19286. </member>
  19287. <member name="M:log4net.Layout.LayoutSkeleton.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19288. <summary>
  19289. Implement this method to create your own layout format.
  19290. </summary>
  19291. <param name="writer">The TextWriter to write the formatted event to</param>
  19292. <param name="loggingEvent">The event to format</param>
  19293. <remarks>
  19294. <para>
  19295. This method is called by an appender to format
  19296. the <paramref name="loggingEvent"/> as text.
  19297. </para>
  19298. </remarks>
  19299. </member>
  19300. <member name="M:log4net.Layout.LayoutSkeleton.Format(log4net.Core.LoggingEvent)">
  19301. <summary>
  19302. Convenience method for easily formatting the logging event into a string variable.
  19303. </summary>
  19304. <param name="loggingEvent"></param>
  19305. <remarks>
  19306. Creates a new StringWriter instance to store the formatted logging event.
  19307. </remarks>
  19308. </member>
  19309. <member name="P:log4net.Layout.LayoutSkeleton.ContentType">
  19310. <summary>
  19311. The content type output by this layout.
  19312. </summary>
  19313. <value>The content type is <c>"text/plain"</c></value>
  19314. <remarks>
  19315. <para>
  19316. The content type output by this layout.
  19317. </para>
  19318. <para>
  19319. This base class uses the value <c>"text/plain"</c>.
  19320. To change this value a subclass must override this
  19321. property.
  19322. </para>
  19323. </remarks>
  19324. </member>
  19325. <member name="P:log4net.Layout.LayoutSkeleton.Header">
  19326. <summary>
  19327. The header for the layout format.
  19328. </summary>
  19329. <value>the layout header</value>
  19330. <remarks>
  19331. <para>
  19332. The Header text will be appended before any logging events
  19333. are formatted and appended.
  19334. </para>
  19335. </remarks>
  19336. </member>
  19337. <member name="P:log4net.Layout.LayoutSkeleton.Footer">
  19338. <summary>
  19339. The footer for the layout format.
  19340. </summary>
  19341. <value>the layout footer</value>
  19342. <remarks>
  19343. <para>
  19344. The Footer text will be appended after all the logging events
  19345. have been formatted and appended.
  19346. </para>
  19347. </remarks>
  19348. </member>
  19349. <member name="P:log4net.Layout.LayoutSkeleton.IgnoresException">
  19350. <summary>
  19351. Flag indicating if this layout handles exceptions
  19352. </summary>
  19353. <value><c>false</c> if this layout handles exceptions</value>
  19354. <remarks>
  19355. <para>
  19356. If this layout handles the exception object contained within
  19357. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  19358. <c>false</c>. Otherwise, if the layout ignores the exception
  19359. object, then the layout should return <c>true</c>.
  19360. </para>
  19361. <para>
  19362. Set this value to override a this default setting. The default
  19363. value is <c>true</c>, this layout does not handle the exception.
  19364. </para>
  19365. </remarks>
  19366. </member>
  19367. <member name="F:log4net.Layout.PatternLayout.DefaultConversionPattern">
  19368. <summary>
  19369. Default pattern string for log output.
  19370. </summary>
  19371. <remarks>
  19372. <para>
  19373. Default pattern string for log output.
  19374. Currently set to the string <b>"%message%newline"</b>
  19375. which just prints the application supplied message.
  19376. </para>
  19377. </remarks>
  19378. </member>
  19379. <member name="F:log4net.Layout.PatternLayout.DetailConversionPattern">
  19380. <summary>
  19381. A detailed conversion pattern
  19382. </summary>
  19383. <remarks>
  19384. <para>
  19385. A conversion pattern which includes Time, Thread, Logger, and Nested Context.
  19386. Current value is <b>%timestamp [%thread] %level %logger %ndc - %message%newline</b>.
  19387. </para>
  19388. </remarks>
  19389. </member>
  19390. <member name="F:log4net.Layout.PatternLayout.s_globalRulesRegistry">
  19391. <summary>
  19392. Internal map of converter identifiers to converter types.
  19393. </summary>
  19394. <remarks>
  19395. <para>
  19396. This static map is overridden by the m_converterRegistry instance map
  19397. </para>
  19398. </remarks>
  19399. </member>
  19400. <member name="F:log4net.Layout.PatternLayout.m_pattern">
  19401. <summary>
  19402. the pattern
  19403. </summary>
  19404. </member>
  19405. <member name="F:log4net.Layout.PatternLayout.m_head">
  19406. <summary>
  19407. the head of the pattern converter chain
  19408. </summary>
  19409. </member>
  19410. <member name="F:log4net.Layout.PatternLayout.m_instanceRulesRegistry">
  19411. <summary>
  19412. patterns defined on this PatternLayout only
  19413. </summary>
  19414. </member>
  19415. <member name="M:log4net.Layout.PatternLayout.#cctor">
  19416. <summary>
  19417. Initialize the global registry
  19418. </summary>
  19419. <remarks>
  19420. <para>
  19421. Defines the builtin global rules.
  19422. </para>
  19423. </remarks>
  19424. </member>
  19425. <member name="M:log4net.Layout.PatternLayout.#ctor">
  19426. <summary>
  19427. Constructs a PatternLayout using the DefaultConversionPattern
  19428. </summary>
  19429. <remarks>
  19430. <para>
  19431. The default pattern just produces the application supplied message.
  19432. </para>
  19433. <para>
  19434. Note to Inheritors: This constructor calls the virtual method
  19435. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  19436. aware that it will be called before your is called constructor.
  19437. </para>
  19438. <para>
  19439. As per the <see cref="T:log4net.Core.IOptionHandler"/> contract the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>
  19440. method must be called after the properties on this object have been
  19441. configured.
  19442. </para>
  19443. </remarks>
  19444. </member>
  19445. <member name="M:log4net.Layout.PatternLayout.#ctor(System.String)">
  19446. <summary>
  19447. Constructs a PatternLayout using the supplied conversion pattern
  19448. </summary>
  19449. <param name="pattern">the pattern to use</param>
  19450. <remarks>
  19451. <para>
  19452. Note to Inheritors: This constructor calls the virtual method
  19453. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  19454. aware that it will be called before your is called constructor.
  19455. </para>
  19456. <para>
  19457. When using this constructor the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method
  19458. need not be called. This may not be the case when using a subclass.
  19459. </para>
  19460. </remarks>
  19461. </member>
  19462. <member name="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)">
  19463. <summary>
  19464. Create the pattern parser instance
  19465. </summary>
  19466. <param name="pattern">the pattern to parse</param>
  19467. <returns>The <see cref="T:log4net.Util.PatternParser"/> that will format the event</returns>
  19468. <remarks>
  19469. <para>
  19470. Creates the <see cref="T:log4net.Util.PatternParser"/> used to parse the conversion string. Sets the
  19471. global and instance rules on the <see cref="T:log4net.Util.PatternParser"/>.
  19472. </para>
  19473. </remarks>
  19474. </member>
  19475. <member name="M:log4net.Layout.PatternLayout.ActivateOptions">
  19476. <summary>
  19477. Initialize layout options
  19478. </summary>
  19479. <remarks>
  19480. <para>
  19481. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19482. activation scheme. The <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method must
  19483. be called on this object after the configuration properties have
  19484. been set. Until <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> is called this
  19485. object is in an undefined state and must not be used.
  19486. </para>
  19487. <para>
  19488. If any of the configuration properties are modified then
  19489. <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> must be called again.
  19490. </para>
  19491. </remarks>
  19492. </member>
  19493. <member name="M:log4net.Layout.PatternLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19494. <summary>
  19495. Produces a formatted string as specified by the conversion pattern.
  19496. </summary>
  19497. <param name="loggingEvent">the event being logged</param>
  19498. <param name="writer">The TextWriter to write the formatted event to</param>
  19499. <remarks>
  19500. <para>
  19501. Parse the <see cref="T:log4net.Core.LoggingEvent"/> using the patter format
  19502. specified in the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/> property.
  19503. </para>
  19504. </remarks>
  19505. </member>
  19506. <member name="M:log4net.Layout.PatternLayout.AddConverter(log4net.Util.ConverterInfo)">
  19507. <summary>
  19508. Add a converter to this PatternLayout
  19509. </summary>
  19510. <param name="converterInfo">the converter info</param>
  19511. <remarks>
  19512. <para>
  19513. This version of the method is used by the configurator.
  19514. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  19515. </para>
  19516. </remarks>
  19517. </member>
  19518. <member name="M:log4net.Layout.PatternLayout.AddConverter(System.String,System.Type)">
  19519. <summary>
  19520. Add a converter to this PatternLayout
  19521. </summary>
  19522. <param name="name">the name of the conversion pattern for this converter</param>
  19523. <param name="type">the type of the converter</param>
  19524. <remarks>
  19525. <para>
  19526. Add a named pattern converter to this instance. This
  19527. converter will be used in the formatting of the event.
  19528. This method must be called before <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>.
  19529. </para>
  19530. <para>
  19531. The <paramref name="type"/> specified must extend the
  19532. <see cref="T:log4net.Util.PatternConverter"/> type.
  19533. </para>
  19534. </remarks>
  19535. </member>
  19536. <member name="P:log4net.Layout.PatternLayout.ConversionPattern">
  19537. <summary>
  19538. The pattern formatting string
  19539. </summary>
  19540. <remarks>
  19541. <para>
  19542. The <b>ConversionPattern</b> option. This is the string which
  19543. controls formatting and consists of a mix of literal content and
  19544. conversion specifiers.
  19545. </para>
  19546. </remarks>
  19547. </member>
  19548. <member name="F:log4net.Layout.DynamicPatternLayout.m_headerPatternString">
  19549. <summary>
  19550. The header PatternString
  19551. </summary>
  19552. </member>
  19553. <member name="F:log4net.Layout.DynamicPatternLayout.m_footerPatternString">
  19554. <summary>
  19555. The footer PatternString
  19556. </summary>
  19557. </member>
  19558. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor">
  19559. <summary>
  19560. Constructs a DynamicPatternLayout using the DefaultConversionPattern
  19561. </summary>
  19562. <remarks>
  19563. <para>
  19564. The default pattern just produces the application supplied message.
  19565. </para>
  19566. </remarks>
  19567. </member>
  19568. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor(System.String)">
  19569. <summary>
  19570. Constructs a DynamicPatternLayout using the supplied conversion pattern
  19571. </summary>
  19572. <param name="pattern">the pattern to use</param>
  19573. <remarks>
  19574. </remarks>
  19575. </member>
  19576. <member name="P:log4net.Layout.DynamicPatternLayout.Header">
  19577. <summary>
  19578. The header for the layout format.
  19579. </summary>
  19580. <value>the layout header</value>
  19581. <remarks>
  19582. <para>
  19583. The Header text will be appended before any logging events
  19584. are formatted and appended.
  19585. </para>
  19586. The pattern will be formatted on each get operation.
  19587. </remarks>
  19588. </member>
  19589. <member name="P:log4net.Layout.DynamicPatternLayout.Footer">
  19590. <summary>
  19591. The footer for the layout format.
  19592. </summary>
  19593. <value>the layout footer</value>
  19594. <remarks>
  19595. <para>
  19596. The Footer text will be appended after all the logging events
  19597. have been formatted and appended.
  19598. </para>
  19599. The pattern will be formatted on each get operation.
  19600. </remarks>
  19601. </member>
  19602. <member name="T:log4net.Layout.ExceptionLayout">
  19603. <summary>
  19604. A Layout that renders only the Exception text from the logging event
  19605. </summary>
  19606. <remarks>
  19607. <para>
  19608. A Layout that renders only the Exception text from the logging event.
  19609. </para>
  19610. <para>
  19611. This Layout should only be used with appenders that utilize multiple
  19612. layouts (e.g. <see cref="T:log4net.Appender.AdoNetAppender"/>).
  19613. </para>
  19614. </remarks>
  19615. <author>Nicko Cadell</author>
  19616. <author>Gert Driesen</author>
  19617. </member>
  19618. <member name="M:log4net.Layout.ExceptionLayout.#ctor">
  19619. <summary>
  19620. Default constructor
  19621. </summary>
  19622. <remarks>
  19623. <para>
  19624. Constructs a ExceptionLayout
  19625. </para>
  19626. </remarks>
  19627. </member>
  19628. <member name="M:log4net.Layout.ExceptionLayout.ActivateOptions">
  19629. <summary>
  19630. Activate component options
  19631. </summary>
  19632. <remarks>
  19633. <para>
  19634. Part of the <see cref="T:log4net.Core.IOptionHandler"/> component activation
  19635. framework.
  19636. </para>
  19637. <para>
  19638. This method does nothing as options become effective immediately.
  19639. </para>
  19640. </remarks>
  19641. </member>
  19642. <member name="M:log4net.Layout.ExceptionLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19643. <summary>
  19644. Gets the exception text from the logging event
  19645. </summary>
  19646. <param name="writer">The TextWriter to write the formatted event to</param>
  19647. <param name="loggingEvent">the event being logged</param>
  19648. <remarks>
  19649. <para>
  19650. Write the exception string to the <see cref="T:System.IO.TextWriter"/>.
  19651. The exception string is retrieved from <see cref="M:LoggingEvent.GetExceptionString()"/>.
  19652. </para>
  19653. </remarks>
  19654. </member>
  19655. <member name="T:log4net.Layout.IRawLayout">
  19656. <summary>
  19657. Interface for raw layout objects
  19658. </summary>
  19659. <remarks>
  19660. <para>
  19661. Interface used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  19662. to an object.
  19663. </para>
  19664. <para>
  19665. This interface should not be confused with the
  19666. <see cref="T:log4net.Layout.ILayout"/> interface. This interface is used in
  19667. only certain specialized situations where a raw object is
  19668. required rather than a formatted string. The <see cref="T:log4net.Layout.ILayout"/>
  19669. is not generally useful than this interface.
  19670. </para>
  19671. </remarks>
  19672. <author>Nicko Cadell</author>
  19673. <author>Gert Driesen</author>
  19674. </member>
  19675. <member name="M:log4net.Layout.IRawLayout.Format(log4net.Core.LoggingEvent)">
  19676. <summary>
  19677. Implement this method to create your own layout format.
  19678. </summary>
  19679. <param name="loggingEvent">The event to format</param>
  19680. <returns>returns the formatted event</returns>
  19681. <remarks>
  19682. <para>
  19683. Implement this method to create your own layout format.
  19684. </para>
  19685. </remarks>
  19686. </member>
  19687. <member name="T:log4net.Layout.Layout2RawLayoutAdapter">
  19688. <summary>
  19689. Adapts any <see cref="T:log4net.Layout.ILayout"/> to a <see cref="T:log4net.Layout.IRawLayout"/>
  19690. </summary>
  19691. <remarks>
  19692. <para>
  19693. Where an <see cref="T:log4net.Layout.IRawLayout"/> is required this adapter
  19694. allows a <see cref="T:log4net.Layout.ILayout"/> to be specified.
  19695. </para>
  19696. </remarks>
  19697. <author>Nicko Cadell</author>
  19698. <author>Gert Driesen</author>
  19699. </member>
  19700. <member name="F:log4net.Layout.Layout2RawLayoutAdapter.m_layout">
  19701. <summary>
  19702. The layout to adapt
  19703. </summary>
  19704. </member>
  19705. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.#ctor(log4net.Layout.ILayout)">
  19706. <summary>
  19707. Construct a new adapter
  19708. </summary>
  19709. <param name="layout">the layout to adapt</param>
  19710. <remarks>
  19711. <para>
  19712. Create the adapter for the specified <paramref name="layout"/>.
  19713. </para>
  19714. </remarks>
  19715. </member>
  19716. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.Format(log4net.Core.LoggingEvent)">
  19717. <summary>
  19718. Format the logging event as an object.
  19719. </summary>
  19720. <param name="loggingEvent">The event to format</param>
  19721. <returns>returns the formatted event</returns>
  19722. <remarks>
  19723. <para>
  19724. Format the logging event as an object.
  19725. </para>
  19726. <para>
  19727. Uses the <see cref="T:log4net.Layout.ILayout"/> object supplied to
  19728. the constructor to perform the formatting.
  19729. </para>
  19730. </remarks>
  19731. </member>
  19732. <member name="T:log4net.Layout.RawLayoutConverter">
  19733. <summary>
  19734. Type converter for the <see cref="T:log4net.Layout.IRawLayout"/> interface
  19735. </summary>
  19736. <remarks>
  19737. <para>
  19738. Used to convert objects to the <see cref="T:log4net.Layout.IRawLayout"/> interface.
  19739. Supports converting from the <see cref="T:log4net.Layout.ILayout"/> interface to
  19740. the <see cref="T:log4net.Layout.IRawLayout"/> interface using the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>.
  19741. </para>
  19742. </remarks>
  19743. <author>Nicko Cadell</author>
  19744. <author>Gert Driesen</author>
  19745. </member>
  19746. <member name="T:log4net.Util.TypeConverters.IConvertFrom">
  19747. <summary>
  19748. Interface supported by type converters
  19749. </summary>
  19750. <remarks>
  19751. <para>
  19752. This interface supports conversion from arbitrary types
  19753. to a single target type. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  19754. </para>
  19755. </remarks>
  19756. <author>Nicko Cadell</author>
  19757. <author>Gert Driesen</author>
  19758. </member>
  19759. <member name="M:log4net.Util.TypeConverters.IConvertFrom.CanConvertFrom(System.Type)">
  19760. <summary>
  19761. Can the source type be converted to the type supported by this object
  19762. </summary>
  19763. <param name="sourceType">the type to convert</param>
  19764. <returns>true if the conversion is possible</returns>
  19765. <remarks>
  19766. <para>
  19767. Test if the <paramref name="sourceType"/> can be converted to the
  19768. type supported by this converter.
  19769. </para>
  19770. </remarks>
  19771. </member>
  19772. <member name="M:log4net.Util.TypeConverters.IConvertFrom.ConvertFrom(System.Object)">
  19773. <summary>
  19774. Convert the source object to the type supported by this object
  19775. </summary>
  19776. <param name="source">the object to convert</param>
  19777. <returns>the converted object</returns>
  19778. <remarks>
  19779. <para>
  19780. Converts the <paramref name="source"/> to the type supported
  19781. by this converter.
  19782. </para>
  19783. </remarks>
  19784. </member>
  19785. <member name="M:log4net.Layout.RawLayoutConverter.CanConvertFrom(System.Type)">
  19786. <summary>
  19787. Can the sourceType be converted to an <see cref="T:log4net.Layout.IRawLayout"/>
  19788. </summary>
  19789. <param name="sourceType">the source to be to be converted</param>
  19790. <returns><c>true</c> if the source type can be converted to <see cref="T:log4net.Layout.IRawLayout"/></returns>
  19791. <remarks>
  19792. <para>
  19793. Test if the <paramref name="sourceType"/> can be converted to a
  19794. <see cref="T:log4net.Layout.IRawLayout"/>. Only <see cref="T:log4net.Layout.ILayout"/> is supported
  19795. as the <paramref name="sourceType"/>.
  19796. </para>
  19797. </remarks>
  19798. </member>
  19799. <member name="M:log4net.Layout.RawLayoutConverter.ConvertFrom(System.Object)">
  19800. <summary>
  19801. Convert the value to a <see cref="T:log4net.Layout.IRawLayout"/> object
  19802. </summary>
  19803. <param name="source">the value to convert</param>
  19804. <returns>the <see cref="T:log4net.Layout.IRawLayout"/> object</returns>
  19805. <remarks>
  19806. <para>
  19807. Convert the <paramref name="source"/> object to a
  19808. <see cref="T:log4net.Layout.IRawLayout"/> object. If the <paramref name="source"/> object
  19809. is a <see cref="T:log4net.Layout.ILayout"/> then the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>
  19810. is used to adapt between the two interfaces, otherwise an
  19811. exception is thrown.
  19812. </para>
  19813. </remarks>
  19814. </member>
  19815. <member name="T:log4net.Layout.RawPropertyLayout">
  19816. <summary>
  19817. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  19818. </summary>
  19819. <remarks>
  19820. <para>
  19821. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  19822. </para>
  19823. </remarks>
  19824. <author>Nicko Cadell</author>
  19825. </member>
  19826. <member name="M:log4net.Layout.RawPropertyLayout.#ctor">
  19827. <summary>
  19828. Constructs a RawPropertyLayout
  19829. </summary>
  19830. </member>
  19831. <member name="M:log4net.Layout.RawPropertyLayout.Format(log4net.Core.LoggingEvent)">
  19832. <summary>
  19833. Lookup the property for <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>
  19834. </summary>
  19835. <param name="loggingEvent">The event to format</param>
  19836. <returns>returns property value</returns>
  19837. <remarks>
  19838. <para>
  19839. Looks up and returns the object value of the property
  19840. named <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>. If there is no property defined
  19841. with than name then <c>null</c> will be returned.
  19842. </para>
  19843. </remarks>
  19844. </member>
  19845. <member name="P:log4net.Layout.RawPropertyLayout.Key">
  19846. <summary>
  19847. The name of the value to lookup in the LoggingEvent Properties collection.
  19848. </summary>
  19849. <value>
  19850. Value to lookup in the LoggingEvent Properties collection
  19851. </value>
  19852. <remarks>
  19853. <para>
  19854. String name of the property to lookup in the <see cref="T:log4net.Core.LoggingEvent"/>.
  19855. </para>
  19856. </remarks>
  19857. </member>
  19858. <member name="T:log4net.Layout.RawTimeStampLayout">
  19859. <summary>
  19860. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19861. </summary>
  19862. <remarks>
  19863. <para>
  19864. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19865. </para>
  19866. </remarks>
  19867. <author>Nicko Cadell</author>
  19868. <author>Gert Driesen</author>
  19869. </member>
  19870. <member name="M:log4net.Layout.RawTimeStampLayout.#ctor">
  19871. <summary>
  19872. Constructs a RawTimeStampLayout
  19873. </summary>
  19874. </member>
  19875. <member name="M:log4net.Layout.RawTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  19876. <summary>
  19877. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19878. </summary>
  19879. <param name="loggingEvent">The event to format</param>
  19880. <returns>returns the time stamp</returns>
  19881. <remarks>
  19882. <para>
  19883. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19884. </para>
  19885. <para>
  19886. The time stamp is in local time. To format the time stamp
  19887. in universal time use <see cref="T:log4net.Layout.RawUtcTimeStampLayout"/>.
  19888. </para>
  19889. </remarks>
  19890. </member>
  19891. <member name="T:log4net.Layout.RawUtcTimeStampLayout">
  19892. <summary>
  19893. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19894. </summary>
  19895. <remarks>
  19896. <para>
  19897. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19898. </para>
  19899. </remarks>
  19900. <author>Nicko Cadell</author>
  19901. <author>Gert Driesen</author>
  19902. </member>
  19903. <member name="M:log4net.Layout.RawUtcTimeStampLayout.#ctor">
  19904. <summary>
  19905. Constructs a RawUtcTimeStampLayout
  19906. </summary>
  19907. </member>
  19908. <member name="M:log4net.Layout.RawUtcTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  19909. <summary>
  19910. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19911. </summary>
  19912. <param name="loggingEvent">The event to format</param>
  19913. <returns>returns the time stamp</returns>
  19914. <remarks>
  19915. <para>
  19916. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19917. </para>
  19918. <para>
  19919. The time stamp is in universal time. To format the time stamp
  19920. in local time use <see cref="T:log4net.Layout.RawTimeStampLayout"/>.
  19921. </para>
  19922. </remarks>
  19923. </member>
  19924. <member name="T:log4net.Layout.SimpleLayout">
  19925. <summary>
  19926. A very simple layout
  19927. </summary>
  19928. <remarks>
  19929. <para>
  19930. SimpleLayout consists of the level of the log statement,
  19931. followed by " - " and then the log message itself. For example,
  19932. <code>
  19933. DEBUG - Hello world
  19934. </code>
  19935. </para>
  19936. </remarks>
  19937. <author>Nicko Cadell</author>
  19938. <author>Gert Driesen</author>
  19939. </member>
  19940. <member name="M:log4net.Layout.SimpleLayout.#ctor">
  19941. <summary>
  19942. Constructs a SimpleLayout
  19943. </summary>
  19944. </member>
  19945. <member name="M:log4net.Layout.SimpleLayout.ActivateOptions">
  19946. <summary>
  19947. Initialize layout options
  19948. </summary>
  19949. <remarks>
  19950. <para>
  19951. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19952. activation scheme. The <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> method must
  19953. be called on this object after the configuration properties have
  19954. been set. Until <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> is called this
  19955. object is in an undefined state and must not be used.
  19956. </para>
  19957. <para>
  19958. If any of the configuration properties are modified then
  19959. <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> must be called again.
  19960. </para>
  19961. </remarks>
  19962. </member>
  19963. <member name="M:log4net.Layout.SimpleLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19964. <summary>
  19965. Produces a simple formatted output.
  19966. </summary>
  19967. <param name="loggingEvent">the event being logged</param>
  19968. <param name="writer">The TextWriter to write the formatted event to</param>
  19969. <remarks>
  19970. <para>
  19971. Formats the event as the level of the even,
  19972. followed by " - " and then the log message itself. The
  19973. output is terminated by a newline.
  19974. </para>
  19975. </remarks>
  19976. </member>
  19977. <member name="T:log4net.Layout.XmlLayout">
  19978. <summary>
  19979. Layout that formats the log events as XML elements.
  19980. </summary>
  19981. <remarks>
  19982. <para>
  19983. The output of the <see cref="T:log4net.Layout.XmlLayout"/> consists of a series of
  19984. log4net:event elements. It does not output a complete well-formed XML
  19985. file. The output is designed to be included as an <em>external entity</em>
  19986. in a separate file to form a correct XML file.
  19987. </para>
  19988. <para>
  19989. For example, if <c>abc</c> is the name of the file where
  19990. the <see cref="T:log4net.Layout.XmlLayout"/> output goes, then a well-formed XML file would
  19991. be:
  19992. </para>
  19993. <code lang="XML">
  19994. &lt;?xml version="1.0" ?&gt;
  19995. &lt;!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [&lt;!ENTITY data SYSTEM "abc"&gt;]&gt;
  19996. &lt;log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2&gt;
  19997. &amp;data;
  19998. &lt;/log4net:events&gt;
  19999. </code>
  20000. <para>
  20001. This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout"/>
  20002. and the appender where it is embedded.
  20003. </para>
  20004. <para>
  20005. The <c>version</c> attribute helps components to correctly
  20006. interpret output generated by <see cref="T:log4net.Layout.XmlLayout"/>. The value of
  20007. this attribute should be "1.2" for release 1.2 and later.
  20008. </para>
  20009. <para>
  20010. Alternatively the <c>Header</c> and <c>Footer</c> properties can be
  20011. configured to output the correct XML header, open tag and close tag.
  20012. When setting the <c>Header</c> and <c>Footer</c> properties it is essential
  20013. that the underlying data store not be appendable otherwise the data
  20014. will become invalid XML.
  20015. </para>
  20016. </remarks>
  20017. <author>Nicko Cadell</author>
  20018. <author>Gert Driesen</author>
  20019. </member>
  20020. <member name="T:log4net.Layout.XmlLayoutBase">
  20021. <summary>
  20022. Layout that formats the log events as XML elements.
  20023. </summary>
  20024. <remarks>
  20025. <para>
  20026. This is an abstract class that must be subclassed by an implementation
  20027. to conform to a specific schema.
  20028. </para>
  20029. <para>
  20030. Deriving classes must implement the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method.
  20031. </para>
  20032. </remarks>
  20033. <author>Nicko Cadell</author>
  20034. <author>Gert Driesen</author>
  20035. </member>
  20036. <member name="M:log4net.Layout.XmlLayoutBase.#ctor">
  20037. <summary>
  20038. Protected constructor to support subclasses
  20039. </summary>
  20040. <remarks>
  20041. <para>
  20042. Initializes a new instance of the <see cref="T:log4net.Layout.XmlLayoutBase"/> class
  20043. with no location info.
  20044. </para>
  20045. </remarks>
  20046. </member>
  20047. <member name="M:log4net.Layout.XmlLayoutBase.#ctor(System.Boolean)">
  20048. <summary>
  20049. Protected constructor to support subclasses
  20050. </summary>
  20051. <remarks>
  20052. <para>
  20053. The <paramref name="locationInfo" /> parameter determines whether
  20054. location information will be output by the layout. If
  20055. <paramref name="locationInfo" /> is set to <c>true</c>, then the
  20056. file name and line number of the statement at the origin of the log
  20057. statement will be output.
  20058. </para>
  20059. <para>
  20060. If you are embedding this layout within an SMTPAppender
  20061. then make sure to set the <b>LocationInfo</b> option of that
  20062. appender as well.
  20063. </para>
  20064. </remarks>
  20065. </member>
  20066. <member name="M:log4net.Layout.XmlLayoutBase.ActivateOptions">
  20067. <summary>
  20068. Initialize layout options
  20069. </summary>
  20070. <remarks>
  20071. <para>
  20072. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  20073. activation scheme. The <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> method must
  20074. be called on this object after the configuration properties have
  20075. been set. Until <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> is called this
  20076. object is in an undefined state and must not be used.
  20077. </para>
  20078. <para>
  20079. If any of the configuration properties are modified then
  20080. <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> must be called again.
  20081. </para>
  20082. </remarks>
  20083. </member>
  20084. <member name="M:log4net.Layout.XmlLayoutBase.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  20085. <summary>
  20086. Produces a formatted string.
  20087. </summary>
  20088. <param name="loggingEvent">The event being logged.</param>
  20089. <param name="writer">The TextWriter to write the formatted event to</param>
  20090. <remarks>
  20091. <para>
  20092. Format the <see cref="T:log4net.Core.LoggingEvent"/> and write it to the <see cref="T:System.IO.TextWriter"/>.
  20093. </para>
  20094. <para>
  20095. This method creates an <see cref="T:System.Xml.XmlTextWriter"/> that writes to the
  20096. <paramref name="writer"/>. The <see cref="T:System.Xml.XmlTextWriter"/> is passed
  20097. to the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. Subclasses should override the
  20098. <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method rather than this method.
  20099. </para>
  20100. </remarks>
  20101. </member>
  20102. <member name="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  20103. <summary>
  20104. Does the actual writing of the XML.
  20105. </summary>
  20106. <param name="writer">The writer to use to output the event to.</param>
  20107. <param name="loggingEvent">The event to write.</param>
  20108. <remarks>
  20109. <para>
  20110. Subclasses should override this method to format
  20111. the <see cref="T:log4net.Core.LoggingEvent"/> as XML.
  20112. </para>
  20113. </remarks>
  20114. </member>
  20115. <member name="F:log4net.Layout.XmlLayoutBase.m_locationInfo">
  20116. <summary>
  20117. Flag to indicate if location information should be included in
  20118. the XML events.
  20119. </summary>
  20120. </member>
  20121. <member name="F:log4net.Layout.XmlLayoutBase.m_invalidCharReplacement">
  20122. <summary>
  20123. The string to replace invalid chars with
  20124. </summary>
  20125. </member>
  20126. <member name="P:log4net.Layout.XmlLayoutBase.LocationInfo">
  20127. <summary>
  20128. Gets a value indicating whether to include location information in
  20129. the XML events.
  20130. </summary>
  20131. <value>
  20132. <c>true</c> if location information should be included in the XML
  20133. events; otherwise, <c>false</c>.
  20134. </value>
  20135. <remarks>
  20136. <para>
  20137. If <see cref="P:log4net.Layout.XmlLayoutBase.LocationInfo"/> is set to <c>true</c>, then the file
  20138. name and line number of the statement at the origin of the log
  20139. statement will be output.
  20140. </para>
  20141. <para>
  20142. If you are embedding this layout within an <c>SMTPAppender</c>
  20143. then make sure to set the <b>LocationInfo</b> option of that
  20144. appender as well.
  20145. </para>
  20146. </remarks>
  20147. </member>
  20148. <member name="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement">
  20149. <summary>
  20150. The string to replace characters that can not be expressed in XML with.
  20151. <remarks>
  20152. <para>
  20153. Not all characters may be expressed in XML. This property contains the
  20154. string to replace those that can not with. This defaults to a ?. Set it
  20155. to the empty string to simply remove offending characters. For more
  20156. details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets
  20157. Character replacement will occur in the log message, the property names
  20158. and the property values.
  20159. </para>
  20160. </remarks>
  20161. </summary>
  20162. </member>
  20163. <member name="P:log4net.Layout.XmlLayoutBase.ContentType">
  20164. <summary>
  20165. Gets the content type output by this layout.
  20166. </summary>
  20167. <value>
  20168. As this is the XML layout, the value is always <c>"text/xml"</c>.
  20169. </value>
  20170. <remarks>
  20171. <para>
  20172. As this is the XML layout, the value is always <c>"text/xml"</c>.
  20173. </para>
  20174. </remarks>
  20175. </member>
  20176. <member name="M:log4net.Layout.XmlLayout.#ctor">
  20177. <summary>
  20178. Constructs an XmlLayout
  20179. </summary>
  20180. </member>
  20181. <member name="M:log4net.Layout.XmlLayout.#ctor(System.Boolean)">
  20182. <summary>
  20183. Constructs an XmlLayout.
  20184. </summary>
  20185. <remarks>
  20186. <para>
  20187. The <b>LocationInfo</b> option takes a boolean value. By
  20188. default, it is set to false which means there will be no location
  20189. information output by this layout. If the the option is set to
  20190. true, then the file name and line number of the statement
  20191. at the origin of the log statement will be output.
  20192. </para>
  20193. <para>
  20194. If you are embedding this layout within an SmtpAppender
  20195. then make sure to set the <b>LocationInfo</b> option of that
  20196. appender as well.
  20197. </para>
  20198. </remarks>
  20199. </member>
  20200. <member name="M:log4net.Layout.XmlLayout.ActivateOptions">
  20201. <summary>
  20202. Initialize layout options
  20203. </summary>
  20204. <remarks>
  20205. <para>
  20206. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  20207. activation scheme. The <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> method must
  20208. be called on this object after the configuration properties have
  20209. been set. Until <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> is called this
  20210. object is in an undefined state and must not be used.
  20211. </para>
  20212. <para>
  20213. If any of the configuration properties are modified then
  20214. <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> must be called again.
  20215. </para>
  20216. <para>
  20217. Builds a cache of the element names
  20218. </para>
  20219. </remarks>
  20220. </member>
  20221. <member name="M:log4net.Layout.XmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  20222. <summary>
  20223. Does the actual writing of the XML.
  20224. </summary>
  20225. <param name="writer">The writer to use to output the event to.</param>
  20226. <param name="loggingEvent">The event to write.</param>
  20227. <remarks>
  20228. <para>
  20229. Override the base class <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method
  20230. to write the <see cref="T:log4net.Core.LoggingEvent"/> to the <see cref="T:System.Xml.XmlWriter"/>.
  20231. </para>
  20232. </remarks>
  20233. </member>
  20234. <member name="F:log4net.Layout.XmlLayout.m_prefix">
  20235. <summary>
  20236. The prefix to use for all generated element names
  20237. </summary>
  20238. </member>
  20239. <member name="P:log4net.Layout.XmlLayout.Prefix">
  20240. <summary>
  20241. The prefix to use for all element names
  20242. </summary>
  20243. <remarks>
  20244. <para>
  20245. The default prefix is <b>log4net</b>. Set this property
  20246. to change the prefix. If the prefix is set to an empty string
  20247. then no prefix will be written.
  20248. </para>
  20249. </remarks>
  20250. </member>
  20251. <member name="P:log4net.Layout.XmlLayout.Base64EncodeMessage">
  20252. <summary>
  20253. Set whether or not to base64 encode the message.
  20254. </summary>
  20255. <remarks>
  20256. <para>
  20257. By default the log message will be written as text to the xml
  20258. output. This can cause problems when the message contains binary
  20259. data. By setting this to true the contents of the message will be
  20260. base64 encoded. If this is set then invalid character replacement
  20261. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  20262. on the log message.
  20263. </para>
  20264. </remarks>
  20265. </member>
  20266. <member name="P:log4net.Layout.XmlLayout.Base64EncodeProperties">
  20267. <summary>
  20268. Set whether or not to base64 encode the property values.
  20269. </summary>
  20270. <remarks>
  20271. <para>
  20272. By default the properties will be written as text to the xml
  20273. output. This can cause problems when one or more properties contain
  20274. binary data. By setting this to true the values of the properties
  20275. will be base64 encoded. If this is set then invalid character replacement
  20276. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  20277. on the property values.
  20278. </para>
  20279. </remarks>
  20280. </member>
  20281. <member name="T:log4net.Layout.XmlLayoutSchemaLog4j">
  20282. <summary>
  20283. Layout that formats the log events as XML elements compatible with the log4j schema
  20284. </summary>
  20285. <remarks>
  20286. <para>
  20287. Formats the log events according to the http://logging.apache.org/log4j schema.
  20288. </para>
  20289. </remarks>
  20290. <author>Nicko Cadell</author>
  20291. </member>
  20292. <member name="F:log4net.Layout.XmlLayoutSchemaLog4j.s_date1970">
  20293. <summary>
  20294. The 1st of January 1970 in UTC
  20295. </summary>
  20296. </member>
  20297. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor">
  20298. <summary>
  20299. Constructs an XMLLayoutSchemaLog4j
  20300. </summary>
  20301. </member>
  20302. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor(System.Boolean)">
  20303. <summary>
  20304. Constructs an XMLLayoutSchemaLog4j.
  20305. </summary>
  20306. <remarks>
  20307. <para>
  20308. The <b>LocationInfo</b> option takes a boolean value. By
  20309. default, it is set to false which means there will be no location
  20310. information output by this layout. If the the option is set to
  20311. true, then the file name and line number of the statement
  20312. at the origin of the log statement will be output.
  20313. </para>
  20314. <para>
  20315. If you are embedding this layout within an SMTPAppender
  20316. then make sure to set the <b>LocationInfo</b> option of that
  20317. appender as well.
  20318. </para>
  20319. </remarks>
  20320. </member>
  20321. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  20322. <summary>
  20323. Actually do the writing of the xml
  20324. </summary>
  20325. <param name="writer">the writer to use</param>
  20326. <param name="loggingEvent">the event to write</param>
  20327. <remarks>
  20328. <para>
  20329. Generate XML that is compatible with the log4j schema.
  20330. </para>
  20331. </remarks>
  20332. </member>
  20333. <member name="P:log4net.Layout.XmlLayoutSchemaLog4j.Version">
  20334. <summary>
  20335. The version of the log4j schema to use.
  20336. </summary>
  20337. <remarks>
  20338. <para>
  20339. Only version 1.2 of the log4j schema is supported.
  20340. </para>
  20341. </remarks>
  20342. </member>
  20343. <member name="T:log4net.ObjectRenderer.DefaultRenderer">
  20344. <summary>
  20345. The default object Renderer.
  20346. </summary>
  20347. <remarks>
  20348. <para>
  20349. The default renderer supports rendering objects and collections to strings.
  20350. </para>
  20351. <para>
  20352. See the <see cref="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"/> method for details of the output.
  20353. </para>
  20354. </remarks>
  20355. <author>Nicko Cadell</author>
  20356. <author>Gert Driesen</author>
  20357. </member>
  20358. <member name="T:log4net.ObjectRenderer.IObjectRenderer">
  20359. <summary>
  20360. Implement this interface in order to render objects as strings
  20361. </summary>
  20362. <remarks>
  20363. <para>
  20364. Certain types require special case conversion to
  20365. string form. This conversion is done by an object renderer.
  20366. Object renderers implement the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>
  20367. interface.
  20368. </para>
  20369. </remarks>
  20370. <author>Nicko Cadell</author>
  20371. <author>Gert Driesen</author>
  20372. </member>
  20373. <member name="M:log4net.ObjectRenderer.IObjectRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  20374. <summary>
  20375. Render the object <paramref name="obj"/> to a string
  20376. </summary>
  20377. <param name="rendererMap">The map used to lookup renderers</param>
  20378. <param name="obj">The object to render</param>
  20379. <param name="writer">The writer to render to</param>
  20380. <remarks>
  20381. <para>
  20382. Render the object <paramref name="obj"/> to a
  20383. string.
  20384. </para>
  20385. <para>
  20386. The <paramref name="rendererMap"/> parameter is
  20387. provided to lookup and render other objects. This is
  20388. very useful where <paramref name="obj"/> contains
  20389. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object, TextWriter)"/>
  20390. method can be used to render these objects.
  20391. </para>
  20392. </remarks>
  20393. </member>
  20394. <member name="M:log4net.ObjectRenderer.DefaultRenderer.#ctor">
  20395. <summary>
  20396. Default constructor
  20397. </summary>
  20398. <remarks>
  20399. <para>
  20400. Default constructor
  20401. </para>
  20402. </remarks>
  20403. </member>
  20404. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  20405. <summary>
  20406. Render the object <paramref name="obj"/> to a string
  20407. </summary>
  20408. <param name="rendererMap">The map used to lookup renderers</param>
  20409. <param name="obj">The object to render</param>
  20410. <param name="writer">The writer to render to</param>
  20411. <remarks>
  20412. <para>
  20413. Render the object <paramref name="obj"/> to a string.
  20414. </para>
  20415. <para>
  20416. The <paramref name="rendererMap"/> parameter is
  20417. provided to lookup and render other objects. This is
  20418. very useful where <paramref name="obj"/> contains
  20419. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object)"/>
  20420. method can be used to render these objects.
  20421. </para>
  20422. <para>
  20423. The default renderer supports rendering objects to strings as follows:
  20424. </para>
  20425. <list type="table">
  20426. <listheader>
  20427. <term>Value</term>
  20428. <description>Rendered String</description>
  20429. </listheader>
  20430. <item>
  20431. <term><c>null</c></term>
  20432. <description>
  20433. <para>"(null)"</para>
  20434. </description>
  20435. </item>
  20436. <item>
  20437. <term><see cref="T:System.Array"/></term>
  20438. <description>
  20439. <para>
  20440. For a one dimensional array this is the
  20441. array type name, an open brace, followed by a comma
  20442. separated list of the elements (using the appropriate
  20443. renderer), followed by a close brace.
  20444. </para>
  20445. <para>
  20446. For example: <c>int[] {1, 2, 3}</c>.
  20447. </para>
  20448. <para>
  20449. If the array is not one dimensional the
  20450. <c>Array.ToString()</c> is returned.
  20451. </para>
  20452. </description>
  20453. </item>
  20454. <item>
  20455. <term><see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> &amp; <see cref="T:System.Collections.IEnumerator"/></term>
  20456. <description>
  20457. <para>
  20458. Rendered as an open brace, followed by a comma
  20459. separated list of the elements (using the appropriate
  20460. renderer), followed by a close brace.
  20461. </para>
  20462. <para>
  20463. For example: <c>{a, b, c}</c>.
  20464. </para>
  20465. <para>
  20466. All collection classes that implement <see cref="T:System.Collections.ICollection"/> its subclasses,
  20467. or generic equivalents all implement the <see cref="T:System.Collections.IEnumerable"/> interface.
  20468. </para>
  20469. </description>
  20470. </item>
  20471. <item>
  20472. <term><see cref="T:System.Collections.DictionaryEntry"/></term>
  20473. <description>
  20474. <para>
  20475. Rendered as the key, an equals sign ('='), and the value (using the appropriate
  20476. renderer).
  20477. </para>
  20478. <para>
  20479. For example: <c>key=value</c>.
  20480. </para>
  20481. </description>
  20482. </item>
  20483. <item>
  20484. <term>other</term>
  20485. <description>
  20486. <para><c>Object.ToString()</c></para>
  20487. </description>
  20488. </item>
  20489. </list>
  20490. </remarks>
  20491. </member>
  20492. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderArray(log4net.ObjectRenderer.RendererMap,System.Array,System.IO.TextWriter)">
  20493. <summary>
  20494. Render the array argument into a string
  20495. </summary>
  20496. <param name="rendererMap">The map used to lookup renderers</param>
  20497. <param name="array">the array to render</param>
  20498. <param name="writer">The writer to render to</param>
  20499. <remarks>
  20500. <para>
  20501. For a one dimensional array this is the
  20502. array type name, an open brace, followed by a comma
  20503. separated list of the elements (using the appropriate
  20504. renderer), followed by a close brace. For example:
  20505. <c>int[] {1, 2, 3}</c>.
  20506. </para>
  20507. <para>
  20508. If the array is not one dimensional the
  20509. <c>Array.ToString()</c> is returned.
  20510. </para>
  20511. </remarks>
  20512. </member>
  20513. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderEnumerator(log4net.ObjectRenderer.RendererMap,System.Collections.IEnumerator,System.IO.TextWriter)">
  20514. <summary>
  20515. Render the enumerator argument into a string
  20516. </summary>
  20517. <param name="rendererMap">The map used to lookup renderers</param>
  20518. <param name="enumerator">the enumerator to render</param>
  20519. <param name="writer">The writer to render to</param>
  20520. <remarks>
  20521. <para>
  20522. Rendered as an open brace, followed by a comma
  20523. separated list of the elements (using the appropriate
  20524. renderer), followed by a close brace. For example:
  20525. <c>{a, b, c}</c>.
  20526. </para>
  20527. </remarks>
  20528. </member>
  20529. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderDictionaryEntry(log4net.ObjectRenderer.RendererMap,System.Collections.DictionaryEntry,System.IO.TextWriter)">
  20530. <summary>
  20531. Render the DictionaryEntry argument into a string
  20532. </summary>
  20533. <param name="rendererMap">The map used to lookup renderers</param>
  20534. <param name="entry">the DictionaryEntry to render</param>
  20535. <param name="writer">The writer to render to</param>
  20536. <remarks>
  20537. <para>
  20538. Render the key, an equals sign ('='), and the value (using the appropriate
  20539. renderer). For example: <c>key=value</c>.
  20540. </para>
  20541. </remarks>
  20542. </member>
  20543. <member name="T:log4net.ObjectRenderer.RendererMap">
  20544. <summary>
  20545. Map class objects to an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  20546. </summary>
  20547. <remarks>
  20548. <para>
  20549. Maintains a mapping between types that require special
  20550. rendering and the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> that
  20551. is used to render them.
  20552. </para>
  20553. <para>
  20554. The <see cref="M:FindAndRender(object)"/> method is used to render an
  20555. <c>object</c> using the appropriate renderers defined in this map.
  20556. </para>
  20557. </remarks>
  20558. <author>Nicko Cadell</author>
  20559. <author>Gert Driesen</author>
  20560. </member>
  20561. <member name="M:log4net.ObjectRenderer.RendererMap.#ctor">
  20562. <summary>
  20563. Default Constructor
  20564. </summary>
  20565. <remarks>
  20566. <para>
  20567. Default constructor.
  20568. </para>
  20569. </remarks>
  20570. </member>
  20571. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object)">
  20572. <summary>
  20573. Render <paramref name="obj"/> using the appropriate renderer.
  20574. </summary>
  20575. <param name="obj">the object to render to a string</param>
  20576. <returns>the object rendered as a string</returns>
  20577. <remarks>
  20578. <para>
  20579. This is a convenience method used to render an object to a string.
  20580. The alternative method <see cref="M:FindAndRender(object,TextWriter)"/>
  20581. should be used when streaming output to a <see cref="T:System.IO.TextWriter"/>.
  20582. </para>
  20583. </remarks>
  20584. </member>
  20585. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object,System.IO.TextWriter)">
  20586. <summary>
  20587. Render <paramref name="obj"/> using the appropriate renderer.
  20588. </summary>
  20589. <param name="obj">the object to render to a string</param>
  20590. <param name="writer">The writer to render to</param>
  20591. <remarks>
  20592. <para>
  20593. Find the appropriate renderer for the type of the
  20594. <paramref name="obj"/> parameter. This is accomplished by calling the
  20595. <see cref="M:Get(Type)"/> method. Once a renderer is found, it is
  20596. applied on the object <paramref name="obj"/> and the result is returned
  20597. as a <see cref="T:System.String"/>.
  20598. </para>
  20599. </remarks>
  20600. </member>
  20601. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Object)">
  20602. <summary>
  20603. Gets the renderer for the specified object type
  20604. </summary>
  20605. <param name="obj">the object to lookup the renderer for</param>
  20606. <returns>the renderer for <paramref name="obj"/></returns>
  20607. <remarks>
  20608. <param>
  20609. Gets the renderer for the specified object type.
  20610. </param>
  20611. <param>
  20612. Syntactic sugar method that calls <see cref="M:Get(Type)"/>
  20613. with the type of the object parameter.
  20614. </param>
  20615. </remarks>
  20616. </member>
  20617. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Type)">
  20618. <summary>
  20619. Gets the renderer for the specified type
  20620. </summary>
  20621. <param name="type">the type to lookup the renderer for</param>
  20622. <returns>the renderer for the specified type</returns>
  20623. <remarks>
  20624. <para>
  20625. Returns the renderer for the specified type.
  20626. If no specific renderer has been defined the
  20627. <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/> will be returned.
  20628. </para>
  20629. </remarks>
  20630. </member>
  20631. <member name="M:log4net.ObjectRenderer.RendererMap.SearchTypeAndInterfaces(System.Type)">
  20632. <summary>
  20633. Internal function to recursively search interfaces
  20634. </summary>
  20635. <param name="type">the type to lookup the renderer for</param>
  20636. <returns>the renderer for the specified type</returns>
  20637. </member>
  20638. <member name="M:log4net.ObjectRenderer.RendererMap.Clear">
  20639. <summary>
  20640. Clear the map of renderers
  20641. </summary>
  20642. <remarks>
  20643. <para>
  20644. Clear the custom renderers defined by using
  20645. <see cref="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)"/>. The <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/>
  20646. cannot be removed.
  20647. </para>
  20648. </remarks>
  20649. </member>
  20650. <member name="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  20651. <summary>
  20652. Register an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> for <paramref name="typeToRender"/>.
  20653. </summary>
  20654. <param name="typeToRender">the type that will be rendered by <paramref name="renderer"/></param>
  20655. <param name="renderer">the renderer for <paramref name="typeToRender"/></param>
  20656. <remarks>
  20657. <para>
  20658. Register an object renderer for a specific source type.
  20659. This renderer will be returned from a call to <see cref="M:Get(Type)"/>
  20660. specifying the same <paramref name="typeToRender"/> as an argument.
  20661. </para>
  20662. </remarks>
  20663. </member>
  20664. <member name="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer">
  20665. <summary>
  20666. Get the default renderer instance
  20667. </summary>
  20668. <value>the default renderer</value>
  20669. <remarks>
  20670. <para>
  20671. Get the default renderer
  20672. </para>
  20673. </remarks>
  20674. </member>
  20675. <member name="T:log4net.Plugin.IPlugin">
  20676. <summary>
  20677. Interface implemented by logger repository plugins.
  20678. </summary>
  20679. <remarks>
  20680. <para>
  20681. Plugins define additional behavior that can be associated
  20682. with a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  20683. The <see cref="T:log4net.Plugin.PluginMap"/> held by the <see cref="P:log4net.Repository.ILoggerRepository.PluginMap"/>
  20684. property is used to store the plugins for a repository.
  20685. </para>
  20686. <para>
  20687. The <c>log4net.Config.PluginAttribute</c> can be used to
  20688. attach plugins to repositories created using configuration
  20689. attributes.
  20690. </para>
  20691. </remarks>
  20692. <author>Nicko Cadell</author>
  20693. <author>Gert Driesen</author>
  20694. </member>
  20695. <member name="M:log4net.Plugin.IPlugin.Attach(log4net.Repository.ILoggerRepository)">
  20696. <summary>
  20697. Attaches the plugin to the specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  20698. </summary>
  20699. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  20700. <remarks>
  20701. <para>
  20702. A plugin may only be attached to a single repository.
  20703. </para>
  20704. <para>
  20705. This method is called when the plugin is attached to the repository.
  20706. </para>
  20707. </remarks>
  20708. </member>
  20709. <member name="M:log4net.Plugin.IPlugin.Shutdown">
  20710. <summary>
  20711. Is called when the plugin is to shutdown.
  20712. </summary>
  20713. <remarks>
  20714. <para>
  20715. This method is called to notify the plugin that
  20716. it should stop operating and should detach from
  20717. the repository.
  20718. </para>
  20719. </remarks>
  20720. </member>
  20721. <member name="P:log4net.Plugin.IPlugin.Name">
  20722. <summary>
  20723. Gets the name of the plugin.
  20724. </summary>
  20725. <value>
  20726. The name of the plugin.
  20727. </value>
  20728. <remarks>
  20729. <para>
  20730. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  20731. keyed by name. Each plugin instance attached to a
  20732. repository must be a unique name.
  20733. </para>
  20734. </remarks>
  20735. </member>
  20736. <member name="T:log4net.Plugin.PluginCollection">
  20737. <summary>
  20738. A strongly-typed collection of <see cref="T:log4net.Plugin.IPlugin"/> objects.
  20739. </summary>
  20740. <author>Nicko Cadell</author>
  20741. </member>
  20742. <member name="M:log4net.Plugin.PluginCollection.ReadOnly(log4net.Plugin.PluginCollection)">
  20743. <summary>
  20744. Creates a read-only wrapper for a <c>PluginCollection</c> instance.
  20745. </summary>
  20746. <param name="list">list to create a readonly wrapper arround</param>
  20747. <returns>
  20748. A <c>PluginCollection</c> wrapper that is read-only.
  20749. </returns>
  20750. </member>
  20751. <member name="M:log4net.Plugin.PluginCollection.#ctor">
  20752. <summary>
  20753. Initializes a new instance of the <c>PluginCollection</c> class
  20754. that is empty and has the default initial capacity.
  20755. </summary>
  20756. </member>
  20757. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Int32)">
  20758. <summary>
  20759. Initializes a new instance of the <c>PluginCollection</c> class
  20760. that has the specified initial capacity.
  20761. </summary>
  20762. <param name="capacity">
  20763. The number of elements that the new <c>PluginCollection</c> is initially capable of storing.
  20764. </param>
  20765. </member>
  20766. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection)">
  20767. <summary>
  20768. Initializes a new instance of the <c>PluginCollection</c> class
  20769. that contains elements copied from the specified <c>PluginCollection</c>.
  20770. </summary>
  20771. <param name="c">The <c>PluginCollection</c> whose elements are copied to the new collection.</param>
  20772. </member>
  20773. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.IPlugin[])">
  20774. <summary>
  20775. Initializes a new instance of the <c>PluginCollection</c> class
  20776. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> array.
  20777. </summary>
  20778. <param name="a">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements are copied to the new list.</param>
  20779. </member>
  20780. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Collections.ICollection)">
  20781. <summary>
  20782. Initializes a new instance of the <c>PluginCollection</c> class
  20783. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> collection.
  20784. </summary>
  20785. <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements are copied to the new list.</param>
  20786. </member>
  20787. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection.Tag)">
  20788. <summary>
  20789. Allow subclasses to avoid our default constructors
  20790. </summary>
  20791. <param name="tag"></param>
  20792. <exclude/>
  20793. </member>
  20794. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[])">
  20795. <summary>
  20796. Copies the entire <c>PluginCollection</c> to a one-dimensional
  20797. <see cref="T:log4net.Plugin.IPlugin"/> array.
  20798. </summary>
  20799. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  20800. </member>
  20801. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[],System.Int32)">
  20802. <summary>
  20803. Copies the entire <c>PluginCollection</c> to a one-dimensional
  20804. <see cref="T:log4net.Plugin.IPlugin"/> array, starting at the specified index of the target array.
  20805. </summary>
  20806. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  20807. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  20808. </member>
  20809. <member name="M:log4net.Plugin.PluginCollection.Add(log4net.Plugin.IPlugin)">
  20810. <summary>
  20811. Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the end of the <c>PluginCollection</c>.
  20812. </summary>
  20813. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to be added to the end of the <c>PluginCollection</c>.</param>
  20814. <returns>The index at which the value has been added.</returns>
  20815. </member>
  20816. <member name="M:log4net.Plugin.PluginCollection.Clear">
  20817. <summary>
  20818. Removes all elements from the <c>PluginCollection</c>.
  20819. </summary>
  20820. </member>
  20821. <member name="M:log4net.Plugin.PluginCollection.Clone">
  20822. <summary>
  20823. Creates a shallow copy of the <see cref="T:log4net.Plugin.PluginCollection"/>.
  20824. </summary>
  20825. <returns>A new <see cref="T:log4net.Plugin.PluginCollection"/> with a shallow copy of the collection data.</returns>
  20826. </member>
  20827. <member name="M:log4net.Plugin.PluginCollection.Contains(log4net.Plugin.IPlugin)">
  20828. <summary>
  20829. Determines whether a given <see cref="T:log4net.Plugin.IPlugin"/> is in the <c>PluginCollection</c>.
  20830. </summary>
  20831. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to check for.</param>
  20832. <returns><c>true</c> if <paramref name="item"/> is found in the <c>PluginCollection</c>; otherwise, <c>false</c>.</returns>
  20833. </member>
  20834. <member name="M:log4net.Plugin.PluginCollection.IndexOf(log4net.Plugin.IPlugin)">
  20835. <summary>
  20836. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Plugin.IPlugin"/>
  20837. in the <c>PluginCollection</c>.
  20838. </summary>
  20839. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to locate in the <c>PluginCollection</c>.</param>
  20840. <returns>
  20841. The zero-based index of the first occurrence of <paramref name="item"/>
  20842. in the entire <c>PluginCollection</c>, if found; otherwise, -1.
  20843. </returns>
  20844. </member>
  20845. <member name="M:log4net.Plugin.PluginCollection.Insert(System.Int32,log4net.Plugin.IPlugin)">
  20846. <summary>
  20847. Inserts an element into the <c>PluginCollection</c> at the specified index.
  20848. </summary>
  20849. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  20850. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to insert.</param>
  20851. <exception cref="T:System.ArgumentOutOfRangeException">
  20852. <para><paramref name="index"/> is less than zero</para>
  20853. <para>-or-</para>
  20854. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20855. </exception>
  20856. </member>
  20857. <member name="M:log4net.Plugin.PluginCollection.Remove(log4net.Plugin.IPlugin)">
  20858. <summary>
  20859. Removes the first occurrence of a specific <see cref="T:log4net.Plugin.IPlugin"/> from the <c>PluginCollection</c>.
  20860. </summary>
  20861. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the <c>PluginCollection</c>.</param>
  20862. <exception cref="T:System.ArgumentException">
  20863. The specified <see cref="T:log4net.Plugin.IPlugin"/> was not found in the <c>PluginCollection</c>.
  20864. </exception>
  20865. </member>
  20866. <member name="M:log4net.Plugin.PluginCollection.RemoveAt(System.Int32)">
  20867. <summary>
  20868. Removes the element at the specified index of the <c>PluginCollection</c>.
  20869. </summary>
  20870. <param name="index">The zero-based index of the element to remove.</param>
  20871. <exception cref="T:System.ArgumentOutOfRangeException">
  20872. <para><paramref name="index"/> is less than zero.</para>
  20873. <para>-or-</para>
  20874. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20875. </exception>
  20876. </member>
  20877. <member name="M:log4net.Plugin.PluginCollection.GetEnumerator">
  20878. <summary>
  20879. Returns an enumerator that can iterate through the <c>PluginCollection</c>.
  20880. </summary>
  20881. <returns>An <see cref="T:log4net.Plugin.PluginCollection.Enumerator"/> for the entire <c>PluginCollection</c>.</returns>
  20882. </member>
  20883. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.PluginCollection)">
  20884. <summary>
  20885. Adds the elements of another <c>PluginCollection</c> to the current <c>PluginCollection</c>.
  20886. </summary>
  20887. <param name="x">The <c>PluginCollection</c> whose elements should be added to the end of the current <c>PluginCollection</c>.</param>
  20888. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  20889. </member>
  20890. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.IPlugin[])">
  20891. <summary>
  20892. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> array to the current <c>PluginCollection</c>.
  20893. </summary>
  20894. <param name="x">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements should be added to the end of the <c>PluginCollection</c>.</param>
  20895. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  20896. </member>
  20897. <member name="M:log4net.Plugin.PluginCollection.AddRange(System.Collections.ICollection)">
  20898. <summary>
  20899. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> collection to the current <c>PluginCollection</c>.
  20900. </summary>
  20901. <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements should be added to the end of the <c>PluginCollection</c>.</param>
  20902. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  20903. </member>
  20904. <member name="M:log4net.Plugin.PluginCollection.TrimToSize">
  20905. <summary>
  20906. Sets the capacity to the actual number of elements.
  20907. </summary>
  20908. </member>
  20909. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32)">
  20910. <exception cref="T:System.ArgumentOutOfRangeException">
  20911. <para><paramref name="i"/> is less than zero.</para>
  20912. <para>-or-</para>
  20913. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20914. </exception>
  20915. </member>
  20916. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32,System.Boolean)">
  20917. <exception cref="T:System.ArgumentOutOfRangeException">
  20918. <para><paramref name="i"/> is less than zero.</para>
  20919. <para>-or-</para>
  20920. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20921. </exception>
  20922. </member>
  20923. <member name="P:log4net.Plugin.PluginCollection.Count">
  20924. <summary>
  20925. Gets the number of elements actually contained in the <c>PluginCollection</c>.
  20926. </summary>
  20927. </member>
  20928. <member name="P:log4net.Plugin.PluginCollection.IsSynchronized">
  20929. <summary>
  20930. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  20931. </summary>
  20932. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  20933. </member>
  20934. <member name="P:log4net.Plugin.PluginCollection.SyncRoot">
  20935. <summary>
  20936. Gets an object that can be used to synchronize access to the collection.
  20937. </summary>
  20938. <value>
  20939. An object that can be used to synchronize access to the collection.
  20940. </value>
  20941. </member>
  20942. <member name="P:log4net.Plugin.PluginCollection.Item(System.Int32)">
  20943. <summary>
  20944. Gets or sets the <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  20945. </summary>
  20946. <value>
  20947. The <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  20948. </value>
  20949. <param name="index">The zero-based index of the element to get or set.</param>
  20950. <exception cref="T:System.ArgumentOutOfRangeException">
  20951. <para><paramref name="index"/> is less than zero.</para>
  20952. <para>-or-</para>
  20953. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20954. </exception>
  20955. </member>
  20956. <member name="P:log4net.Plugin.PluginCollection.IsFixedSize">
  20957. <summary>
  20958. Gets a value indicating whether the collection has a fixed size.
  20959. </summary>
  20960. <value><c>true</c> if the collection has a fixed size; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  20961. </member>
  20962. <member name="P:log4net.Plugin.PluginCollection.IsReadOnly">
  20963. <summary>
  20964. Gets a value indicating whether the IList is read-only.
  20965. </summary>
  20966. <value><c>true</c> if the collection is read-only; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  20967. </member>
  20968. <member name="P:log4net.Plugin.PluginCollection.Capacity">
  20969. <summary>
  20970. Gets or sets the number of elements the <c>PluginCollection</c> can contain.
  20971. </summary>
  20972. <value>
  20973. The number of elements the <c>PluginCollection</c> can contain.
  20974. </value>
  20975. </member>
  20976. <member name="T:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator">
  20977. <summary>
  20978. Supports type-safe iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  20979. </summary>
  20980. <exclude/>
  20981. </member>
  20982. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.MoveNext">
  20983. <summary>
  20984. Advances the enumerator to the next element in the collection.
  20985. </summary>
  20986. <returns>
  20987. <c>true</c> if the enumerator was successfully advanced to the next element;
  20988. <c>false</c> if the enumerator has passed the end of the collection.
  20989. </returns>
  20990. <exception cref="T:System.InvalidOperationException">
  20991. The collection was modified after the enumerator was created.
  20992. </exception>
  20993. </member>
  20994. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Reset">
  20995. <summary>
  20996. Sets the enumerator to its initial position, before the first element in the collection.
  20997. </summary>
  20998. </member>
  20999. <member name="P:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Current">
  21000. <summary>
  21001. Gets the current element in the collection.
  21002. </summary>
  21003. </member>
  21004. <member name="T:log4net.Plugin.PluginCollection.Tag">
  21005. <summary>
  21006. Type visible only to our subclasses
  21007. Used to access protected constructor
  21008. </summary>
  21009. <exclude/>
  21010. </member>
  21011. <member name="F:log4net.Plugin.PluginCollection.Tag.Default">
  21012. <summary>
  21013. A value
  21014. </summary>
  21015. </member>
  21016. <member name="T:log4net.Plugin.PluginCollection.Enumerator">
  21017. <summary>
  21018. Supports simple iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  21019. </summary>
  21020. <exclude/>
  21021. </member>
  21022. <member name="M:log4net.Plugin.PluginCollection.Enumerator.#ctor(log4net.Plugin.PluginCollection)">
  21023. <summary>
  21024. Initializes a new instance of the <c>Enumerator</c> class.
  21025. </summary>
  21026. <param name="tc"></param>
  21027. </member>
  21028. <member name="M:log4net.Plugin.PluginCollection.Enumerator.MoveNext">
  21029. <summary>
  21030. Advances the enumerator to the next element in the collection.
  21031. </summary>
  21032. <returns>
  21033. <c>true</c> if the enumerator was successfully advanced to the next element;
  21034. <c>false</c> if the enumerator has passed the end of the collection.
  21035. </returns>
  21036. <exception cref="T:System.InvalidOperationException">
  21037. The collection was modified after the enumerator was created.
  21038. </exception>
  21039. </member>
  21040. <member name="M:log4net.Plugin.PluginCollection.Enumerator.Reset">
  21041. <summary>
  21042. Sets the enumerator to its initial position, before the first element in the collection.
  21043. </summary>
  21044. </member>
  21045. <member name="P:log4net.Plugin.PluginCollection.Enumerator.Current">
  21046. <summary>
  21047. Gets the current element in the collection.
  21048. </summary>
  21049. <value>
  21050. The current element in the collection.
  21051. </value>
  21052. </member>
  21053. <member name="T:log4net.Plugin.PluginCollection.ReadOnlyPluginCollection">
  21054. <exclude/>
  21055. </member>
  21056. <member name="T:log4net.Plugin.PluginMap">
  21057. <summary>
  21058. Map of repository plugins.
  21059. </summary>
  21060. <remarks>
  21061. <para>
  21062. This class is a name keyed map of the plugins that are
  21063. attached to a repository.
  21064. </para>
  21065. </remarks>
  21066. <author>Nicko Cadell</author>
  21067. <author>Gert Driesen</author>
  21068. </member>
  21069. <member name="M:log4net.Plugin.PluginMap.#ctor(log4net.Repository.ILoggerRepository)">
  21070. <summary>
  21071. Constructor
  21072. </summary>
  21073. <param name="repository">The repository that the plugins should be attached to.</param>
  21074. <remarks>
  21075. <para>
  21076. Initialize a new instance of the <see cref="T:log4net.Plugin.PluginMap"/> class with a
  21077. repository that the plugins should be attached to.
  21078. </para>
  21079. </remarks>
  21080. </member>
  21081. <member name="M:log4net.Plugin.PluginMap.Add(log4net.Plugin.IPlugin)">
  21082. <summary>
  21083. Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the map.
  21084. </summary>
  21085. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to add to the map.</param>
  21086. <remarks>
  21087. <para>
  21088. The <see cref="T:log4net.Plugin.IPlugin"/> will be attached to the repository when added.
  21089. </para>
  21090. <para>
  21091. If there already exists a plugin with the same name
  21092. attached to the repository then the old plugin will
  21093. be <see cref="M:log4net.Plugin.IPlugin.Shutdown"/> and replaced with
  21094. the new plugin.
  21095. </para>
  21096. </remarks>
  21097. </member>
  21098. <member name="M:log4net.Plugin.PluginMap.Remove(log4net.Plugin.IPlugin)">
  21099. <summary>
  21100. Removes a <see cref="T:log4net.Plugin.IPlugin"/> from the map.
  21101. </summary>
  21102. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the map.</param>
  21103. <remarks>
  21104. <para>
  21105. Remove a specific plugin from this map.
  21106. </para>
  21107. </remarks>
  21108. </member>
  21109. <member name="P:log4net.Plugin.PluginMap.Item(System.String)">
  21110. <summary>
  21111. Gets a <see cref="T:log4net.Plugin.IPlugin"/> by name.
  21112. </summary>
  21113. <param name="name">The name of the <see cref="T:log4net.Plugin.IPlugin"/> to lookup.</param>
  21114. <returns>
  21115. The <see cref="T:log4net.Plugin.IPlugin"/> from the map with the name specified, or
  21116. <c>null</c> if no plugin is found.
  21117. </returns>
  21118. <remarks>
  21119. <para>
  21120. Lookup a plugin by name. If the plugin is not found <c>null</c>
  21121. will be returned.
  21122. </para>
  21123. </remarks>
  21124. </member>
  21125. <member name="P:log4net.Plugin.PluginMap.AllPlugins">
  21126. <summary>
  21127. Gets all possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects.
  21128. </summary>
  21129. <value>All possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects.</value>
  21130. <remarks>
  21131. <para>
  21132. Get a collection of all the plugins defined in this map.
  21133. </para>
  21134. </remarks>
  21135. </member>
  21136. <member name="T:log4net.Plugin.PluginSkeleton">
  21137. <summary>
  21138. Base implementation of <see cref="T:log4net.Plugin.IPlugin"/>
  21139. </summary>
  21140. <remarks>
  21141. <para>
  21142. Default abstract implementation of the <see cref="T:log4net.Plugin.IPlugin"/>
  21143. interface. This base class can be used by implementors
  21144. of the <see cref="T:log4net.Plugin.IPlugin"/> interface.
  21145. </para>
  21146. </remarks>
  21147. <author>Nicko Cadell</author>
  21148. <author>Gert Driesen</author>
  21149. </member>
  21150. <member name="M:log4net.Plugin.PluginSkeleton.#ctor(System.String)">
  21151. <summary>
  21152. Constructor
  21153. </summary>
  21154. <param name="name">the name of the plugin</param>
  21155. <remarks>
  21156. Initializes a new Plugin with the specified name.
  21157. </remarks>
  21158. </member>
  21159. <member name="M:log4net.Plugin.PluginSkeleton.Attach(log4net.Repository.ILoggerRepository)">
  21160. <summary>
  21161. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21162. </summary>
  21163. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  21164. <remarks>
  21165. <para>
  21166. A plugin may only be attached to a single repository.
  21167. </para>
  21168. <para>
  21169. This method is called when the plugin is attached to the repository.
  21170. </para>
  21171. </remarks>
  21172. </member>
  21173. <member name="M:log4net.Plugin.PluginSkeleton.Shutdown">
  21174. <summary>
  21175. Is called when the plugin is to shutdown.
  21176. </summary>
  21177. <remarks>
  21178. <para>
  21179. This method is called to notify the plugin that
  21180. it should stop operating and should detach from
  21181. the repository.
  21182. </para>
  21183. </remarks>
  21184. </member>
  21185. <member name="F:log4net.Plugin.PluginSkeleton.m_name">
  21186. <summary>
  21187. The name of this plugin.
  21188. </summary>
  21189. </member>
  21190. <member name="F:log4net.Plugin.PluginSkeleton.m_repository">
  21191. <summary>
  21192. The repository this plugin is attached to.
  21193. </summary>
  21194. </member>
  21195. <member name="P:log4net.Plugin.PluginSkeleton.Name">
  21196. <summary>
  21197. Gets or sets the name of the plugin.
  21198. </summary>
  21199. <value>
  21200. The name of the plugin.
  21201. </value>
  21202. <remarks>
  21203. <para>
  21204. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  21205. keyed by name. Each plugin instance attached to a
  21206. repository must be a unique name.
  21207. </para>
  21208. <para>
  21209. The name of the plugin must not change one the
  21210. plugin has been attached to a repository.
  21211. </para>
  21212. </remarks>
  21213. </member>
  21214. <member name="P:log4net.Plugin.PluginSkeleton.LoggerRepository">
  21215. <summary>
  21216. The repository for this plugin
  21217. </summary>
  21218. <value>
  21219. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is attached to.
  21220. </value>
  21221. <remarks>
  21222. <para>
  21223. Gets or sets the <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is
  21224. attached to.
  21225. </para>
  21226. </remarks>
  21227. </member>
  21228. <member name="T:log4net.Plugin.RemoteLoggingServerPlugin">
  21229. <summary>
  21230. Plugin that listens for events from the <see cref="T:log4net.Appender.RemotingAppender"/>
  21231. </summary>
  21232. <remarks>
  21233. <para>
  21234. This plugin publishes an instance of <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  21235. on a specified <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/>. This listens for logging events delivered from
  21236. a remote <see cref="T:log4net.Appender.RemotingAppender"/>.
  21237. </para>
  21238. <para>
  21239. When an event is received it is relogged within the attached repository
  21240. as if it had been raised locally.
  21241. </para>
  21242. </remarks>
  21243. <author>Nicko Cadell</author>
  21244. <author>Gert Driesen</author>
  21245. </member>
  21246. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor">
  21247. <summary>
  21248. Default constructor
  21249. </summary>
  21250. <remarks>
  21251. <para>
  21252. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class.
  21253. </para>
  21254. <para>
  21255. The <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> property must be set.
  21256. </para>
  21257. </remarks>
  21258. </member>
  21259. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor(System.String)">
  21260. <summary>
  21261. Construct with sink Uri.
  21262. </summary>
  21263. <param name="sinkUri">The name to publish the sink under in the remoting infrastructure.
  21264. See <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> for more details.</param>
  21265. <remarks>
  21266. <para>
  21267. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class
  21268. with specified name.
  21269. </para>
  21270. </remarks>
  21271. </member>
  21272. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Attach(log4net.Repository.ILoggerRepository)">
  21273. <summary>
  21274. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21275. </summary>
  21276. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  21277. <remarks>
  21278. <para>
  21279. A plugin may only be attached to a single repository.
  21280. </para>
  21281. <para>
  21282. This method is called when the plugin is attached to the repository.
  21283. </para>
  21284. </remarks>
  21285. </member>
  21286. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Shutdown">
  21287. <summary>
  21288. Is called when the plugin is to shutdown.
  21289. </summary>
  21290. <remarks>
  21291. <para>
  21292. When the plugin is shutdown the remote logging
  21293. sink is disconnected.
  21294. </para>
  21295. </remarks>
  21296. </member>
  21297. <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.declaringType">
  21298. <summary>
  21299. The fully qualified type of the RemoteLoggingServerPlugin class.
  21300. </summary>
  21301. <remarks>
  21302. Used by the internal logger to record the Type of the
  21303. log message.
  21304. </remarks>
  21305. </member>
  21306. <member name="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri">
  21307. <summary>
  21308. Gets or sets the URI of this sink.
  21309. </summary>
  21310. <value>
  21311. The URI of this sink.
  21312. </value>
  21313. <remarks>
  21314. <para>
  21315. This is the name under which the object is marshaled.
  21316. <see cref="M:RemotingServices.Marshal(MarshalByRefObject,String,Type)"/>
  21317. </para>
  21318. </remarks>
  21319. </member>
  21320. <member name="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl">
  21321. <summary>
  21322. Delivers <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
  21323. </summary>
  21324. <remarks>
  21325. <para>
  21326. Internal class used to listen for logging events
  21327. and deliver them to the local repository.
  21328. </para>
  21329. </remarks>
  21330. </member>
  21331. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.#ctor(log4net.Repository.ILoggerRepository)">
  21332. <summary>
  21333. Constructor
  21334. </summary>
  21335. <param name="repository">The repository to log to.</param>
  21336. <remarks>
  21337. <para>
  21338. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl"/> for the
  21339. specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21340. </para>
  21341. </remarks>
  21342. </member>
  21343. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.LogEvents(log4net.Core.LoggingEvent[])">
  21344. <summary>
  21345. Logs the events to the repository.
  21346. </summary>
  21347. <param name="events">The events to log.</param>
  21348. <remarks>
  21349. <para>
  21350. The events passed are logged to the <see cref="T:log4net.Repository.ILoggerRepository"/>
  21351. </para>
  21352. </remarks>
  21353. </member>
  21354. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.InitializeLifetimeService">
  21355. <summary>
  21356. Obtains a lifetime service object to control the lifetime
  21357. policy for this instance.
  21358. </summary>
  21359. <returns><c>null</c> to indicate that this instance should live forever.</returns>
  21360. <remarks>
  21361. <para>
  21362. Obtains a lifetime service object to control the lifetime
  21363. policy for this instance. This object should live forever
  21364. therefore this implementation returns <c>null</c>.
  21365. </para>
  21366. </remarks>
  21367. </member>
  21368. <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.m_repository">
  21369. <summary>
  21370. The underlying <see cref="T:log4net.Repository.ILoggerRepository"/> that events should
  21371. be logged to.
  21372. </summary>
  21373. </member>
  21374. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory">
  21375. <summary>
  21376. Default implementation of <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  21377. </summary>
  21378. <remarks>
  21379. <para>
  21380. This default implementation of the <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  21381. interface is used to create the default subclass
  21382. of the <see cref="T:log4net.Repository.Hierarchy.Logger"/> object.
  21383. </para>
  21384. </remarks>
  21385. <author>Nicko Cadell</author>
  21386. <author>Gert Driesen</author>
  21387. </member>
  21388. <member name="T:log4net.Repository.Hierarchy.ILoggerFactory">
  21389. <summary>
  21390. Interface abstracts creation of <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances
  21391. </summary>
  21392. <remarks>
  21393. <para>
  21394. This interface is used by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to
  21395. create new <see cref="T:log4net.Repository.Hierarchy.Logger"/> objects.
  21396. </para>
  21397. <para>
  21398. The <see cref="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"/> method is called
  21399. to create a named <see cref="T:log4net.Repository.Hierarchy.Logger"/>.
  21400. </para>
  21401. <para>
  21402. Implement this interface to create new subclasses of <see cref="T:log4net.Repository.Hierarchy.Logger"/>.
  21403. </para>
  21404. </remarks>
  21405. <author>Nicko Cadell</author>
  21406. <author>Gert Driesen</author>
  21407. </member>
  21408. <member name="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  21409. <summary>
  21410. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance
  21411. </summary>
  21412. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21413. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21414. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns>
  21415. <remarks>
  21416. <para>
  21417. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the
  21418. specified name.
  21419. </para>
  21420. <para>
  21421. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  21422. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  21423. </para>
  21424. <para>
  21425. If the <paramref name="name"/> is <c>null</c> then the root logger
  21426. must be returned.
  21427. </para>
  21428. </remarks>
  21429. </member>
  21430. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.#ctor">
  21431. <summary>
  21432. Default constructor
  21433. </summary>
  21434. <remarks>
  21435. <para>
  21436. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> class.
  21437. </para>
  21438. </remarks>
  21439. </member>
  21440. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  21441. <summary>
  21442. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance
  21443. </summary>
  21444. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21445. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21446. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns>
  21447. <remarks>
  21448. <para>
  21449. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the
  21450. specified name.
  21451. </para>
  21452. <para>
  21453. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  21454. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  21455. </para>
  21456. <para>
  21457. If the <paramref name="name"/> is <c>null</c> then the root logger
  21458. must be returned.
  21459. </para>
  21460. </remarks>
  21461. </member>
  21462. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl">
  21463. <summary>
  21464. Default internal subclass of <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  21465. </summary>
  21466. <remarks>
  21467. <para>
  21468. This subclass has no additional behavior over the
  21469. <see cref="T:log4net.Repository.Hierarchy.Logger"/> class but does allow instances
  21470. to be created.
  21471. </para>
  21472. </remarks>
  21473. </member>
  21474. <member name="T:log4net.Repository.Hierarchy.Logger">
  21475. <summary>
  21476. Implementation of <see cref="T:log4net.Core.ILogger"/> used by <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>
  21477. </summary>
  21478. <remarks>
  21479. <para>
  21480. Internal class used to provide implementation of <see cref="T:log4net.Core.ILogger"/>
  21481. interface. Applications should use <see cref="T:log4net.LogManager"/> to get
  21482. logger instances.
  21483. </para>
  21484. <para>
  21485. This is one of the central classes in the log4net implementation. One of the
  21486. distinctive features of log4net are hierarchical loggers and their
  21487. evaluation. The <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> organizes the <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  21488. instances into a rooted tree hierarchy.
  21489. </para>
  21490. <para>
  21491. The <see cref="T:log4net.Repository.Hierarchy.Logger"/> class is abstract. Only concrete subclasses of
  21492. <see cref="T:log4net.Repository.Hierarchy.Logger"/> can be created. The <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  21493. is used to create instances of this type for the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  21494. </para>
  21495. </remarks>
  21496. <author>Nicko Cadell</author>
  21497. <author>Gert Driesen</author>
  21498. <author>Aspi Havewala</author>
  21499. <author>Douglas de la Torre</author>
  21500. </member>
  21501. <member name="M:log4net.Repository.Hierarchy.Logger.#ctor(System.String)">
  21502. <summary>
  21503. This constructor created a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance and
  21504. sets its name.
  21505. </summary>
  21506. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21507. <remarks>
  21508. <para>
  21509. This constructor is protected and designed to be used by
  21510. a subclass that is not abstract.
  21511. </para>
  21512. <para>
  21513. Loggers are constructed by <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  21514. objects. See <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> for the default
  21515. logger creator.
  21516. </para>
  21517. </remarks>
  21518. </member>
  21519. <member name="M:log4net.Repository.Hierarchy.Logger.AddAppender(log4net.Appender.IAppender)">
  21520. <summary>
  21521. Add <paramref name="newAppender"/> to the list of appenders of this
  21522. Logger instance.
  21523. </summary>
  21524. <param name="newAppender">An appender to add to this logger</param>
  21525. <remarks>
  21526. <para>
  21527. Add <paramref name="newAppender"/> to the list of appenders of this
  21528. Logger instance.
  21529. </para>
  21530. <para>
  21531. If <paramref name="newAppender"/> is already in the list of
  21532. appenders, then it won't be added again.
  21533. </para>
  21534. </remarks>
  21535. </member>
  21536. <member name="M:log4net.Repository.Hierarchy.Logger.GetAppender(System.String)">
  21537. <summary>
  21538. Look for the appender named as <c>name</c>
  21539. </summary>
  21540. <param name="name">The name of the appender to lookup</param>
  21541. <returns>The appender with the name specified, or <c>null</c>.</returns>
  21542. <remarks>
  21543. <para>
  21544. Returns the named appender, or null if the appender is not found.
  21545. </para>
  21546. </remarks>
  21547. </member>
  21548. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAllAppenders">
  21549. <summary>
  21550. Remove all previously added appenders from this Logger instance.
  21551. </summary>
  21552. <remarks>
  21553. <para>
  21554. Remove all previously added appenders from this Logger instance.
  21555. </para>
  21556. <para>
  21557. This is useful when re-reading configuration information.
  21558. </para>
  21559. </remarks>
  21560. </member>
  21561. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(log4net.Appender.IAppender)">
  21562. <summary>
  21563. Remove the appender passed as parameter form the list of appenders.
  21564. </summary>
  21565. <param name="appender">The appender to remove</param>
  21566. <returns>The appender removed from the list</returns>
  21567. <remarks>
  21568. <para>
  21569. Remove the appender passed as parameter form the list of appenders.
  21570. The appender removed is not closed.
  21571. If you are discarding the appender you must call
  21572. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  21573. </para>
  21574. </remarks>
  21575. </member>
  21576. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(System.String)">
  21577. <summary>
  21578. Remove the appender passed as parameter form the list of appenders.
  21579. </summary>
  21580. <param name="name">The name of the appender to remove</param>
  21581. <returns>The appender removed from the list</returns>
  21582. <remarks>
  21583. <para>
  21584. Remove the named appender passed as parameter form the list of appenders.
  21585. The appender removed is not closed.
  21586. If you are discarding the appender you must call
  21587. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  21588. </para>
  21589. </remarks>
  21590. </member>
  21591. <member name="M:log4net.Repository.Hierarchy.Logger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  21592. <summary>
  21593. This generic form is intended to be used by wrappers.
  21594. </summary>
  21595. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  21596. the stack boundary into the logging system for this call.</param>
  21597. <param name="level">The level of the message to be logged.</param>
  21598. <param name="message">The message object to log.</param>
  21599. <param name="exception">The exception to log, including its stack trace.</param>
  21600. <remarks>
  21601. <para>
  21602. Generate a logging event for the specified <paramref name="level"/> using
  21603. the <paramref name="message"/> and <paramref name="exception"/>.
  21604. </para>
  21605. <para>
  21606. This method must not throw any exception to the caller.
  21607. </para>
  21608. </remarks>
  21609. </member>
  21610. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.LoggingEvent)">
  21611. <summary>
  21612. This is the most generic printing method that is intended to be used
  21613. by wrappers.
  21614. </summary>
  21615. <param name="logEvent">The event being logged.</param>
  21616. <remarks>
  21617. <para>
  21618. Logs the specified logging event through this logger.
  21619. </para>
  21620. <para>
  21621. This method must not throw any exception to the caller.
  21622. </para>
  21623. </remarks>
  21624. </member>
  21625. <member name="M:log4net.Repository.Hierarchy.Logger.IsEnabledFor(log4net.Core.Level)">
  21626. <summary>
  21627. Checks if this logger is enabled for a given <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> passed as parameter.
  21628. </summary>
  21629. <param name="level">The level to check.</param>
  21630. <returns>
  21631. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  21632. </returns>
  21633. <remarks>
  21634. <para>
  21635. Test if this logger is going to log events of the specified <paramref name="level"/>.
  21636. </para>
  21637. <para>
  21638. This method must not throw any exception to the caller.
  21639. </para>
  21640. </remarks>
  21641. </member>
  21642. <member name="M:log4net.Repository.Hierarchy.Logger.CallAppenders(log4net.Core.LoggingEvent)">
  21643. <summary>
  21644. Deliver the <see cref="T:log4net.Core.LoggingEvent"/> to the attached appenders.
  21645. </summary>
  21646. <param name="loggingEvent">The event to log.</param>
  21647. <remarks>
  21648. <para>
  21649. Call the appenders in the hierarchy starting at
  21650. <c>this</c>. If no appenders could be found, emit a
  21651. warning.
  21652. </para>
  21653. <para>
  21654. This method calls all the appenders inherited from the
  21655. hierarchy circumventing any evaluation of whether to log or not
  21656. to log the particular log request.
  21657. </para>
  21658. </remarks>
  21659. </member>
  21660. <member name="M:log4net.Repository.Hierarchy.Logger.CloseNestedAppenders">
  21661. <summary>
  21662. Closes all attached appenders implementing the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  21663. </summary>
  21664. <remarks>
  21665. <para>
  21666. Used to ensure that the appenders are correctly shutdown.
  21667. </para>
  21668. </remarks>
  21669. </member>
  21670. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.Level,System.Object,System.Exception)">
  21671. <summary>
  21672. This is the most generic printing method. This generic form is intended to be used by wrappers
  21673. </summary>
  21674. <param name="level">The level of the message to be logged.</param>
  21675. <param name="message">The message object to log.</param>
  21676. <param name="exception">The exception to log, including its stack trace.</param>
  21677. <remarks>
  21678. <para>
  21679. Generate a logging event for the specified <paramref name="level"/> using
  21680. the <paramref name="message"/>.
  21681. </para>
  21682. </remarks>
  21683. </member>
  21684. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  21685. <summary>
  21686. Creates a new logging event and logs the event without further checks.
  21687. </summary>
  21688. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  21689. the stack boundary into the logging system for this call.</param>
  21690. <param name="level">The level of the message to be logged.</param>
  21691. <param name="message">The message object to log.</param>
  21692. <param name="exception">The exception to log, including its stack trace.</param>
  21693. <remarks>
  21694. <para>
  21695. Generates a logging event and delivers it to the attached
  21696. appenders.
  21697. </para>
  21698. </remarks>
  21699. </member>
  21700. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(log4net.Core.LoggingEvent)">
  21701. <summary>
  21702. Creates a new logging event and logs the event without further checks.
  21703. </summary>
  21704. <param name="logEvent">The event being logged.</param>
  21705. <remarks>
  21706. <para>
  21707. Delivers the logging event to the attached appenders.
  21708. </para>
  21709. </remarks>
  21710. </member>
  21711. <member name="F:log4net.Repository.Hierarchy.Logger.declaringType">
  21712. <summary>
  21713. The fully qualified type of the Logger class.
  21714. </summary>
  21715. </member>
  21716. <member name="F:log4net.Repository.Hierarchy.Logger.m_name">
  21717. <summary>
  21718. The name of this logger.
  21719. </summary>
  21720. </member>
  21721. <member name="F:log4net.Repository.Hierarchy.Logger.m_level">
  21722. <summary>
  21723. The assigned level of this logger.
  21724. </summary>
  21725. <remarks>
  21726. <para>
  21727. The <c>level</c> variable need not be
  21728. assigned a value in which case it is inherited
  21729. form the hierarchy.
  21730. </para>
  21731. </remarks>
  21732. </member>
  21733. <member name="F:log4net.Repository.Hierarchy.Logger.m_parent">
  21734. <summary>
  21735. The parent of this logger.
  21736. </summary>
  21737. <remarks>
  21738. <para>
  21739. The parent of this logger.
  21740. All loggers have at least one ancestor which is the root logger.
  21741. </para>
  21742. </remarks>
  21743. </member>
  21744. <member name="F:log4net.Repository.Hierarchy.Logger.m_hierarchy">
  21745. <summary>
  21746. Loggers need to know what Hierarchy they are in.
  21747. </summary>
  21748. <remarks>
  21749. <para>
  21750. Loggers need to know what Hierarchy they are in.
  21751. The hierarchy that this logger is a member of is stored
  21752. here.
  21753. </para>
  21754. </remarks>
  21755. </member>
  21756. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderAttachedImpl">
  21757. <summary>
  21758. Helper implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  21759. </summary>
  21760. </member>
  21761. <member name="F:log4net.Repository.Hierarchy.Logger.m_additive">
  21762. <summary>
  21763. Flag indicating if child loggers inherit their parents appenders
  21764. </summary>
  21765. <remarks>
  21766. <para>
  21767. Additivity is set to true by default, that is children inherit
  21768. the appenders of their ancestors by default. If this variable is
  21769. set to <c>false</c> then the appenders found in the
  21770. ancestors of this logger are not used. However, the children
  21771. of this logger will inherit its appenders, unless the children
  21772. have their additivity flag set to <c>false</c> too. See
  21773. the user manual for more details.
  21774. </para>
  21775. </remarks>
  21776. </member>
  21777. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderLock">
  21778. <summary>
  21779. Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl
  21780. </summary>
  21781. </member>
  21782. <member name="P:log4net.Repository.Hierarchy.Logger.Parent">
  21783. <summary>
  21784. Gets or sets the parent logger in the hierarchy.
  21785. </summary>
  21786. <value>
  21787. The parent logger in the hierarchy.
  21788. </value>
  21789. <remarks>
  21790. <para>
  21791. Part of the Composite pattern that makes the hierarchy.
  21792. The hierarchy is parent linked rather than child linked.
  21793. </para>
  21794. </remarks>
  21795. </member>
  21796. <member name="P:log4net.Repository.Hierarchy.Logger.Additivity">
  21797. <summary>
  21798. Gets or sets a value indicating if child loggers inherit their parent's appenders.
  21799. </summary>
  21800. <value>
  21801. <c>true</c> if child loggers inherit their parent's appenders.
  21802. </value>
  21803. <remarks>
  21804. <para>
  21805. Additivity is set to <c>true</c> by default, that is children inherit
  21806. the appenders of their ancestors by default. If this variable is
  21807. set to <c>false</c> then the appenders found in the
  21808. ancestors of this logger are not used. However, the children
  21809. of this logger will inherit its appenders, unless the children
  21810. have their additivity flag set to <c>false</c> too. See
  21811. the user manual for more details.
  21812. </para>
  21813. </remarks>
  21814. </member>
  21815. <member name="P:log4net.Repository.Hierarchy.Logger.EffectiveLevel">
  21816. <summary>
  21817. Gets the effective level for this logger.
  21818. </summary>
  21819. <returns>The nearest level in the logger hierarchy.</returns>
  21820. <remarks>
  21821. <para>
  21822. Starting from this logger, searches the logger hierarchy for a
  21823. non-null level and returns it. Otherwise, returns the level of the
  21824. root logger.
  21825. </para>
  21826. <para>The Logger class is designed so that this method executes as
  21827. quickly as possible.</para>
  21828. </remarks>
  21829. </member>
  21830. <member name="P:log4net.Repository.Hierarchy.Logger.Hierarchy">
  21831. <summary>
  21832. Gets or sets the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> where this
  21833. <c>Logger</c> instance is attached to.
  21834. </summary>
  21835. <value>The hierarchy that this logger belongs to.</value>
  21836. <remarks>
  21837. <para>
  21838. This logger must be attached to a single <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  21839. </para>
  21840. </remarks>
  21841. </member>
  21842. <member name="P:log4net.Repository.Hierarchy.Logger.Level">
  21843. <summary>
  21844. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>, if any, for this Logger.
  21845. </summary>
  21846. <value>
  21847. The <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> of this logger.
  21848. </value>
  21849. <remarks>
  21850. <para>
  21851. The assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> can be <c>null</c>.
  21852. </para>
  21853. </remarks>
  21854. </member>
  21855. <member name="P:log4net.Repository.Hierarchy.Logger.Appenders">
  21856. <summary>
  21857. Get the appenders contained in this logger as an
  21858. <see cref="T:System.Collections.ICollection"/>.
  21859. </summary>
  21860. <returns>A collection of the appenders in this logger</returns>
  21861. <remarks>
  21862. <para>
  21863. Get the appenders contained in this logger as an
  21864. <see cref="T:System.Collections.ICollection"/>. If no appenders
  21865. can be found, then a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  21866. </para>
  21867. </remarks>
  21868. </member>
  21869. <member name="P:log4net.Repository.Hierarchy.Logger.Name">
  21870. <summary>
  21871. Gets the logger name.
  21872. </summary>
  21873. <value>
  21874. The name of the logger.
  21875. </value>
  21876. <remarks>
  21877. <para>
  21878. The name of this logger
  21879. </para>
  21880. </remarks>
  21881. </member>
  21882. <member name="P:log4net.Repository.Hierarchy.Logger.Repository">
  21883. <summary>
  21884. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  21885. <c>Logger</c> instance is attached to.
  21886. </summary>
  21887. <value>
  21888. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to.
  21889. </value>
  21890. <remarks>
  21891. <para>
  21892. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  21893. <c>Logger</c> instance is attached to.
  21894. </para>
  21895. </remarks>
  21896. </member>
  21897. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl.#ctor(System.String)">
  21898. <summary>
  21899. Construct a new Logger
  21900. </summary>
  21901. <param name="name">the name of the logger</param>
  21902. <remarks>
  21903. <para>
  21904. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl"/> class
  21905. with the specified name.
  21906. </para>
  21907. </remarks>
  21908. </member>
  21909. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventHandler">
  21910. <summary>
  21911. Delegate used to handle logger creation event notifications.
  21912. </summary>
  21913. <param name="sender">The <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> in which the <see cref="T:log4net.Repository.Hierarchy.Logger"/> has been created.</param>
  21914. <param name="e">The <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"/> event args that hold the <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance that has been created.</param>
  21915. <remarks>
  21916. <para>
  21917. Delegate used to handle logger creation event notifications.
  21918. </para>
  21919. </remarks>
  21920. </member>
  21921. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs">
  21922. <summary>
  21923. Provides data for the <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event.
  21924. </summary>
  21925. <remarks>
  21926. <para>
  21927. A <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event is raised every time a
  21928. <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> is created.
  21929. </para>
  21930. </remarks>
  21931. </member>
  21932. <member name="F:log4net.Repository.Hierarchy.LoggerCreationEventArgs.m_log">
  21933. <summary>
  21934. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> created
  21935. </summary>
  21936. </member>
  21937. <member name="M:log4net.Repository.Hierarchy.LoggerCreationEventArgs.#ctor(log4net.Repository.Hierarchy.Logger)">
  21938. <summary>
  21939. Constructor
  21940. </summary>
  21941. <param name="log">The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.</param>
  21942. <remarks>
  21943. <para>
  21944. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"/> event argument
  21945. class,with the specified <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/>.
  21946. </para>
  21947. </remarks>
  21948. </member>
  21949. <member name="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger">
  21950. <summary>
  21951. Gets the <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  21952. </summary>
  21953. <value>
  21954. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  21955. </value>
  21956. <remarks>
  21957. <para>
  21958. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  21959. </para>
  21960. </remarks>
  21961. </member>
  21962. <member name="T:log4net.Repository.Hierarchy.Hierarchy">
  21963. <summary>
  21964. Hierarchical organization of loggers
  21965. </summary>
  21966. <remarks>
  21967. <para>
  21968. <i>The casual user should not have to deal with this class
  21969. directly.</i>
  21970. </para>
  21971. <para>
  21972. This class is specialized in retrieving loggers by name and
  21973. also maintaining the logger hierarchy. Implements the
  21974. <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  21975. </para>
  21976. <para>
  21977. The structure of the logger hierarchy is maintained by the
  21978. <see cref="M:GetLogger(string)"/> method. The hierarchy is such that children
  21979. link to their parent but parents do not have any references to their
  21980. children. Moreover, loggers can be instantiated in any order, in
  21981. particular descendant before ancestor.
  21982. </para>
  21983. <para>
  21984. In case a descendant is created before a particular ancestor,
  21985. then it creates a provision node for the ancestor and adds itself
  21986. to the provision node. Other descendants of the same ancestor add
  21987. themselves to the previously created provision node.
  21988. </para>
  21989. </remarks>
  21990. <author>Nicko Cadell</author>
  21991. <author>Gert Driesen</author>
  21992. </member>
  21993. <member name="T:log4net.Repository.LoggerRepositorySkeleton">
  21994. <summary>
  21995. Base implementation of <see cref="T:log4net.Repository.ILoggerRepository"/>
  21996. </summary>
  21997. <remarks>
  21998. <para>
  21999. Default abstract implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  22000. </para>
  22001. <para>
  22002. Skeleton implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  22003. All <see cref="T:log4net.Repository.ILoggerRepository"/> types can extend this type.
  22004. </para>
  22005. </remarks>
  22006. <author>Nicko Cadell</author>
  22007. <author>Gert Driesen</author>
  22008. </member>
  22009. <member name="T:log4net.Repository.ILoggerRepository">
  22010. <summary>
  22011. Interface implemented by logger repositories.
  22012. </summary>
  22013. <remarks>
  22014. <para>
  22015. This interface is implemented by logger repositories. e.g.
  22016. <see cref="N:log4net.Repository.Hierarchy"/>.
  22017. </para>
  22018. <para>
  22019. This interface is used by the <see cref="T:log4net.LogManager"/>
  22020. to obtain <see cref="T:log4net.ILog"/> interfaces.
  22021. </para>
  22022. </remarks>
  22023. <author>Nicko Cadell</author>
  22024. <author>Gert Driesen</author>
  22025. </member>
  22026. <member name="M:log4net.Repository.ILoggerRepository.Exists(System.String)">
  22027. <summary>
  22028. Check if the named logger exists in the repository. If so return
  22029. its reference, otherwise returns <c>null</c>.
  22030. </summary>
  22031. <param name="name">The name of the logger to lookup</param>
  22032. <returns>The Logger object with the name specified</returns>
  22033. <remarks>
  22034. <para>
  22035. If the names logger exists it is returned, otherwise
  22036. <c>null</c> is returned.
  22037. </para>
  22038. </remarks>
  22039. </member>
  22040. <member name="M:log4net.Repository.ILoggerRepository.GetCurrentLoggers">
  22041. <summary>
  22042. Returns all the currently defined loggers as an Array.
  22043. </summary>
  22044. <returns>All the defined loggers</returns>
  22045. <remarks>
  22046. <para>
  22047. Returns all the currently defined loggers as an Array.
  22048. </para>
  22049. </remarks>
  22050. </member>
  22051. <member name="M:log4net.Repository.ILoggerRepository.GetLogger(System.String)">
  22052. <summary>
  22053. Returns a named logger instance
  22054. </summary>
  22055. <param name="name">The name of the logger to retrieve</param>
  22056. <returns>The logger object with the name specified</returns>
  22057. <remarks>
  22058. <para>
  22059. Returns a named logger instance.
  22060. </para>
  22061. <para>
  22062. If a logger of that name already exists, then it will be
  22063. returned. Otherwise, a new logger will be instantiated and
  22064. then linked with its existing ancestors as well as children.
  22065. </para>
  22066. </remarks>
  22067. </member>
  22068. <member name="M:log4net.Repository.ILoggerRepository.Shutdown">
  22069. <summary>Shutdown the repository</summary>
  22070. <remarks>
  22071. <para>
  22072. Shutting down a repository will <i>safely</i> close and remove
  22073. all appenders in all loggers including the root logger.
  22074. </para>
  22075. <para>
  22076. Some appenders need to be closed before the
  22077. application exists. Otherwise, pending logging events might be
  22078. lost.
  22079. </para>
  22080. <para>
  22081. The <see cref="M:Shutdown()"/> method is careful to close nested
  22082. appenders before closing regular appenders. This is allows
  22083. configurations where a regular appender is attached to a logger
  22084. and again to a nested appender.
  22085. </para>
  22086. </remarks>
  22087. </member>
  22088. <member name="M:log4net.Repository.ILoggerRepository.ResetConfiguration">
  22089. <summary>
  22090. Reset the repositories configuration to a default state
  22091. </summary>
  22092. <remarks>
  22093. <para>
  22094. Reset all values contained in this instance to their
  22095. default state.
  22096. </para>
  22097. <para>
  22098. Existing loggers are not removed. They are just reset.
  22099. </para>
  22100. <para>
  22101. This method should be used sparingly and with care as it will
  22102. block all logging until it is completed.
  22103. </para>
  22104. </remarks>
  22105. </member>
  22106. <member name="M:log4net.Repository.ILoggerRepository.Log(log4net.Core.LoggingEvent)">
  22107. <summary>
  22108. Log the <see cref="T:log4net.Core.LoggingEvent"/> through this repository.
  22109. </summary>
  22110. <param name="logEvent">the event to log</param>
  22111. <remarks>
  22112. <para>
  22113. This method should not normally be used to log.
  22114. The <see cref="T:log4net.ILog"/> interface should be used
  22115. for routine logging. This interface can be obtained
  22116. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  22117. </para>
  22118. <para>
  22119. The <c>logEvent</c> is delivered to the appropriate logger and
  22120. that logger is then responsible for logging the event.
  22121. </para>
  22122. </remarks>
  22123. </member>
  22124. <member name="M:log4net.Repository.ILoggerRepository.GetAppenders">
  22125. <summary>
  22126. Returns all the Appenders that are configured as an Array.
  22127. </summary>
  22128. <returns>All the Appenders</returns>
  22129. <remarks>
  22130. <para>
  22131. Returns all the Appenders that are configured as an Array.
  22132. </para>
  22133. </remarks>
  22134. </member>
  22135. <member name="P:log4net.Repository.ILoggerRepository.Name">
  22136. <summary>
  22137. The name of the repository
  22138. </summary>
  22139. <value>
  22140. The name of the repository
  22141. </value>
  22142. <remarks>
  22143. <para>
  22144. The name of the repository.
  22145. </para>
  22146. </remarks>
  22147. </member>
  22148. <member name="P:log4net.Repository.ILoggerRepository.RendererMap">
  22149. <summary>
  22150. RendererMap accesses the object renderer map for this repository.
  22151. </summary>
  22152. <value>
  22153. RendererMap accesses the object renderer map for this repository.
  22154. </value>
  22155. <remarks>
  22156. <para>
  22157. RendererMap accesses the object renderer map for this repository.
  22158. </para>
  22159. <para>
  22160. The RendererMap holds a mapping between types and
  22161. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  22162. </para>
  22163. </remarks>
  22164. </member>
  22165. <member name="P:log4net.Repository.ILoggerRepository.PluginMap">
  22166. <summary>
  22167. The plugin map for this repository.
  22168. </summary>
  22169. <value>
  22170. The plugin map for this repository.
  22171. </value>
  22172. <remarks>
  22173. <para>
  22174. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  22175. that have been attached to this repository.
  22176. </para>
  22177. </remarks>
  22178. </member>
  22179. <member name="P:log4net.Repository.ILoggerRepository.LevelMap">
  22180. <summary>
  22181. Get the level map for the Repository.
  22182. </summary>
  22183. <remarks>
  22184. <para>
  22185. Get the level map for the Repository.
  22186. </para>
  22187. <para>
  22188. The level map defines the mappings between
  22189. level names and <see cref="T:log4net.Core.Level"/> objects in
  22190. this repository.
  22191. </para>
  22192. </remarks>
  22193. </member>
  22194. <member name="P:log4net.Repository.ILoggerRepository.Threshold">
  22195. <summary>
  22196. The threshold for all events in this repository
  22197. </summary>
  22198. <value>
  22199. The threshold for all events in this repository
  22200. </value>
  22201. <remarks>
  22202. <para>
  22203. The threshold for all events in this repository.
  22204. </para>
  22205. </remarks>
  22206. </member>
  22207. <member name="P:log4net.Repository.ILoggerRepository.Configured">
  22208. <summary>
  22209. Flag indicates if this repository has been configured.
  22210. </summary>
  22211. <value>
  22212. Flag indicates if this repository has been configured.
  22213. </value>
  22214. <remarks>
  22215. <para>
  22216. Flag indicates if this repository has been configured.
  22217. </para>
  22218. </remarks>
  22219. </member>
  22220. <member name="P:log4net.Repository.ILoggerRepository.ConfigurationMessages">
  22221. <summary>
  22222. Collection of internal messages captured during the most
  22223. recent configuration process.
  22224. </summary>
  22225. </member>
  22226. <member name="E:log4net.Repository.ILoggerRepository.ShutdownEvent">
  22227. <summary>
  22228. Event to notify that the repository has been shutdown.
  22229. </summary>
  22230. <value>
  22231. Event to notify that the repository has been shutdown.
  22232. </value>
  22233. <remarks>
  22234. <para>
  22235. Event raised when the repository has been shutdown.
  22236. </para>
  22237. </remarks>
  22238. </member>
  22239. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationReset">
  22240. <summary>
  22241. Event to notify that the repository has had its configuration reset.
  22242. </summary>
  22243. <value>
  22244. Event to notify that the repository has had its configuration reset.
  22245. </value>
  22246. <remarks>
  22247. <para>
  22248. Event raised when the repository's configuration has been
  22249. reset to default.
  22250. </para>
  22251. </remarks>
  22252. </member>
  22253. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationChanged">
  22254. <summary>
  22255. Event to notify that the repository has had its configuration changed.
  22256. </summary>
  22257. <value>
  22258. Event to notify that the repository has had its configuration changed.
  22259. </value>
  22260. <remarks>
  22261. <para>
  22262. Event raised when the repository's configuration has been changed.
  22263. </para>
  22264. </remarks>
  22265. </member>
  22266. <member name="P:log4net.Repository.ILoggerRepository.Properties">
  22267. <summary>
  22268. Repository specific properties
  22269. </summary>
  22270. <value>
  22271. Repository specific properties
  22272. </value>
  22273. <remarks>
  22274. <para>
  22275. These properties can be specified on a repository specific basis.
  22276. </para>
  22277. </remarks>
  22278. </member>
  22279. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor">
  22280. <summary>
  22281. Default Constructor
  22282. </summary>
  22283. <remarks>
  22284. <para>
  22285. Initializes the repository with default (empty) properties.
  22286. </para>
  22287. </remarks>
  22288. </member>
  22289. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor(log4net.Util.PropertiesDictionary)">
  22290. <summary>
  22291. Construct the repository using specific properties
  22292. </summary>
  22293. <param name="properties">the properties to set for this repository</param>
  22294. <remarks>
  22295. <para>
  22296. Initializes the repository with specified properties.
  22297. </para>
  22298. </remarks>
  22299. </member>
  22300. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Exists(System.String)">
  22301. <summary>
  22302. Test if logger exists
  22303. </summary>
  22304. <param name="name">The name of the logger to lookup</param>
  22305. <returns>The Logger object with the name specified</returns>
  22306. <remarks>
  22307. <para>
  22308. Check if the named logger exists in the repository. If so return
  22309. its reference, otherwise returns <c>null</c>.
  22310. </para>
  22311. </remarks>
  22312. </member>
  22313. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetCurrentLoggers">
  22314. <summary>
  22315. Returns all the currently defined loggers in the repository
  22316. </summary>
  22317. <returns>All the defined loggers</returns>
  22318. <remarks>
  22319. <para>
  22320. Returns all the currently defined loggers in the repository as an Array.
  22321. </para>
  22322. </remarks>
  22323. </member>
  22324. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetLogger(System.String)">
  22325. <summary>
  22326. Return a new logger instance
  22327. </summary>
  22328. <param name="name">The name of the logger to retrieve</param>
  22329. <returns>The logger object with the name specified</returns>
  22330. <remarks>
  22331. <para>
  22332. Return a new logger instance.
  22333. </para>
  22334. <para>
  22335. If a logger of that name already exists, then it will be
  22336. returned. Otherwise, a new logger will be instantiated and
  22337. then linked with its existing ancestors as well as children.
  22338. </para>
  22339. </remarks>
  22340. </member>
  22341. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Shutdown">
  22342. <summary>
  22343. Shutdown the repository
  22344. </summary>
  22345. <remarks>
  22346. <para>
  22347. Shutdown the repository. Can be overridden in a subclass.
  22348. This base class implementation notifies the <see cref="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent"/>
  22349. listeners and all attached plugins of the shutdown event.
  22350. </para>
  22351. </remarks>
  22352. </member>
  22353. <member name="M:log4net.Repository.LoggerRepositorySkeleton.ResetConfiguration">
  22354. <summary>
  22355. Reset the repositories configuration to a default state
  22356. </summary>
  22357. <remarks>
  22358. <para>
  22359. Reset all values contained in this instance to their
  22360. default state.
  22361. </para>
  22362. <para>
  22363. Existing loggers are not removed. They are just reset.
  22364. </para>
  22365. <para>
  22366. This method should be used sparingly and with care as it will
  22367. block all logging until it is completed.
  22368. </para>
  22369. </remarks>
  22370. </member>
  22371. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Log(log4net.Core.LoggingEvent)">
  22372. <summary>
  22373. Log the logEvent through this repository.
  22374. </summary>
  22375. <param name="logEvent">the event to log</param>
  22376. <remarks>
  22377. <para>
  22378. This method should not normally be used to log.
  22379. The <see cref="T:log4net.ILog"/> interface should be used
  22380. for routine logging. This interface can be obtained
  22381. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  22382. </para>
  22383. <para>
  22384. The <c>logEvent</c> is delivered to the appropriate logger and
  22385. that logger is then responsible for logging the event.
  22386. </para>
  22387. </remarks>
  22388. </member>
  22389. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetAppenders">
  22390. <summary>
  22391. Returns all the Appenders that are configured as an Array.
  22392. </summary>
  22393. <returns>All the Appenders</returns>
  22394. <remarks>
  22395. <para>
  22396. Returns all the Appenders that are configured as an Array.
  22397. </para>
  22398. </remarks>
  22399. </member>
  22400. <member name="F:log4net.Repository.LoggerRepositorySkeleton.declaringType">
  22401. <summary>
  22402. The fully qualified type of the LoggerRepositorySkeleton class.
  22403. </summary>
  22404. <remarks>
  22405. Used by the internal logger to record the Type of the
  22406. log message.
  22407. </remarks>
  22408. </member>
  22409. <member name="M:log4net.Repository.LoggerRepositorySkeleton.AddRenderer(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  22410. <summary>
  22411. Adds an object renderer for a specific class.
  22412. </summary>
  22413. <param name="typeToRender">The type that will be rendered by the renderer supplied.</param>
  22414. <param name="rendererInstance">The object renderer used to render the object.</param>
  22415. <remarks>
  22416. <para>
  22417. Adds an object renderer for a specific class.
  22418. </para>
  22419. </remarks>
  22420. </member>
  22421. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnShutdown(System.EventArgs)">
  22422. <summary>
  22423. Notify the registered listeners that the repository is shutting down
  22424. </summary>
  22425. <param name="e">Empty EventArgs</param>
  22426. <remarks>
  22427. <para>
  22428. Notify any listeners that this repository is shutting down.
  22429. </para>
  22430. </remarks>
  22431. </member>
  22432. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationReset(System.EventArgs)">
  22433. <summary>
  22434. Notify the registered listeners that the repository has had its configuration reset
  22435. </summary>
  22436. <param name="e">Empty EventArgs</param>
  22437. <remarks>
  22438. <para>
  22439. Notify any listeners that this repository's configuration has been reset.
  22440. </para>
  22441. </remarks>
  22442. </member>
  22443. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationChanged(System.EventArgs)">
  22444. <summary>
  22445. Notify the registered listeners that the repository has had its configuration changed
  22446. </summary>
  22447. <param name="e">Empty EventArgs</param>
  22448. <remarks>
  22449. <para>
  22450. Notify any listeners that this repository's configuration has changed.
  22451. </para>
  22452. </remarks>
  22453. </member>
  22454. <member name="M:log4net.Repository.LoggerRepositorySkeleton.RaiseConfigurationChanged(System.EventArgs)">
  22455. <summary>
  22456. Raise a configuration changed event on this repository
  22457. </summary>
  22458. <param name="e">EventArgs.Empty</param>
  22459. <remarks>
  22460. <para>
  22461. Applications that programmatically change the configuration of the repository should
  22462. raise this event notification to notify listeners.
  22463. </para>
  22464. </remarks>
  22465. </member>
  22466. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Flush(System.Int32)">
  22467. <summary>
  22468. Flushes all configured Appenders that implement <see cref="T:log4net.Appender.IFlushable"/>.
  22469. </summary>
  22470. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed,
  22471. or <see cref="F:System.Threading.Timeout.Infinite"/> to wait indefinitely.</param>
  22472. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  22473. </member>
  22474. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Name">
  22475. <summary>
  22476. The name of the repository
  22477. </summary>
  22478. <value>
  22479. The string name of the repository
  22480. </value>
  22481. <remarks>
  22482. <para>
  22483. The name of this repository. The name is
  22484. used to store and lookup the repositories
  22485. stored by the <see cref="T:log4net.Core.IRepositorySelector"/>.
  22486. </para>
  22487. </remarks>
  22488. </member>
  22489. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Threshold">
  22490. <summary>
  22491. The threshold for all events in this repository
  22492. </summary>
  22493. <value>
  22494. The threshold for all events in this repository
  22495. </value>
  22496. <remarks>
  22497. <para>
  22498. The threshold for all events in this repository
  22499. </para>
  22500. </remarks>
  22501. </member>
  22502. <member name="P:log4net.Repository.LoggerRepositorySkeleton.RendererMap">
  22503. <summary>
  22504. RendererMap accesses the object renderer map for this repository.
  22505. </summary>
  22506. <value>
  22507. RendererMap accesses the object renderer map for this repository.
  22508. </value>
  22509. <remarks>
  22510. <para>
  22511. RendererMap accesses the object renderer map for this repository.
  22512. </para>
  22513. <para>
  22514. The RendererMap holds a mapping between types and
  22515. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  22516. </para>
  22517. </remarks>
  22518. </member>
  22519. <member name="P:log4net.Repository.LoggerRepositorySkeleton.PluginMap">
  22520. <summary>
  22521. The plugin map for this repository.
  22522. </summary>
  22523. <value>
  22524. The plugin map for this repository.
  22525. </value>
  22526. <remarks>
  22527. <para>
  22528. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  22529. that have been attached to this repository.
  22530. </para>
  22531. </remarks>
  22532. </member>
  22533. <member name="P:log4net.Repository.LoggerRepositorySkeleton.LevelMap">
  22534. <summary>
  22535. Get the level map for the Repository.
  22536. </summary>
  22537. <remarks>
  22538. <para>
  22539. Get the level map for the Repository.
  22540. </para>
  22541. <para>
  22542. The level map defines the mappings between
  22543. level names and <see cref="T:log4net.Core.Level"/> objects in
  22544. this repository.
  22545. </para>
  22546. </remarks>
  22547. </member>
  22548. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Configured">
  22549. <summary>
  22550. Flag indicates if this repository has been configured.
  22551. </summary>
  22552. <value>
  22553. Flag indicates if this repository has been configured.
  22554. </value>
  22555. <remarks>
  22556. <para>
  22557. Flag indicates if this repository has been configured.
  22558. </para>
  22559. </remarks>
  22560. </member>
  22561. <member name="P:log4net.Repository.LoggerRepositorySkeleton.ConfigurationMessages">
  22562. <summary>
  22563. Contains a list of internal messages captures during the
  22564. last configuration.
  22565. </summary>
  22566. </member>
  22567. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent">
  22568. <summary>
  22569. Event to notify that the repository has been shutdown.
  22570. </summary>
  22571. <value>
  22572. Event to notify that the repository has been shutdown.
  22573. </value>
  22574. <remarks>
  22575. <para>
  22576. Event raised when the repository has been shutdown.
  22577. </para>
  22578. </remarks>
  22579. </member>
  22580. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationReset">
  22581. <summary>
  22582. Event to notify that the repository has had its configuration reset.
  22583. </summary>
  22584. <value>
  22585. Event to notify that the repository has had its configuration reset.
  22586. </value>
  22587. <remarks>
  22588. <para>
  22589. Event raised when the repository's configuration has been
  22590. reset to default.
  22591. </para>
  22592. </remarks>
  22593. </member>
  22594. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationChanged">
  22595. <summary>
  22596. Event to notify that the repository has had its configuration changed.
  22597. </summary>
  22598. <value>
  22599. Event to notify that the repository has had its configuration changed.
  22600. </value>
  22601. <remarks>
  22602. <para>
  22603. Event raised when the repository's configuration has been changed.
  22604. </para>
  22605. </remarks>
  22606. </member>
  22607. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Properties">
  22608. <summary>
  22609. Repository specific properties
  22610. </summary>
  22611. <value>
  22612. Repository specific properties
  22613. </value>
  22614. <remarks>
  22615. These properties can be specified on a repository specific basis
  22616. </remarks>
  22617. </member>
  22618. <member name="T:log4net.Repository.IBasicRepositoryConfigurator">
  22619. <summary>
  22620. Basic Configurator interface for repositories
  22621. </summary>
  22622. <remarks>
  22623. <para>
  22624. Interface used by basic configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>
  22625. with a default <see cref="T:log4net.Appender.IAppender"/>.
  22626. </para>
  22627. <para>
  22628. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  22629. configuration by the <see cref="T:log4net.Config.BasicConfigurator"/>.
  22630. </para>
  22631. </remarks>
  22632. <author>Nicko Cadell</author>
  22633. <author>Gert Driesen</author>
  22634. </member>
  22635. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender)">
  22636. <summary>
  22637. Initialize the repository using the specified appender
  22638. </summary>
  22639. <param name="appender">the appender to use to log all logging events</param>
  22640. <remarks>
  22641. <para>
  22642. Configure the repository to route all logging events to the
  22643. specified appender.
  22644. </para>
  22645. </remarks>
  22646. </member>
  22647. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender[])">
  22648. <summary>
  22649. Initialize the repository using the specified appenders
  22650. </summary>
  22651. <param name="appenders">the appenders to use to log all logging events</param>
  22652. <remarks>
  22653. <para>
  22654. Configure the repository to route all logging events to the
  22655. specified appenders.
  22656. </para>
  22657. </remarks>
  22658. </member>
  22659. <member name="T:log4net.Repository.IXmlRepositoryConfigurator">
  22660. <summary>
  22661. Configure repository using XML
  22662. </summary>
  22663. <remarks>
  22664. <para>
  22665. Interface used by Xml configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  22666. </para>
  22667. <para>
  22668. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  22669. configuration by the <see cref="T:log4net.Config.XmlConfigurator"/>.
  22670. </para>
  22671. </remarks>
  22672. <author>Nicko Cadell</author>
  22673. <author>Gert Driesen</author>
  22674. </member>
  22675. <member name="M:log4net.Repository.IXmlRepositoryConfigurator.Configure(System.Xml.XmlElement)">
  22676. <summary>
  22677. Initialize the repository using the specified config
  22678. </summary>
  22679. <param name="element">the element containing the root of the config</param>
  22680. <remarks>
  22681. <para>
  22682. The schema for the XML configuration data is defined by
  22683. the implementation.
  22684. </para>
  22685. </remarks>
  22686. </member>
  22687. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor">
  22688. <summary>
  22689. Default constructor
  22690. </summary>
  22691. <remarks>
  22692. <para>
  22693. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class.
  22694. </para>
  22695. </remarks>
  22696. </member>
  22697. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary)">
  22698. <summary>
  22699. Construct with properties
  22700. </summary>
  22701. <param name="properties">The properties to pass to this repository.</param>
  22702. <remarks>
  22703. <para>
  22704. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class.
  22705. </para>
  22706. </remarks>
  22707. </member>
  22708. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Repository.Hierarchy.ILoggerFactory)">
  22709. <summary>
  22710. Construct with a logger factory
  22711. </summary>
  22712. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  22713. <remarks>
  22714. <para>
  22715. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with
  22716. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>.
  22717. </para>
  22718. </remarks>
  22719. </member>
  22720. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary,log4net.Repository.Hierarchy.ILoggerFactory)">
  22721. <summary>
  22722. Construct with properties and a logger factory
  22723. </summary>
  22724. <param name="properties">The properties to pass to this repository.</param>
  22725. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  22726. <remarks>
  22727. <para>
  22728. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with
  22729. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>.
  22730. </para>
  22731. </remarks>
  22732. </member>
  22733. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Exists(System.String)">
  22734. <summary>
  22735. Test if a logger exists
  22736. </summary>
  22737. <param name="name">The name of the logger to lookup</param>
  22738. <returns>The Logger object with the name specified</returns>
  22739. <remarks>
  22740. <para>
  22741. Check if the named logger exists in the hierarchy. If so return
  22742. its reference, otherwise returns <c>null</c>.
  22743. </para>
  22744. </remarks>
  22745. </member>
  22746. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetCurrentLoggers">
  22747. <summary>
  22748. Returns all the currently defined loggers in the hierarchy as an Array
  22749. </summary>
  22750. <returns>All the defined loggers</returns>
  22751. <remarks>
  22752. <para>
  22753. Returns all the currently defined loggers in the hierarchy as an Array.
  22754. The root logger is <b>not</b> included in the returned
  22755. enumeration.
  22756. </para>
  22757. </remarks>
  22758. </member>
  22759. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String)">
  22760. <summary>
  22761. Return a new logger instance named as the first parameter using
  22762. the default factory.
  22763. </summary>
  22764. <remarks>
  22765. <para>
  22766. Return a new logger instance named as the first parameter using
  22767. the default factory.
  22768. </para>
  22769. <para>
  22770. If a logger of that name already exists, then it will be
  22771. returned. Otherwise, a new logger will be instantiated and
  22772. then linked with its existing ancestors as well as children.
  22773. </para>
  22774. </remarks>
  22775. <param name="name">The name of the logger to retrieve</param>
  22776. <returns>The logger object with the name specified</returns>
  22777. </member>
  22778. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Shutdown">
  22779. <summary>
  22780. Shutting down a hierarchy will <i>safely</i> close and remove
  22781. all appenders in all loggers including the root logger.
  22782. </summary>
  22783. <remarks>
  22784. <para>
  22785. Shutting down a hierarchy will <i>safely</i> close and remove
  22786. all appenders in all loggers including the root logger.
  22787. </para>
  22788. <para>
  22789. Some appenders need to be closed before the
  22790. application exists. Otherwise, pending logging events might be
  22791. lost.
  22792. </para>
  22793. <para>
  22794. The <c>Shutdown</c> method is careful to close nested
  22795. appenders before closing regular appenders. This is allows
  22796. configurations where a regular appender is attached to a logger
  22797. and again to a nested appender.
  22798. </para>
  22799. </remarks>
  22800. </member>
  22801. <member name="M:log4net.Repository.Hierarchy.Hierarchy.ResetConfiguration">
  22802. <summary>
  22803. Reset all values contained in this hierarchy instance to their default.
  22804. </summary>
  22805. <remarks>
  22806. <para>
  22807. Reset all values contained in this hierarchy instance to their
  22808. default. This removes all appenders from all loggers, sets
  22809. the level of all non-root loggers to <c>null</c>,
  22810. sets their additivity flag to <c>true</c> and sets the level
  22811. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  22812. message disabling is set its default "off" value.
  22813. </para>
  22814. <para>
  22815. Existing loggers are not removed. They are just reset.
  22816. </para>
  22817. <para>
  22818. This method should be used sparingly and with care as it will
  22819. block all logging until it is completed.
  22820. </para>
  22821. </remarks>
  22822. </member>
  22823. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Log(log4net.Core.LoggingEvent)">
  22824. <summary>
  22825. Log the logEvent through this hierarchy.
  22826. </summary>
  22827. <param name="logEvent">the event to log</param>
  22828. <remarks>
  22829. <para>
  22830. This method should not normally be used to log.
  22831. The <see cref="T:log4net.ILog"/> interface should be used
  22832. for routine logging. This interface can be obtained
  22833. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  22834. </para>
  22835. <para>
  22836. The <c>logEvent</c> is delivered to the appropriate logger and
  22837. that logger is then responsible for logging the event.
  22838. </para>
  22839. </remarks>
  22840. </member>
  22841. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetAppenders">
  22842. <summary>
  22843. Returns all the Appenders that are currently configured
  22844. </summary>
  22845. <returns>An array containing all the currently configured appenders</returns>
  22846. <remarks>
  22847. <para>
  22848. Returns all the <see cref="T:log4net.Appender.IAppender"/> instances that are currently configured.
  22849. All the loggers are searched for appenders. The appenders may also be containers
  22850. for appenders and these are also searched for additional loggers.
  22851. </para>
  22852. <para>
  22853. The list returned is unordered but does not contain duplicates.
  22854. </para>
  22855. </remarks>
  22856. </member>
  22857. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppender(System.Collections.ArrayList,log4net.Appender.IAppender)">
  22858. <summary>
  22859. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/>.
  22860. The appender may also be a container.
  22861. </summary>
  22862. <param name="appenderList"></param>
  22863. <param name="appender"></param>
  22864. </member>
  22865. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppenders(System.Collections.ArrayList,log4net.Core.IAppenderAttachable)">
  22866. <summary>
  22867. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/> container
  22868. </summary>
  22869. <param name="appenderList"></param>
  22870. <param name="container"></param>
  22871. </member>
  22872. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender)">
  22873. <summary>
  22874. Initialize the log4net system using the specified appender
  22875. </summary>
  22876. <param name="appender">the appender to use to log all logging events</param>
  22877. </member>
  22878. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender[])">
  22879. <summary>
  22880. Initialize the log4net system using the specified appenders
  22881. </summary>
  22882. <param name="appenders">the appenders to use to log all logging events</param>
  22883. </member>
  22884. <member name="M:log4net.Repository.Hierarchy.Hierarchy.BasicRepositoryConfigure(log4net.Appender.IAppender[])">
  22885. <summary>
  22886. Initialize the log4net system using the specified appenders
  22887. </summary>
  22888. <param name="appenders">the appenders to use to log all logging events</param>
  22889. <remarks>
  22890. <para>
  22891. This method provides the same functionality as the
  22892. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  22893. on this object, but it is protected and therefore can be called by subclasses.
  22894. </para>
  22895. </remarks>
  22896. </member>
  22897. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IXmlRepositoryConfigurator#Configure(System.Xml.XmlElement)">
  22898. <summary>
  22899. Initialize the log4net system using the specified config
  22900. </summary>
  22901. <param name="element">the element containing the root of the config</param>
  22902. </member>
  22903. <member name="M:log4net.Repository.Hierarchy.Hierarchy.XmlRepositoryConfigure(System.Xml.XmlElement)">
  22904. <summary>
  22905. Initialize the log4net system using the specified config
  22906. </summary>
  22907. <param name="element">the element containing the root of the config</param>
  22908. <remarks>
  22909. <para>
  22910. This method provides the same functionality as the
  22911. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  22912. on this object, but it is protected and therefore can be called by subclasses.
  22913. </para>
  22914. </remarks>
  22915. </member>
  22916. <member name="M:log4net.Repository.Hierarchy.Hierarchy.IsDisabled(log4net.Core.Level)">
  22917. <summary>
  22918. Test if this hierarchy is disabled for the specified <see cref="T:log4net.Core.Level"/>.
  22919. </summary>
  22920. <param name="level">The level to check against.</param>
  22921. <returns>
  22922. <c>true</c> if the repository is disabled for the level argument, <c>false</c> otherwise.
  22923. </returns>
  22924. <remarks>
  22925. <para>
  22926. If this hierarchy has not been configured then this method will
  22927. always return <c>true</c>.
  22928. </para>
  22929. <para>
  22930. This method will return <c>true</c> if this repository is
  22931. disabled for <c>level</c> object passed as parameter and
  22932. <c>false</c> otherwise.
  22933. </para>
  22934. <para>
  22935. See also the <see cref="P:log4net.Repository.ILoggerRepository.Threshold"/> property.
  22936. </para>
  22937. </remarks>
  22938. </member>
  22939. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Clear">
  22940. <summary>
  22941. Clear all logger definitions from the internal hashtable
  22942. </summary>
  22943. <remarks>
  22944. <para>
  22945. This call will clear all logger definitions from the internal
  22946. hashtable. Invoking this method will irrevocably mess up the
  22947. logger hierarchy.
  22948. </para>
  22949. <para>
  22950. You should <b>really</b> know what you are doing before
  22951. invoking this method.
  22952. </para>
  22953. </remarks>
  22954. </member>
  22955. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String,log4net.Repository.Hierarchy.ILoggerFactory)">
  22956. <summary>
  22957. Return a new logger instance named as the first parameter using
  22958. <paramref name="factory"/>.
  22959. </summary>
  22960. <param name="name">The name of the logger to retrieve</param>
  22961. <param name="factory">The factory that will make the new logger instance</param>
  22962. <returns>The logger object with the name specified</returns>
  22963. <remarks>
  22964. <para>
  22965. If a logger of that name already exists, then it will be
  22966. returned. Otherwise, a new logger will be instantiated by the
  22967. <paramref name="factory"/> parameter and linked with its existing
  22968. ancestors as well as children.
  22969. </para>
  22970. </remarks>
  22971. </member>
  22972. <member name="M:log4net.Repository.Hierarchy.Hierarchy.OnLoggerCreationEvent(log4net.Repository.Hierarchy.Logger)">
  22973. <summary>
  22974. Sends a logger creation event to all registered listeners
  22975. </summary>
  22976. <param name="logger">The newly created logger</param>
  22977. <remarks>
  22978. Raises the logger creation event.
  22979. </remarks>
  22980. </member>
  22981. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateParents(log4net.Repository.Hierarchy.Logger)">
  22982. <summary>
  22983. Updates all the parents of the specified logger
  22984. </summary>
  22985. <param name="log">The logger to update the parents for</param>
  22986. <remarks>
  22987. <para>
  22988. This method loops through all the <i>potential</i> parents of
  22989. <paramref name="log"/>. There 3 possible cases:
  22990. </para>
  22991. <list type="number">
  22992. <item>
  22993. <term>No entry for the potential parent of <paramref name="log"/> exists</term>
  22994. <description>
  22995. We create a ProvisionNode for this potential
  22996. parent and insert <paramref name="log"/> in that provision node.
  22997. </description>
  22998. </item>
  22999. <item>
  23000. <term>The entry is of type Logger for the potential parent.</term>
  23001. <description>
  23002. The entry is <paramref name="log"/>'s nearest existing parent. We
  23003. update <paramref name="log"/>'s parent field with this entry. We also break from
  23004. he loop because updating our parent's parent is our parent's
  23005. responsibility.
  23006. </description>
  23007. </item>
  23008. <item>
  23009. <term>The entry is of type ProvisionNode for this potential parent.</term>
  23010. <description>
  23011. We add <paramref name="log"/> to the list of children for this
  23012. potential parent.
  23013. </description>
  23014. </item>
  23015. </list>
  23016. </remarks>
  23017. </member>
  23018. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateChildren(log4net.Repository.Hierarchy.ProvisionNode,log4net.Repository.Hierarchy.Logger)">
  23019. <summary>
  23020. Replace a <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> with a <see cref="T:log4net.Repository.Hierarchy.Logger"/> in the hierarchy.
  23021. </summary>
  23022. <param name="pn"></param>
  23023. <param name="log"></param>
  23024. <remarks>
  23025. <para>
  23026. We update the links for all the children that placed themselves
  23027. in the provision node 'pn'. The second argument 'log' is a
  23028. reference for the newly created Logger, parent of all the
  23029. children in 'pn'.
  23030. </para>
  23031. <para>
  23032. We loop on all the children 'c' in 'pn'.
  23033. </para>
  23034. <para>
  23035. If the child 'c' has been already linked to a child of
  23036. 'log' then there is no need to update 'c'.
  23037. </para>
  23038. <para>
  23039. Otherwise, we set log's parent field to c's parent and set
  23040. c's parent field to log.
  23041. </para>
  23042. </remarks>
  23043. </member>
  23044. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddLevel(log4net.Repository.Hierarchy.Hierarchy.LevelEntry)">
  23045. <summary>
  23046. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  23047. </summary>
  23048. <param name="levelEntry">the level values</param>
  23049. <remarks>
  23050. <para>
  23051. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  23052. </para>
  23053. <para>
  23054. Supports setting levels via the configuration file.
  23055. </para>
  23056. </remarks>
  23057. </member>
  23058. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddProperty(log4net.Util.PropertyEntry)">
  23059. <summary>
  23060. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  23061. </summary>
  23062. <param name="propertyEntry">the property value</param>
  23063. <remarks>
  23064. <para>
  23065. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument.
  23066. </para>
  23067. <para>
  23068. Supports setting property values via the configuration file.
  23069. </para>
  23070. </remarks>
  23071. </member>
  23072. <member name="F:log4net.Repository.Hierarchy.Hierarchy.declaringType">
  23073. <summary>
  23074. The fully qualified type of the Hierarchy class.
  23075. </summary>
  23076. <remarks>
  23077. Used by the internal logger to record the Type of the
  23078. log message.
  23079. </remarks>
  23080. </member>
  23081. <member name="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent">
  23082. <summary>
  23083. Event used to notify that a logger has been created.
  23084. </summary>
  23085. <remarks>
  23086. <para>
  23087. Event raised when a logger is created.
  23088. </para>
  23089. </remarks>
  23090. </member>
  23091. <member name="P:log4net.Repository.Hierarchy.Hierarchy.EmittedNoAppenderWarning">
  23092. <summary>
  23093. Has no appender warning been emitted
  23094. </summary>
  23095. <remarks>
  23096. <para>
  23097. Flag to indicate if we have already issued a warning
  23098. about not having an appender warning.
  23099. </para>
  23100. </remarks>
  23101. </member>
  23102. <member name="P:log4net.Repository.Hierarchy.Hierarchy.Root">
  23103. <summary>
  23104. Get the root of this hierarchy
  23105. </summary>
  23106. <remarks>
  23107. <para>
  23108. Get the root of this hierarchy.
  23109. </para>
  23110. </remarks>
  23111. </member>
  23112. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LoggerFactory">
  23113. <summary>
  23114. Gets or sets the default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/> instance.
  23115. </summary>
  23116. <value>The default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/></value>
  23117. <remarks>
  23118. <para>
  23119. The logger factory is used to create logger instances.
  23120. </para>
  23121. </remarks>
  23122. </member>
  23123. <member name="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry">
  23124. <summary>
  23125. A class to hold the value, name and display name for a level
  23126. </summary>
  23127. <remarks>
  23128. <para>
  23129. A class to hold the value, name and display name for a level
  23130. </para>
  23131. </remarks>
  23132. </member>
  23133. <member name="M:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.ToString">
  23134. <summary>
  23135. Override <c>Object.ToString</c> to return sensible debug info
  23136. </summary>
  23137. <returns>string info about this object</returns>
  23138. </member>
  23139. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Value">
  23140. <summary>
  23141. Value of the level
  23142. </summary>
  23143. <remarks>
  23144. <para>
  23145. If the value is not set (defaults to -1) the value will be looked
  23146. up for the current level with the same name.
  23147. </para>
  23148. </remarks>
  23149. </member>
  23150. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Name">
  23151. <summary>
  23152. Name of the level
  23153. </summary>
  23154. <value>
  23155. The name of the level
  23156. </value>
  23157. <remarks>
  23158. <para>
  23159. The name of the level.
  23160. </para>
  23161. </remarks>
  23162. </member>
  23163. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.DisplayName">
  23164. <summary>
  23165. Display name for the level
  23166. </summary>
  23167. <value>
  23168. The display name of the level
  23169. </value>
  23170. <remarks>
  23171. <para>
  23172. The display name of the level.
  23173. </para>
  23174. </remarks>
  23175. </member>
  23176. <member name="T:log4net.Repository.Hierarchy.LoggerKey">
  23177. <summary>
  23178. Used internally to accelerate hash table searches.
  23179. </summary>
  23180. <remarks>
  23181. <para>
  23182. Internal class used to improve performance of
  23183. string keyed hashtables.
  23184. </para>
  23185. <para>
  23186. The hashcode of the string is cached for reuse.
  23187. The string is stored as an interned value.
  23188. When comparing two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> objects for equality
  23189. the reference equality of the interned strings is compared.
  23190. </para>
  23191. </remarks>
  23192. <author>Nicko Cadell</author>
  23193. <author>Gert Driesen</author>
  23194. </member>
  23195. <member name="M:log4net.Repository.Hierarchy.LoggerKey.#ctor(System.String)">
  23196. <summary>
  23197. Construct key with string name
  23198. </summary>
  23199. <remarks>
  23200. <para>
  23201. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> class
  23202. with the specified name.
  23203. </para>
  23204. <para>
  23205. Stores the hashcode of the string and interns
  23206. the string key to optimize comparisons.
  23207. </para>
  23208. <note>
  23209. The Compact Framework 1.0 the <see cref="M:System.String.Intern(System.String)"/>
  23210. method does not work. On the Compact Framework
  23211. the string keys are not interned nor are they
  23212. compared by reference.
  23213. </note>
  23214. </remarks>
  23215. <param name="name">The name of the logger.</param>
  23216. </member>
  23217. <member name="M:log4net.Repository.Hierarchy.LoggerKey.GetHashCode">
  23218. <summary>
  23219. Returns a hash code for the current instance.
  23220. </summary>
  23221. <returns>A hash code for the current instance.</returns>
  23222. <remarks>
  23223. <para>
  23224. Returns the cached hashcode.
  23225. </para>
  23226. </remarks>
  23227. </member>
  23228. <member name="M:log4net.Repository.Hierarchy.LoggerKey.Equals(System.Object)">
  23229. <summary>
  23230. Determines whether two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> instances
  23231. are equal.
  23232. </summary>
  23233. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/>.</param>
  23234. <returns>
  23235. <c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/>; otherwise, <c>false</c>.
  23236. </returns>
  23237. <remarks>
  23238. <para>
  23239. Compares the references of the interned strings.
  23240. </para>
  23241. </remarks>
  23242. </member>
  23243. <member name="T:log4net.Repository.Hierarchy.ProvisionNode">
  23244. <summary>
  23245. Provision nodes are used where no logger instance has been specified
  23246. </summary>
  23247. <remarks>
  23248. <para>
  23249. <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> instances are used in the
  23250. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> when there is no specified
  23251. <see cref="T:log4net.Repository.Hierarchy.Logger"/> for that node.
  23252. </para>
  23253. <para>
  23254. A provision node holds a list of child loggers on behalf of
  23255. a logger that does not exist.
  23256. </para>
  23257. </remarks>
  23258. <author>Nicko Cadell</author>
  23259. <author>Gert Driesen</author>
  23260. </member>
  23261. <member name="M:log4net.Repository.Hierarchy.ProvisionNode.#ctor(log4net.Repository.Hierarchy.Logger)">
  23262. <summary>
  23263. Create a new provision node with child node
  23264. </summary>
  23265. <param name="log">A child logger to add to this node.</param>
  23266. <remarks>
  23267. <para>
  23268. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> class
  23269. with the specified child logger.
  23270. </para>
  23271. </remarks>
  23272. </member>
  23273. <member name="T:log4net.Repository.Hierarchy.RootLogger">
  23274. <summary>
  23275. The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> sits at the root of the logger hierarchy tree.
  23276. </summary>
  23277. <remarks>
  23278. <para>
  23279. The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> is a regular <see cref="T:log4net.Repository.Hierarchy.Logger"/> except
  23280. that it provides several guarantees.
  23281. </para>
  23282. <para>
  23283. First, it cannot be assigned a <c>null</c>
  23284. level. Second, since the root logger cannot have a parent, the
  23285. <see cref="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel"/> property always returns the value of the
  23286. level field without walking the hierarchy.
  23287. </para>
  23288. </remarks>
  23289. <author>Nicko Cadell</author>
  23290. <author>Gert Driesen</author>
  23291. </member>
  23292. <member name="M:log4net.Repository.Hierarchy.RootLogger.#ctor(log4net.Core.Level)">
  23293. <summary>
  23294. Construct a <see cref="T:log4net.Repository.Hierarchy.RootLogger"/>
  23295. </summary>
  23296. <param name="level">The level to assign to the root logger.</param>
  23297. <remarks>
  23298. <para>
  23299. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> class with
  23300. the specified logging level.
  23301. </para>
  23302. <para>
  23303. The root logger names itself as "root". However, the root
  23304. logger cannot be retrieved by name.
  23305. </para>
  23306. </remarks>
  23307. </member>
  23308. <member name="F:log4net.Repository.Hierarchy.RootLogger.declaringType">
  23309. <summary>
  23310. The fully qualified type of the RootLogger class.
  23311. </summary>
  23312. <remarks>
  23313. Used by the internal logger to record the Type of the
  23314. log message.
  23315. </remarks>
  23316. </member>
  23317. <member name="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel">
  23318. <summary>
  23319. Gets the assigned level value without walking the logger hierarchy.
  23320. </summary>
  23321. <value>The assigned level value without walking the logger hierarchy.</value>
  23322. <remarks>
  23323. <para>
  23324. Because the root logger cannot have a parent and its level
  23325. must not be <c>null</c> this property just returns the
  23326. value of <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>.
  23327. </para>
  23328. </remarks>
  23329. </member>
  23330. <member name="P:log4net.Repository.Hierarchy.RootLogger.Level">
  23331. <summary>
  23332. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> for the root logger.
  23333. </summary>
  23334. <value>
  23335. The <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> of the root logger.
  23336. </value>
  23337. <remarks>
  23338. <para>
  23339. Setting the level of the root logger to a <c>null</c> reference
  23340. may have catastrophic results. We prevent this here.
  23341. </para>
  23342. </remarks>
  23343. </member>
  23344. <member name="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator">
  23345. <summary>
  23346. Initializes the log4net environment using an XML DOM.
  23347. </summary>
  23348. <remarks>
  23349. <para>
  23350. Configures a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> using an XML DOM.
  23351. </para>
  23352. </remarks>
  23353. <author>Nicko Cadell</author>
  23354. <author>Gert Driesen</author>
  23355. </member>
  23356. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.#ctor(log4net.Repository.Hierarchy.Hierarchy)">
  23357. <summary>
  23358. Construct the configurator for a hierarchy
  23359. </summary>
  23360. <param name="hierarchy">The hierarchy to build.</param>
  23361. <remarks>
  23362. <para>
  23363. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator"/> class
  23364. with the specified <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  23365. </para>
  23366. </remarks>
  23367. </member>
  23368. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.Configure(System.Xml.XmlElement)">
  23369. <summary>
  23370. Configure the hierarchy by parsing a DOM tree of XML elements.
  23371. </summary>
  23372. <param name="element">The root element to parse.</param>
  23373. <remarks>
  23374. <para>
  23375. Configure the hierarchy by parsing a DOM tree of XML elements.
  23376. </para>
  23377. </remarks>
  23378. </member>
  23379. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindAppenderByReference(System.Xml.XmlElement)">
  23380. <summary>
  23381. Parse appenders by IDREF.
  23382. </summary>
  23383. <param name="appenderRef">The appender ref element.</param>
  23384. <returns>The instance of the appender that the ref refers to.</returns>
  23385. <remarks>
  23386. <para>
  23387. Parse an XML element that represents an appender and return
  23388. the appender.
  23389. </para>
  23390. </remarks>
  23391. </member>
  23392. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseAppender(System.Xml.XmlElement)">
  23393. <summary>
  23394. Parses an appender element.
  23395. </summary>
  23396. <param name="appenderElement">The appender element.</param>
  23397. <returns>The appender instance or <c>null</c> when parsing failed.</returns>
  23398. <remarks>
  23399. <para>
  23400. Parse an XML element that represents an appender and return
  23401. the appender instance.
  23402. </para>
  23403. </remarks>
  23404. </member>
  23405. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLogger(System.Xml.XmlElement)">
  23406. <summary>
  23407. Parses a logger element.
  23408. </summary>
  23409. <param name="loggerElement">The logger element.</param>
  23410. <remarks>
  23411. <para>
  23412. Parse an XML element that represents a logger.
  23413. </para>
  23414. </remarks>
  23415. </member>
  23416. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRoot(System.Xml.XmlElement)">
  23417. <summary>
  23418. Parses the root logger element.
  23419. </summary>
  23420. <param name="rootElement">The root element.</param>
  23421. <remarks>
  23422. <para>
  23423. Parse an XML element that represents the root logger.
  23424. </para>
  23425. </remarks>
  23426. </member>
  23427. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseChildrenOfLoggerElement(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  23428. <summary>
  23429. Parses the children of a logger element.
  23430. </summary>
  23431. <param name="catElement">The category element.</param>
  23432. <param name="log">The logger instance.</param>
  23433. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  23434. <remarks>
  23435. <para>
  23436. Parse the child elements of a &lt;logger&gt; element.
  23437. </para>
  23438. </remarks>
  23439. </member>
  23440. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRenderer(System.Xml.XmlElement)">
  23441. <summary>
  23442. Parses an object renderer.
  23443. </summary>
  23444. <param name="element">The renderer element.</param>
  23445. <remarks>
  23446. <para>
  23447. Parse an XML element that represents a renderer.
  23448. </para>
  23449. </remarks>
  23450. </member>
  23451. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLevel(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  23452. <summary>
  23453. Parses a level element.
  23454. </summary>
  23455. <param name="element">The level element.</param>
  23456. <param name="log">The logger object to set the level on.</param>
  23457. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  23458. <remarks>
  23459. <para>
  23460. Parse an XML element that represents a level.
  23461. </para>
  23462. </remarks>
  23463. </member>
  23464. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.SetParameter(System.Xml.XmlElement,System.Object)">
  23465. <summary>
  23466. Sets a parameter on an object.
  23467. </summary>
  23468. <param name="element">The parameter element.</param>
  23469. <param name="target">The object to set the parameter on.</param>
  23470. <remarks>
  23471. The parameter name must correspond to a writable property
  23472. on the object. The value of the parameter is a string,
  23473. therefore this function will attempt to set a string
  23474. property first. If unable to set a string property it
  23475. will inspect the property and its argument type. It will
  23476. attempt to call a static method called <c>Parse</c> on the
  23477. type of the property. This method will take a single
  23478. string argument and return a value that can be used to
  23479. set the property.
  23480. </remarks>
  23481. </member>
  23482. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.HasAttributesOrElements(System.Xml.XmlElement)">
  23483. <summary>
  23484. Test if an element has no attributes or child elements
  23485. </summary>
  23486. <param name="element">the element to inspect</param>
  23487. <returns><c>true</c> if the element has any attributes or child elements, <c>false</c> otherwise</returns>
  23488. </member>
  23489. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.IsTypeConstructible(System.Type)">
  23490. <summary>
  23491. Test if a <see cref="T:System.Type"/> is constructible with <c>Activator.CreateInstance</c>.
  23492. </summary>
  23493. <param name="type">the type to inspect</param>
  23494. <returns><c>true</c> if the type is creatable using a default constructor, <c>false</c> otherwise</returns>
  23495. </member>
  23496. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindMethodInfo(System.Type,System.String)">
  23497. <summary>
  23498. Look for a method on the <paramref name="targetType"/> that matches the <paramref name="name"/> supplied
  23499. </summary>
  23500. <param name="targetType">the type that has the method</param>
  23501. <param name="name">the name of the method</param>
  23502. <returns>the method info found</returns>
  23503. <remarks>
  23504. <para>
  23505. The method must be a public instance method on the <paramref name="targetType"/>.
  23506. The method must be named <paramref name="name"/> or "Add" followed by <paramref name="name"/>.
  23507. The method must take a single parameter.
  23508. </para>
  23509. </remarks>
  23510. </member>
  23511. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ConvertStringTo(System.Type,System.String)">
  23512. <summary>
  23513. Converts a string value to a target type.
  23514. </summary>
  23515. <param name="type">The type of object to convert the string to.</param>
  23516. <param name="value">The string value to use as the value of the object.</param>
  23517. <returns>
  23518. <para>
  23519. An object of type <paramref name="type"/> with value <paramref name="value"/> or
  23520. <c>null</c> when the conversion could not be performed.
  23521. </para>
  23522. </returns>
  23523. </member>
  23524. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.CreateObjectFromXml(System.Xml.XmlElement,System.Type,System.Type)">
  23525. <summary>
  23526. Creates an object as specified in XML.
  23527. </summary>
  23528. <param name="element">The XML element that contains the definition of the object.</param>
  23529. <param name="defaultTargetType">The object type to use if not explicitly specified.</param>
  23530. <param name="typeConstraint">The type that the returned object must be or must inherit from.</param>
  23531. <returns>The object or <c>null</c></returns>
  23532. <remarks>
  23533. <para>
  23534. Parse an XML element and create an object instance based on the configuration
  23535. data.
  23536. </para>
  23537. <para>
  23538. The type of the instance may be specified in the XML. If not
  23539. specified then the <paramref name="defaultTargetType"/> is used
  23540. as the type. However the type is specified it must support the
  23541. <paramref name="typeConstraint"/> type.
  23542. </para>
  23543. </remarks>
  23544. </member>
  23545. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_appenderBag">
  23546. <summary>
  23547. key: appenderName, value: appender.
  23548. </summary>
  23549. </member>
  23550. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_hierarchy">
  23551. <summary>
  23552. The Hierarchy being configured.
  23553. </summary>
  23554. </member>
  23555. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.declaringType">
  23556. <summary>
  23557. The fully qualified type of the XmlHierarchyConfigurator class.
  23558. </summary>
  23559. <remarks>
  23560. Used by the internal logger to record the Type of the
  23561. log message.
  23562. </remarks>
  23563. </member>
  23564. <member name="T:log4net.Repository.ConfigurationChangedEventArgs">
  23565. <summary>
  23566. </summary>
  23567. </member>
  23568. <member name="M:log4net.Repository.ConfigurationChangedEventArgs.#ctor(System.Collections.ICollection)">
  23569. <summary>
  23570. </summary>
  23571. <param name="configurationMessages"></param>
  23572. </member>
  23573. <member name="P:log4net.Repository.ConfigurationChangedEventArgs.ConfigurationMessages">
  23574. <summary>
  23575. </summary>
  23576. </member>
  23577. <member name="T:log4net.Repository.LoggerRepositoryShutdownEventHandler">
  23578. <summary>
  23579. Delegate used to handle logger repository shutdown event notifications
  23580. </summary>
  23581. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down.</param>
  23582. <param name="e">Empty event args</param>
  23583. <remarks>
  23584. <para>
  23585. Delegate used to handle logger repository shutdown event notifications.
  23586. </para>
  23587. </remarks>
  23588. </member>
  23589. <member name="T:log4net.Repository.LoggerRepositoryConfigurationResetEventHandler">
  23590. <summary>
  23591. Delegate used to handle logger repository configuration reset event notifications
  23592. </summary>
  23593. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration reset.</param>
  23594. <param name="e">Empty event args</param>
  23595. <remarks>
  23596. <para>
  23597. Delegate used to handle logger repository configuration reset event notifications.
  23598. </para>
  23599. </remarks>
  23600. </member>
  23601. <member name="T:log4net.Repository.LoggerRepositoryConfigurationChangedEventHandler">
  23602. <summary>
  23603. Delegate used to handle event notifications for logger repository configuration changes.
  23604. </summary>
  23605. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration changed.</param>
  23606. <param name="e">Empty event arguments.</param>
  23607. <remarks>
  23608. <para>
  23609. Delegate used to handle event notifications for logger repository configuration changes.
  23610. </para>
  23611. </remarks>
  23612. </member>
  23613. <member name="T:log4net.Util.PatternStringConverters.AppDomainPatternConverter">
  23614. <summary>
  23615. Write the name of the current AppDomain to the output
  23616. </summary>
  23617. <remarks>
  23618. <para>
  23619. Write the name of the current AppDomain to the output writer
  23620. </para>
  23621. </remarks>
  23622. <author>Nicko Cadell</author>
  23623. </member>
  23624. <member name="M:log4net.Util.PatternStringConverters.AppDomainPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23625. <summary>
  23626. Write the name of the current AppDomain to the output
  23627. </summary>
  23628. <param name="writer">the writer to write to</param>
  23629. <param name="state">null, state is not set</param>
  23630. <remarks>
  23631. <para>
  23632. Writes name of the current AppDomain to the output <paramref name="writer"/>.
  23633. </para>
  23634. </remarks>
  23635. </member>
  23636. <member name="T:log4net.Util.PatternStringConverters.AppSettingPatternConverter">
  23637. <summary>
  23638. AppSetting pattern converter
  23639. </summary>
  23640. <remarks>
  23641. <para>
  23642. This pattern converter reads appSettings from the application configuration file.
  23643. </para>
  23644. <para>
  23645. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
  23646. lookup a single appSettings value. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
  23647. then all appSettings will be dumped as a list of key value pairs.
  23648. </para>
  23649. <para>
  23650. A typical use is to specify a base directory for log files, e.g.
  23651. <example>
  23652. <![CDATA[
  23653. <log4net>
  23654. <appender name="MyAppender" type="log4net.Appender.RollingFileAppender">
  23655. <file type="log4net.Util.PatternString" value="appsetting{LogDirectory}MyApp.log"/>
  23656. ...
  23657. </appender>
  23658. </log4net>
  23659. ]]>
  23660. </example>
  23661. </para>
  23662. </remarks>
  23663. </member>
  23664. <member name="M:log4net.Util.PatternStringConverters.AppSettingPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23665. <summary>
  23666. Write the property value to the output
  23667. </summary>
  23668. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  23669. <param name="state">null, state is not set</param>
  23670. <remarks>
  23671. <para>
  23672. Writes out the value of a named property. The property name
  23673. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23674. property.
  23675. </para>
  23676. <para>
  23677. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  23678. then all the properties are written as key value pairs.
  23679. </para>
  23680. </remarks>
  23681. </member>
  23682. <member name="T:log4net.Util.PatternStringConverters.DatePatternConverter">
  23683. <summary>
  23684. Write the current date to the output
  23685. </summary>
  23686. <remarks>
  23687. <para>
  23688. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  23689. the current date and time to the writer as a string.
  23690. </para>
  23691. <para>
  23692. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  23693. the formatting of the date. The following values are allowed:
  23694. <list type="definition">
  23695. <listheader>
  23696. <term>Option value</term>
  23697. <description>Output</description>
  23698. </listheader>
  23699. <item>
  23700. <term>ISO8601</term>
  23701. <description>
  23702. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  23703. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  23704. </description>
  23705. </item>
  23706. <item>
  23707. <term>DATE</term>
  23708. <description>
  23709. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  23710. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  23711. </description>
  23712. </item>
  23713. <item>
  23714. <term>ABSOLUTE</term>
  23715. <description>
  23716. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  23717. Formats using the <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  23718. </description>
  23719. </item>
  23720. <item>
  23721. <term>other</term>
  23722. <description>
  23723. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  23724. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  23725. <see cref="M:DateTime.ToString(string)"/> method.
  23726. For details on valid patterns see
  23727. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  23728. </description>
  23729. </item>
  23730. </list>
  23731. </para>
  23732. <para>
  23733. The date and time is in the local time zone and is rendered in that zone.
  23734. To output the time in Universal time see <see cref="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter"/>.
  23735. </para>
  23736. </remarks>
  23737. <author>Nicko Cadell</author>
  23738. </member>
  23739. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.m_dateFormatter">
  23740. <summary>
  23741. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  23742. </summary>
  23743. <remarks>
  23744. <para>
  23745. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  23746. </para>
  23747. </remarks>
  23748. </member>
  23749. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions">
  23750. <summary>
  23751. Initialize the converter options
  23752. </summary>
  23753. <remarks>
  23754. <para>
  23755. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  23756. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> method must
  23757. be called on this object after the configuration properties have
  23758. been set. Until <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> is called this
  23759. object is in an undefined state and must not be used.
  23760. </para>
  23761. <para>
  23762. If any of the configuration properties are modified then
  23763. <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> must be called again.
  23764. </para>
  23765. </remarks>
  23766. </member>
  23767. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23768. <summary>
  23769. Write the current date to the output
  23770. </summary>
  23771. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  23772. <param name="state">null, state is not set</param>
  23773. <remarks>
  23774. <para>
  23775. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  23776. for it to render it to the writer.
  23777. </para>
  23778. <para>
  23779. The date and time passed is in the local time zone.
  23780. </para>
  23781. </remarks>
  23782. </member>
  23783. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.declaringType">
  23784. <summary>
  23785. The fully qualified type of the DatePatternConverter class.
  23786. </summary>
  23787. <remarks>
  23788. Used by the internal logger to record the Type of the
  23789. log message.
  23790. </remarks>
  23791. </member>
  23792. <member name="T:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter">
  23793. <summary>
  23794. Write an <see cref="T:System.Environment.SpecialFolder"/> folder path to the output
  23795. </summary>
  23796. <remarks>
  23797. <para>
  23798. Write an special path environment folder path to the output writer.
  23799. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  23800. the name of the variable to output. <see cref="P:log4net.Util.PatternConverter.Option"/>
  23801. should be a value in the <see cref="T:System.Environment.SpecialFolder"/> enumeration.
  23802. </para>
  23803. </remarks>
  23804. <author>Ron Grabowski</author>
  23805. </member>
  23806. <member name="M:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23807. <summary>
  23808. Write an special path environment folder path to the output
  23809. </summary>
  23810. <param name="writer">the writer to write to</param>
  23811. <param name="state">null, state is not set</param>
  23812. <remarks>
  23813. <para>
  23814. Writes the special path environment folder path to the output <paramref name="writer"/>.
  23815. The name of the special path environment folder path to output must be set
  23816. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23817. property.
  23818. </para>
  23819. </remarks>
  23820. </member>
  23821. <member name="F:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.declaringType">
  23822. <summary>
  23823. The fully qualified type of the EnvironmentFolderPathPatternConverter class.
  23824. </summary>
  23825. <remarks>
  23826. Used by the internal logger to record the Type of the
  23827. log message.
  23828. </remarks>
  23829. </member>
  23830. <member name="T:log4net.Util.PatternStringConverters.EnvironmentPatternConverter">
  23831. <summary>
  23832. Write an environment variable to the output
  23833. </summary>
  23834. <remarks>
  23835. <para>
  23836. Write an environment variable to the output writer.
  23837. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  23838. the name of the variable to output.
  23839. </para>
  23840. </remarks>
  23841. <author>Nicko Cadell</author>
  23842. </member>
  23843. <member name="M:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23844. <summary>
  23845. Write an environment variable to the output
  23846. </summary>
  23847. <param name="writer">the writer to write to</param>
  23848. <param name="state">null, state is not set</param>
  23849. <remarks>
  23850. <para>
  23851. Writes the environment variable to the output <paramref name="writer"/>.
  23852. The name of the environment variable to output must be set
  23853. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23854. property.
  23855. </para>
  23856. </remarks>
  23857. </member>
  23858. <member name="F:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.declaringType">
  23859. <summary>
  23860. The fully qualified type of the EnvironmentPatternConverter class.
  23861. </summary>
  23862. <remarks>
  23863. Used by the internal logger to record the Type of the
  23864. log message.
  23865. </remarks>
  23866. </member>
  23867. <member name="T:log4net.Util.PatternStringConverters.IdentityPatternConverter">
  23868. <summary>
  23869. Write the current thread identity to the output
  23870. </summary>
  23871. <remarks>
  23872. <para>
  23873. Write the current thread identity to the output writer
  23874. </para>
  23875. </remarks>
  23876. <author>Nicko Cadell</author>
  23877. </member>
  23878. <member name="M:log4net.Util.PatternStringConverters.IdentityPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23879. <summary>
  23880. Write the current thread identity to the output
  23881. </summary>
  23882. <param name="writer">the writer to write to</param>
  23883. <param name="state">null, state is not set</param>
  23884. <remarks>
  23885. <para>
  23886. Writes the current thread identity to the output <paramref name="writer"/>.
  23887. </para>
  23888. </remarks>
  23889. </member>
  23890. <member name="F:log4net.Util.PatternStringConverters.IdentityPatternConverter.declaringType">
  23891. <summary>
  23892. The fully qualified type of the IdentityPatternConverter class.
  23893. </summary>
  23894. <remarks>
  23895. Used by the internal logger to record the Type of the
  23896. log message.
  23897. </remarks>
  23898. </member>
  23899. <member name="T:log4net.Util.PatternStringConverters.LiteralPatternConverter">
  23900. <summary>
  23901. Pattern converter for literal string instances in the pattern
  23902. </summary>
  23903. <remarks>
  23904. <para>
  23905. Writes the literal string value specified in the
  23906. <see cref="P:log4net.Util.PatternConverter.Option"/> property to
  23907. the output.
  23908. </para>
  23909. </remarks>
  23910. <author>Nicko Cadell</author>
  23911. </member>
  23912. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.SetNext(log4net.Util.PatternConverter)">
  23913. <summary>
  23914. Set the next converter in the chain
  23915. </summary>
  23916. <param name="pc">The next pattern converter in the chain</param>
  23917. <returns>The next pattern converter</returns>
  23918. <remarks>
  23919. <para>
  23920. Special case the building of the pattern converter chain
  23921. for <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> instances. Two adjacent
  23922. literals in the pattern can be represented by a single combined
  23923. pattern converter. This implementation detects when a
  23924. <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> is added to the chain
  23925. after this converter and combines its value with this converter's
  23926. literal value.
  23927. </para>
  23928. </remarks>
  23929. </member>
  23930. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Format(System.IO.TextWriter,System.Object)">
  23931. <summary>
  23932. Write the literal to the output
  23933. </summary>
  23934. <param name="writer">the writer to write to</param>
  23935. <param name="state">null, not set</param>
  23936. <remarks>
  23937. <para>
  23938. Override the formatting behavior to ignore the FormattingInfo
  23939. because we have a literal instead.
  23940. </para>
  23941. <para>
  23942. Writes the value of <see cref="P:log4net.Util.PatternConverter.Option"/>
  23943. to the output <paramref name="writer"/>.
  23944. </para>
  23945. </remarks>
  23946. </member>
  23947. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23948. <summary>
  23949. Convert this pattern into the rendered message
  23950. </summary>
  23951. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  23952. <param name="state">null, not set</param>
  23953. <remarks>
  23954. <para>
  23955. This method is not used.
  23956. </para>
  23957. </remarks>
  23958. </member>
  23959. <member name="T:log4net.Util.PatternStringConverters.NewLinePatternConverter">
  23960. <summary>
  23961. Writes a newline to the output
  23962. </summary>
  23963. <remarks>
  23964. <para>
  23965. Writes the system dependent line terminator to the output.
  23966. This behavior can be overridden by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>:
  23967. </para>
  23968. <list type="definition">
  23969. <listheader>
  23970. <term>Option Value</term>
  23971. <description>Output</description>
  23972. </listheader>
  23973. <item>
  23974. <term>DOS</term>
  23975. <description>DOS or Windows line terminator <c>"\r\n"</c></description>
  23976. </item>
  23977. <item>
  23978. <term>UNIX</term>
  23979. <description>UNIX line terminator <c>"\n"</c></description>
  23980. </item>
  23981. </list>
  23982. </remarks>
  23983. <author>Nicko Cadell</author>
  23984. </member>
  23985. <member name="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions">
  23986. <summary>
  23987. Initialize the converter
  23988. </summary>
  23989. <remarks>
  23990. <para>
  23991. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  23992. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> method must
  23993. be called on this object after the configuration properties have
  23994. been set. Until <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> is called this
  23995. object is in an undefined state and must not be used.
  23996. </para>
  23997. <para>
  23998. If any of the configuration properties are modified then
  23999. <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> must be called again.
  24000. </para>
  24001. </remarks>
  24002. </member>
  24003. <member name="T:log4net.Util.PatternStringConverters.ProcessIdPatternConverter">
  24004. <summary>
  24005. Write the current process ID to the output
  24006. </summary>
  24007. <remarks>
  24008. <para>
  24009. Write the current process ID to the output writer
  24010. </para>
  24011. </remarks>
  24012. <author>Nicko Cadell</author>
  24013. </member>
  24014. <member name="M:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  24015. <summary>
  24016. Write the current process ID to the output
  24017. </summary>
  24018. <param name="writer">the writer to write to</param>
  24019. <param name="state">null, state is not set</param>
  24020. <remarks>
  24021. <para>
  24022. Write the current process ID to the output <paramref name="writer"/>.
  24023. </para>
  24024. </remarks>
  24025. </member>
  24026. <member name="F:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.declaringType">
  24027. <summary>
  24028. The fully qualified type of the ProcessIdPatternConverter class.
  24029. </summary>
  24030. <remarks>
  24031. Used by the internal logger to record the Type of the
  24032. log message.
  24033. </remarks>
  24034. </member>
  24035. <member name="T:log4net.Util.PatternStringConverters.PropertyPatternConverter">
  24036. <summary>
  24037. Property pattern converter
  24038. </summary>
  24039. <remarks>
  24040. <para>
  24041. This pattern converter reads the thread and global properties.
  24042. The thread properties take priority over global properties.
  24043. See <see cref="P:log4net.ThreadContext.Properties"/> for details of the
  24044. thread properties. See <see cref="P:log4net.GlobalContext.Properties"/> for
  24045. details of the global properties.
  24046. </para>
  24047. <para>
  24048. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
  24049. lookup a single property. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
  24050. then all properties will be dumped as a list of key value pairs.
  24051. </para>
  24052. </remarks>
  24053. <author>Nicko Cadell</author>
  24054. </member>
  24055. <member name="M:log4net.Util.PatternStringConverters.PropertyPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  24056. <summary>
  24057. Write the property value to the output
  24058. </summary>
  24059. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  24060. <param name="state">null, state is not set</param>
  24061. <remarks>
  24062. <para>
  24063. Writes out the value of a named property. The property name
  24064. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  24065. property.
  24066. </para>
  24067. <para>
  24068. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  24069. then all the properties are written as key value pairs.
  24070. </para>
  24071. </remarks>
  24072. </member>
  24073. <member name="T:log4net.Util.PatternStringConverters.RandomStringPatternConverter">
  24074. <summary>
  24075. A Pattern converter that generates a string of random characters
  24076. </summary>
  24077. <remarks>
  24078. <para>
  24079. The converter generates a string of random characters. By default
  24080. the string is length 4. This can be changed by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>
  24081. to the string value of the length required.
  24082. </para>
  24083. <para>
  24084. The random characters in the string are limited to uppercase letters
  24085. and numbers only.
  24086. </para>
  24087. <para>
  24088. The random number generator used by this class is not cryptographically secure.
  24089. </para>
  24090. </remarks>
  24091. <author>Nicko Cadell</author>
  24092. </member>
  24093. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.s_random">
  24094. <summary>
  24095. Shared random number generator
  24096. </summary>
  24097. </member>
  24098. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.m_length">
  24099. <summary>
  24100. Length of random string to generate. Default length 4.
  24101. </summary>
  24102. </member>
  24103. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions">
  24104. <summary>
  24105. Initialize the converter options
  24106. </summary>
  24107. <remarks>
  24108. <para>
  24109. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  24110. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> method must
  24111. be called on this object after the configuration properties have
  24112. been set. Until <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> is called this
  24113. object is in an undefined state and must not be used.
  24114. </para>
  24115. <para>
  24116. If any of the configuration properties are modified then
  24117. <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> must be called again.
  24118. </para>
  24119. </remarks>
  24120. </member>
  24121. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  24122. <summary>
  24123. Write a randoim string to the output
  24124. </summary>
  24125. <param name="writer">the writer to write to</param>
  24126. <param name="state">null, state is not set</param>
  24127. <remarks>
  24128. <para>
  24129. Write a randoim string to the output <paramref name="writer"/>.
  24130. </para>
  24131. </remarks>
  24132. </member>
  24133. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.declaringType">
  24134. <summary>
  24135. The fully qualified type of the RandomStringPatternConverter class.
  24136. </summary>
  24137. <remarks>
  24138. Used by the internal logger to record the Type of the
  24139. log message.
  24140. </remarks>
  24141. </member>
  24142. <member name="T:log4net.Util.PatternStringConverters.UserNamePatternConverter">
  24143. <summary>
  24144. Write the current threads username to the output
  24145. </summary>
  24146. <remarks>
  24147. <para>
  24148. Write the current threads username to the output writer
  24149. </para>
  24150. </remarks>
  24151. <author>Nicko Cadell</author>
  24152. </member>
  24153. <member name="M:log4net.Util.PatternStringConverters.UserNamePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  24154. <summary>
  24155. Write the current threads username to the output
  24156. </summary>
  24157. <param name="writer">the writer to write to</param>
  24158. <param name="state">null, state is not set</param>
  24159. <remarks>
  24160. <para>
  24161. Write the current threads username to the output <paramref name="writer"/>.
  24162. </para>
  24163. </remarks>
  24164. </member>
  24165. <member name="F:log4net.Util.PatternStringConverters.UserNamePatternConverter.declaringType">
  24166. <summary>
  24167. The fully qualified type of the UserNamePatternConverter class.
  24168. </summary>
  24169. <remarks>
  24170. Used by the internal logger to record the Type of the
  24171. log message.
  24172. </remarks>
  24173. </member>
  24174. <member name="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter">
  24175. <summary>
  24176. Write the UTC date time to the output
  24177. </summary>
  24178. <remarks>
  24179. <para>
  24180. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  24181. the current date and time in Universal time.
  24182. </para>
  24183. <para>
  24184. See the <see cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> for details on the date pattern syntax.
  24185. </para>
  24186. </remarks>
  24187. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  24188. <author>Nicko Cadell</author>
  24189. </member>
  24190. <member name="M:log4net.Util.PatternStringConverters.UtcDatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  24191. <summary>
  24192. Write the current date and time to the output
  24193. </summary>
  24194. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  24195. <param name="state">null, state is not set</param>
  24196. <remarks>
  24197. <para>
  24198. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  24199. for it to render it to the writer.
  24200. </para>
  24201. <para>
  24202. The date is in Universal time when it is rendered.
  24203. </para>
  24204. </remarks>
  24205. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  24206. </member>
  24207. <member name="F:log4net.Util.PatternStringConverters.UtcDatePatternConverter.declaringType">
  24208. <summary>
  24209. The fully qualified type of the UtcDatePatternConverter class.
  24210. </summary>
  24211. <remarks>
  24212. Used by the internal logger to record the Type of the
  24213. log message.
  24214. </remarks>
  24215. </member>
  24216. <member name="T:log4net.Util.TypeConverters.BooleanConverter">
  24217. <summary>
  24218. Type converter for Boolean.
  24219. </summary>
  24220. <remarks>
  24221. <para>
  24222. Supports conversion from string to <c>bool</c> type.
  24223. </para>
  24224. </remarks>
  24225. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24226. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24227. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24228. <author>Nicko Cadell</author>
  24229. <author>Gert Driesen</author>
  24230. </member>
  24231. <member name="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)">
  24232. <summary>
  24233. Can the source type be converted to the type supported by this object
  24234. </summary>
  24235. <param name="sourceType">the type to convert</param>
  24236. <returns>true if the conversion is possible</returns>
  24237. <remarks>
  24238. <para>
  24239. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24240. the <see cref="T:System.String"/> type.
  24241. </para>
  24242. </remarks>
  24243. </member>
  24244. <member name="M:log4net.Util.TypeConverters.BooleanConverter.ConvertFrom(System.Object)">
  24245. <summary>
  24246. Convert the source object to the type supported by this object
  24247. </summary>
  24248. <param name="source">the object to convert</param>
  24249. <returns>the converted object</returns>
  24250. <remarks>
  24251. <para>
  24252. Uses the <see cref="M:System.Boolean.Parse(System.String)"/> method to convert the
  24253. <see cref="T:System.String"/> argument to a <see cref="T:System.Boolean"/>.
  24254. </para>
  24255. </remarks>
  24256. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24257. The <paramref name="source"/> object cannot be converted to the
  24258. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)"/>
  24259. method.
  24260. </exception>
  24261. </member>
  24262. <member name="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24263. <summary>
  24264. Exception base type for conversion errors.
  24265. </summary>
  24266. <remarks>
  24267. <para>
  24268. This type extends <see cref="T:System.ApplicationException"/>. It
  24269. does not add any new functionality but does differentiate the
  24270. type of exception being thrown.
  24271. </para>
  24272. </remarks>
  24273. <author>Nicko Cadell</author>
  24274. <author>Gert Driesen</author>
  24275. </member>
  24276. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor">
  24277. <summary>
  24278. Constructor
  24279. </summary>
  24280. <remarks>
  24281. <para>
  24282. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  24283. </para>
  24284. </remarks>
  24285. </member>
  24286. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String)">
  24287. <summary>
  24288. Constructor
  24289. </summary>
  24290. <param name="message">A message to include with the exception.</param>
  24291. <remarks>
  24292. <para>
  24293. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
  24294. with the specified message.
  24295. </para>
  24296. </remarks>
  24297. </member>
  24298. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String,System.Exception)">
  24299. <summary>
  24300. Constructor
  24301. </summary>
  24302. <param name="message">A message to include with the exception.</param>
  24303. <param name="innerException">A nested exception to include.</param>
  24304. <remarks>
  24305. <para>
  24306. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
  24307. with the specified message and inner exception.
  24308. </para>
  24309. </remarks>
  24310. </member>
  24311. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  24312. <summary>
  24313. Serialization constructor
  24314. </summary>
  24315. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
  24316. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  24317. <remarks>
  24318. <para>
  24319. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
  24320. with serialized data.
  24321. </para>
  24322. </remarks>
  24323. </member>
  24324. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object)">
  24325. <summary>
  24326. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  24327. </summary>
  24328. <param name="destinationType">The conversion destination type.</param>
  24329. <param name="sourceValue">The value to convert.</param>
  24330. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns>
  24331. <remarks>
  24332. <para>
  24333. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  24334. </para>
  24335. </remarks>
  24336. </member>
  24337. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object,System.Exception)">
  24338. <summary>
  24339. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  24340. </summary>
  24341. <param name="destinationType">The conversion destination type.</param>
  24342. <param name="sourceValue">The value to convert.</param>
  24343. <param name="innerException">A nested exception to include.</param>
  24344. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns>
  24345. <remarks>
  24346. <para>
  24347. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  24348. </para>
  24349. </remarks>
  24350. </member>
  24351. <member name="T:log4net.Util.TypeConverters.ConverterRegistry">
  24352. <summary>
  24353. Register of type converters for specific types.
  24354. </summary>
  24355. <remarks>
  24356. <para>
  24357. Maintains a registry of type converters used to convert between
  24358. types.
  24359. </para>
  24360. <para>
  24361. Use the <see cref="M:AddConverter(Type, object)"/> and
  24362. <see cref="M:AddConverter(Type, Type)"/> methods to register new converters.
  24363. 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
  24364. lookup appropriate converters to use.
  24365. </para>
  24366. </remarks>
  24367. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24368. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24369. <author>Nicko Cadell</author>
  24370. <author>Gert Driesen</author>
  24371. </member>
  24372. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#ctor">
  24373. <summary>
  24374. Private constructor
  24375. </summary>
  24376. <remarks>
  24377. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> class.
  24378. </remarks>
  24379. </member>
  24380. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#cctor">
  24381. <summary>
  24382. Static constructor.
  24383. </summary>
  24384. <remarks>
  24385. <para>
  24386. This constructor defines the intrinsic type converters.
  24387. </para>
  24388. </remarks>
  24389. </member>
  24390. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)">
  24391. <summary>
  24392. Adds a converter for a specific type.
  24393. </summary>
  24394. <param name="destinationType">The type being converted to.</param>
  24395. <param name="converter">The type converter to use to convert to the destination type.</param>
  24396. <remarks>
  24397. <para>
  24398. Adds a converter instance for a specific type.
  24399. </para>
  24400. </remarks>
  24401. </member>
  24402. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Type)">
  24403. <summary>
  24404. Adds a converter for a specific type.
  24405. </summary>
  24406. <param name="destinationType">The type being converted to.</param>
  24407. <param name="converterType">The type of the type converter to use to convert to the destination type.</param>
  24408. <remarks>
  24409. <para>
  24410. Adds a converter <see cref="T:System.Type"/> for a specific type.
  24411. </para>
  24412. </remarks>
  24413. </member>
  24414. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)">
  24415. <summary>
  24416. Gets the type converter to use to convert values to the destination type.
  24417. </summary>
  24418. <param name="sourceType">The type being converted from.</param>
  24419. <param name="destinationType">The type being converted to.</param>
  24420. <returns>
  24421. The type converter instance to use for type conversions or <c>null</c>
  24422. if no type converter is found.
  24423. </returns>
  24424. <remarks>
  24425. <para>
  24426. Gets the type converter to use to convert values to the destination type.
  24427. </para>
  24428. </remarks>
  24429. </member>
  24430. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)">
  24431. <summary>
  24432. Gets the type converter to use to convert values to the destination type.
  24433. </summary>
  24434. <param name="destinationType">The type being converted to.</param>
  24435. <returns>
  24436. The type converter instance to use for type conversions or <c>null</c>
  24437. if no type converter is found.
  24438. </returns>
  24439. <remarks>
  24440. <para>
  24441. Gets the type converter to use to convert values to the destination type.
  24442. </para>
  24443. </remarks>
  24444. </member>
  24445. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConverterFromAttribute(System.Type)">
  24446. <summary>
  24447. Lookups the type converter to use as specified by the attributes on the
  24448. destination type.
  24449. </summary>
  24450. <param name="destinationType">The type being converted to.</param>
  24451. <returns>
  24452. The type converter instance to use for type conversions or <c>null</c>
  24453. if no type converter is found.
  24454. </returns>
  24455. </member>
  24456. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.CreateConverterInstance(System.Type)">
  24457. <summary>
  24458. Creates the instance of the type converter.
  24459. </summary>
  24460. <param name="converterType">The type of the type converter.</param>
  24461. <returns>
  24462. The type converter instance to use for type conversions or <c>null</c>
  24463. if no type converter is found.
  24464. </returns>
  24465. <remarks>
  24466. <para>
  24467. The type specified for the type converter must implement
  24468. the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> or <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces
  24469. and must have a public default (no argument) constructor.
  24470. </para>
  24471. </remarks>
  24472. </member>
  24473. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.declaringType">
  24474. <summary>
  24475. The fully qualified type of the ConverterRegistry class.
  24476. </summary>
  24477. <remarks>
  24478. Used by the internal logger to record the Type of the
  24479. log message.
  24480. </remarks>
  24481. </member>
  24482. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.s_type2converter">
  24483. <summary>
  24484. Mapping from <see cref="T:System.Type"/> to type converter.
  24485. </summary>
  24486. </member>
  24487. <member name="T:log4net.Util.TypeConverters.EncodingConverter">
  24488. <summary>
  24489. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  24490. </summary>
  24491. <remarks>
  24492. <para>
  24493. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  24494. </para>
  24495. </remarks>
  24496. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24497. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24498. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24499. <author>Nicko Cadell</author>
  24500. <author>Gert Driesen</author>
  24501. </member>
  24502. <member name="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)">
  24503. <summary>
  24504. Can the source type be converted to the type supported by this object
  24505. </summary>
  24506. <param name="sourceType">the type to convert</param>
  24507. <returns>true if the conversion is possible</returns>
  24508. <remarks>
  24509. <para>
  24510. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24511. the <see cref="T:System.String"/> type.
  24512. </para>
  24513. </remarks>
  24514. </member>
  24515. <member name="M:log4net.Util.TypeConverters.EncodingConverter.ConvertFrom(System.Object)">
  24516. <summary>
  24517. Overrides the ConvertFrom method of IConvertFrom.
  24518. </summary>
  24519. <param name="source">the object to convert to an encoding</param>
  24520. <returns>the encoding</returns>
  24521. <remarks>
  24522. <para>
  24523. Uses the <see cref="M:Encoding.GetEncoding(string)"/> method to
  24524. convert the <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>.
  24525. </para>
  24526. </remarks>
  24527. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24528. The <paramref name="source"/> object cannot be converted to the
  24529. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)"/>
  24530. method.
  24531. </exception>
  24532. </member>
  24533. <member name="T:log4net.Util.TypeConverters.IConvertTo">
  24534. <summary>
  24535. Interface supported by type converters
  24536. </summary>
  24537. <remarks>
  24538. <para>
  24539. This interface supports conversion from a single type to arbitrary types.
  24540. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  24541. </para>
  24542. </remarks>
  24543. <author>Nicko Cadell</author>
  24544. </member>
  24545. <member name="M:log4net.Util.TypeConverters.IConvertTo.CanConvertTo(System.Type)">
  24546. <summary>
  24547. Returns whether this converter can convert the object to the specified type
  24548. </summary>
  24549. <param name="targetType">A Type that represents the type you want to convert to</param>
  24550. <returns>true if the conversion is possible</returns>
  24551. <remarks>
  24552. <para>
  24553. Test if the type supported by this converter can be converted to the
  24554. <paramref name="targetType"/>.
  24555. </para>
  24556. </remarks>
  24557. </member>
  24558. <member name="M:log4net.Util.TypeConverters.IConvertTo.ConvertTo(System.Object,System.Type)">
  24559. <summary>
  24560. Converts the given value object to the specified type, using the arguments
  24561. </summary>
  24562. <param name="source">the object to convert</param>
  24563. <param name="targetType">The Type to convert the value parameter to</param>
  24564. <returns>the converted object</returns>
  24565. <remarks>
  24566. <para>
  24567. Converts the <paramref name="source"/> (which must be of the type supported
  24568. by this converter) to the <paramref name="targetType"/> specified..
  24569. </para>
  24570. </remarks>
  24571. </member>
  24572. <member name="T:log4net.Util.TypeConverters.IPAddressConverter">
  24573. <summary>
  24574. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  24575. </summary>
  24576. <remarks>
  24577. <para>
  24578. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  24579. </para>
  24580. </remarks>
  24581. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24582. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24583. <author>Nicko Cadell</author>
  24584. </member>
  24585. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)">
  24586. <summary>
  24587. Can the source type be converted to the type supported by this object
  24588. </summary>
  24589. <param name="sourceType">the type to convert</param>
  24590. <returns>true if the conversion is possible</returns>
  24591. <remarks>
  24592. <para>
  24593. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24594. the <see cref="T:System.String"/> type.
  24595. </para>
  24596. </remarks>
  24597. </member>
  24598. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.ConvertFrom(System.Object)">
  24599. <summary>
  24600. Overrides the ConvertFrom method of IConvertFrom.
  24601. </summary>
  24602. <param name="source">the object to convert to an IPAddress</param>
  24603. <returns>the IPAddress</returns>
  24604. <remarks>
  24605. <para>
  24606. Uses the <see cref="M:System.Net.IPAddress.Parse(System.String)"/> method to convert the
  24607. <see cref="T:System.String"/> argument to an <see cref="T:System.Net.IPAddress"/>.
  24608. If that fails then the string is resolved as a DNS hostname.
  24609. </para>
  24610. </remarks>
  24611. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24612. The <paramref name="source"/> object cannot be converted to the
  24613. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)"/>
  24614. method.
  24615. </exception>
  24616. </member>
  24617. <member name="F:log4net.Util.TypeConverters.IPAddressConverter.validIpAddressChars">
  24618. <summary>
  24619. Valid characters in an IPv4 or IPv6 address string. (Does not support subnets)
  24620. </summary>
  24621. </member>
  24622. <member name="T:log4net.Util.TypeConverters.PatternLayoutConverter">
  24623. <summary>
  24624. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  24625. </summary>
  24626. <remarks>
  24627. <para>
  24628. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  24629. </para>
  24630. <para>
  24631. The string is used as the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>
  24632. of the <see cref="T:log4net.Layout.PatternLayout"/>.
  24633. </para>
  24634. </remarks>
  24635. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24636. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24637. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24638. <author>Nicko Cadell</author>
  24639. </member>
  24640. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)">
  24641. <summary>
  24642. Can the source type be converted to the type supported by this object
  24643. </summary>
  24644. <param name="sourceType">the type to convert</param>
  24645. <returns>true if the conversion is possible</returns>
  24646. <remarks>
  24647. <para>
  24648. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24649. the <see cref="T:System.String"/> type.
  24650. </para>
  24651. </remarks>
  24652. </member>
  24653. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.ConvertFrom(System.Object)">
  24654. <summary>
  24655. Overrides the ConvertFrom method of IConvertFrom.
  24656. </summary>
  24657. <param name="source">the object to convert to a PatternLayout</param>
  24658. <returns>the PatternLayout</returns>
  24659. <remarks>
  24660. <para>
  24661. Creates and returns a new <see cref="T:log4net.Layout.PatternLayout"/> using
  24662. the <paramref name="source"/> <see cref="T:System.String"/> as the
  24663. <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>.
  24664. </para>
  24665. </remarks>
  24666. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24667. The <paramref name="source"/> object cannot be converted to the
  24668. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)"/>
  24669. method.
  24670. </exception>
  24671. </member>
  24672. <member name="T:log4net.Util.TypeConverters.PatternStringConverter">
  24673. <summary>
  24674. Convert between string and <see cref="T:log4net.Util.PatternString"/>
  24675. </summary>
  24676. <remarks>
  24677. <para>
  24678. Supports conversion from string to <see cref="T:log4net.Util.PatternString"/> type,
  24679. and from a <see cref="T:log4net.Util.PatternString"/> type to a string.
  24680. </para>
  24681. <para>
  24682. The string is used as the <see cref="P:log4net.Util.PatternString.ConversionPattern"/>
  24683. of the <see cref="T:log4net.Util.PatternString"/>.
  24684. </para>
  24685. </remarks>
  24686. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24687. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24688. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24689. <author>Nicko Cadell</author>
  24690. </member>
  24691. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)">
  24692. <summary>
  24693. Can the target type be converted to the type supported by this object
  24694. </summary>
  24695. <param name="targetType">A <see cref="T:System.Type"/> that represents the type you want to convert to</param>
  24696. <returns>true if the conversion is possible</returns>
  24697. <remarks>
  24698. <para>
  24699. Returns <c>true</c> if the <paramref name="targetType"/> is
  24700. assignable from a <see cref="T:System.String"/> type.
  24701. </para>
  24702. </remarks>
  24703. </member>
  24704. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertTo(System.Object,System.Type)">
  24705. <summary>
  24706. Converts the given value object to the specified type, using the arguments
  24707. </summary>
  24708. <param name="source">the object to convert</param>
  24709. <param name="targetType">The Type to convert the value parameter to</param>
  24710. <returns>the converted object</returns>
  24711. <remarks>
  24712. <para>
  24713. Uses the <see cref="M:PatternString.Format()"/> method to convert the
  24714. <see cref="T:log4net.Util.PatternString"/> argument to a <see cref="T:System.String"/>.
  24715. </para>
  24716. </remarks>
  24717. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24718. The <paramref name="source"/> object cannot be converted to the
  24719. <paramref name="targetType"/>. To check for this condition use the
  24720. <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)"/> method.
  24721. </exception>
  24722. </member>
  24723. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)">
  24724. <summary>
  24725. Can the source type be converted to the type supported by this object
  24726. </summary>
  24727. <param name="sourceType">the type to convert</param>
  24728. <returns>true if the conversion is possible</returns>
  24729. <remarks>
  24730. <para>
  24731. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24732. the <see cref="T:System.String"/> type.
  24733. </para>
  24734. </remarks>
  24735. </member>
  24736. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertFrom(System.Object)">
  24737. <summary>
  24738. Overrides the ConvertFrom method of IConvertFrom.
  24739. </summary>
  24740. <param name="source">the object to convert to a PatternString</param>
  24741. <returns>the PatternString</returns>
  24742. <remarks>
  24743. <para>
  24744. Creates and returns a new <see cref="T:log4net.Util.PatternString"/> using
  24745. the <paramref name="source"/> <see cref="T:System.String"/> as the
  24746. <see cref="P:log4net.Util.PatternString.ConversionPattern"/>.
  24747. </para>
  24748. </remarks>
  24749. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24750. The <paramref name="source"/> object cannot be converted to the
  24751. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)"/>
  24752. method.
  24753. </exception>
  24754. </member>
  24755. <member name="T:log4net.Util.TypeConverters.TypeConverter">
  24756. <summary>
  24757. Supports conversion from string to <see cref="T:System.Type"/> type.
  24758. </summary>
  24759. <remarks>
  24760. <para>
  24761. Supports conversion from string to <see cref="T:System.Type"/> type.
  24762. </para>
  24763. </remarks>
  24764. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24765. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24766. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24767. <author>Nicko Cadell</author>
  24768. </member>
  24769. <member name="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)">
  24770. <summary>
  24771. Can the source type be converted to the type supported by this object
  24772. </summary>
  24773. <param name="sourceType">the type to convert</param>
  24774. <returns>true if the conversion is possible</returns>
  24775. <remarks>
  24776. <para>
  24777. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24778. the <see cref="T:System.String"/> type.
  24779. </para>
  24780. </remarks>
  24781. </member>
  24782. <member name="M:log4net.Util.TypeConverters.TypeConverter.ConvertFrom(System.Object)">
  24783. <summary>
  24784. Overrides the ConvertFrom method of IConvertFrom.
  24785. </summary>
  24786. <param name="source">the object to convert to a Type</param>
  24787. <returns>the Type</returns>
  24788. <remarks>
  24789. <para>
  24790. Uses the <see cref="M:Type.GetType(string,bool)"/> method to convert the
  24791. <see cref="T:System.String"/> argument to a <see cref="T:System.Type"/>.
  24792. Additional effort is made to locate partially specified types
  24793. by searching the loaded assemblies.
  24794. </para>
  24795. </remarks>
  24796. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24797. The <paramref name="source"/> object cannot be converted to the
  24798. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)"/>
  24799. method.
  24800. </exception>
  24801. </member>
  24802. <member name="T:log4net.Util.TypeConverters.TypeConverterAttribute">
  24803. <summary>
  24804. Attribute used to associate a type converter
  24805. </summary>
  24806. <remarks>
  24807. <para>
  24808. Class and Interface level attribute that specifies a type converter
  24809. to use with the associated type.
  24810. </para>
  24811. <para>
  24812. To associate a type converter with a target type apply a
  24813. <c>TypeConverterAttribute</c> to the target type. Specify the
  24814. type of the type converter on the attribute.
  24815. </para>
  24816. </remarks>
  24817. <author>Nicko Cadell</author>
  24818. <author>Gert Driesen</author>
  24819. </member>
  24820. <member name="F:log4net.Util.TypeConverters.TypeConverterAttribute.m_typeName">
  24821. <summary>
  24822. The string type name of the type converter
  24823. </summary>
  24824. </member>
  24825. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor">
  24826. <summary>
  24827. Default constructor
  24828. </summary>
  24829. <remarks>
  24830. <para>
  24831. Default constructor
  24832. </para>
  24833. </remarks>
  24834. </member>
  24835. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.String)">
  24836. <summary>
  24837. Create a new type converter attribute for the specified type name
  24838. </summary>
  24839. <param name="typeName">The string type name of the type converter</param>
  24840. <remarks>
  24841. <para>
  24842. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24843. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  24844. </para>
  24845. </remarks>
  24846. </member>
  24847. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.Type)">
  24848. <summary>
  24849. Create a new type converter attribute for the specified type
  24850. </summary>
  24851. <param name="converterType">The type of the type converter</param>
  24852. <remarks>
  24853. <para>
  24854. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24855. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  24856. </para>
  24857. </remarks>
  24858. </member>
  24859. <member name="P:log4net.Util.TypeConverters.TypeConverterAttribute.ConverterTypeName">
  24860. <summary>
  24861. The string type name of the type converter
  24862. </summary>
  24863. <value>
  24864. The string type name of the type converter
  24865. </value>
  24866. <remarks>
  24867. <para>
  24868. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24869. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  24870. </para>
  24871. </remarks>
  24872. </member>
  24873. <member name="T:log4net.Util.AppenderAttachedImpl">
  24874. <summary>
  24875. A straightforward implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  24876. </summary>
  24877. <remarks>
  24878. <para>
  24879. This is the default implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/>
  24880. interface. Implementors of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  24881. should aggregate an instance of this type.
  24882. </para>
  24883. </remarks>
  24884. <author>Nicko Cadell</author>
  24885. <author>Gert Driesen</author>
  24886. </member>
  24887. <member name="M:log4net.Util.AppenderAttachedImpl.#ctor">
  24888. <summary>
  24889. Constructor
  24890. </summary>
  24891. <remarks>
  24892. <para>
  24893. Initializes a new instance of the <see cref="T:log4net.Util.AppenderAttachedImpl"/> class.
  24894. </para>
  24895. </remarks>
  24896. </member>
  24897. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent)">
  24898. <summary>
  24899. Append on on all attached appenders.
  24900. </summary>
  24901. <param name="loggingEvent">The event being logged.</param>
  24902. <returns>The number of appenders called.</returns>
  24903. <remarks>
  24904. <para>
  24905. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all
  24906. attached appenders.
  24907. </para>
  24908. </remarks>
  24909. </member>
  24910. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent[])">
  24911. <summary>
  24912. Append on on all attached appenders.
  24913. </summary>
  24914. <param name="loggingEvents">The array of events being logged.</param>
  24915. <returns>The number of appenders called.</returns>
  24916. <remarks>
  24917. <para>
  24918. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all
  24919. attached appenders.
  24920. </para>
  24921. </remarks>
  24922. </member>
  24923. <member name="M:log4net.Util.AppenderAttachedImpl.CallAppend(log4net.Appender.IAppender,log4net.Core.LoggingEvent[])">
  24924. <summary>
  24925. Calls the DoAppende method on the <see cref="T:log4net.Appender.IAppender"/> with
  24926. the <see cref="T:log4net.Core.LoggingEvent"/> objects supplied.
  24927. </summary>
  24928. <param name="appender">The appender</param>
  24929. <param name="loggingEvents">The events</param>
  24930. <remarks>
  24931. <para>
  24932. If the <paramref name="appender"/> supports the <see cref="T:log4net.Appender.IBulkAppender"/>
  24933. interface then the <paramref name="loggingEvents"/> will be passed
  24934. through using that interface. Otherwise the <see cref="T:log4net.Core.LoggingEvent"/>
  24935. objects in the array will be passed one at a time.
  24936. </para>
  24937. </remarks>
  24938. </member>
  24939. <member name="M:log4net.Util.AppenderAttachedImpl.AddAppender(log4net.Appender.IAppender)">
  24940. <summary>
  24941. Attaches an appender.
  24942. </summary>
  24943. <param name="newAppender">The appender to add.</param>
  24944. <remarks>
  24945. <para>
  24946. If the appender is already in the list it won't be added again.
  24947. </para>
  24948. </remarks>
  24949. </member>
  24950. <member name="M:log4net.Util.AppenderAttachedImpl.GetAppender(System.String)">
  24951. <summary>
  24952. Gets an attached appender with the specified name.
  24953. </summary>
  24954. <param name="name">The name of the appender to get.</param>
  24955. <returns>
  24956. The appender with the name specified, or <c>null</c> if no appender with the
  24957. specified name is found.
  24958. </returns>
  24959. <remarks>
  24960. <para>
  24961. Lookup an attached appender by name.
  24962. </para>
  24963. </remarks>
  24964. </member>
  24965. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAllAppenders">
  24966. <summary>
  24967. Removes all attached appenders.
  24968. </summary>
  24969. <remarks>
  24970. <para>
  24971. Removes and closes all attached appenders
  24972. </para>
  24973. </remarks>
  24974. </member>
  24975. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(log4net.Appender.IAppender)">
  24976. <summary>
  24977. Removes the specified appender from the list of attached appenders.
  24978. </summary>
  24979. <param name="appender">The appender to remove.</param>
  24980. <returns>The appender removed from the list</returns>
  24981. <remarks>
  24982. <para>
  24983. The appender removed is not closed.
  24984. If you are discarding the appender you must call
  24985. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  24986. </para>
  24987. </remarks>
  24988. </member>
  24989. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(System.String)">
  24990. <summary>
  24991. Removes the appender with the specified name from the list of appenders.
  24992. </summary>
  24993. <param name="name">The name of the appender to remove.</param>
  24994. <returns>The appender removed from the list</returns>
  24995. <remarks>
  24996. <para>
  24997. The appender removed is not closed.
  24998. If you are discarding the appender you must call
  24999. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  25000. </para>
  25001. </remarks>
  25002. </member>
  25003. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderList">
  25004. <summary>
  25005. List of appenders
  25006. </summary>
  25007. </member>
  25008. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderArray">
  25009. <summary>
  25010. Array of appenders, used to cache the m_appenderList
  25011. </summary>
  25012. </member>
  25013. <member name="F:log4net.Util.AppenderAttachedImpl.declaringType">
  25014. <summary>
  25015. The fully qualified type of the AppenderAttachedImpl class.
  25016. </summary>
  25017. <remarks>
  25018. Used by the internal logger to record the Type of the
  25019. log message.
  25020. </remarks>
  25021. </member>
  25022. <member name="P:log4net.Util.AppenderAttachedImpl.Appenders">
  25023. <summary>
  25024. Gets all attached appenders.
  25025. </summary>
  25026. <returns>
  25027. A collection of attached appenders, or <c>null</c> if there
  25028. are no attached appenders.
  25029. </returns>
  25030. <remarks>
  25031. <para>
  25032. The read only collection of all currently attached appenders.
  25033. </para>
  25034. </remarks>
  25035. </member>
  25036. <member name="T:log4net.Util.CompositeProperties">
  25037. <summary>
  25038. This class aggregates several PropertiesDictionary collections together.
  25039. </summary>
  25040. <remarks>
  25041. <para>
  25042. Provides a dictionary style lookup over an ordered list of
  25043. <see cref="T:log4net.Util.PropertiesDictionary"/> collections.
  25044. </para>
  25045. </remarks>
  25046. <author>Nicko Cadell</author>
  25047. </member>
  25048. <member name="M:log4net.Util.CompositeProperties.#ctor">
  25049. <summary>
  25050. Constructor
  25051. </summary>
  25052. <remarks>
  25053. <para>
  25054. Initializes a new instance of the <see cref="T:log4net.Util.CompositeProperties"/> class.
  25055. </para>
  25056. </remarks>
  25057. </member>
  25058. <member name="M:log4net.Util.CompositeProperties.Add(log4net.Util.ReadOnlyPropertiesDictionary)">
  25059. <summary>
  25060. Add a Properties Dictionary to this composite collection
  25061. </summary>
  25062. <param name="properties">the properties to add</param>
  25063. <remarks>
  25064. <para>
  25065. Properties dictionaries added first take precedence over dictionaries added
  25066. later.
  25067. </para>
  25068. </remarks>
  25069. </member>
  25070. <member name="M:log4net.Util.CompositeProperties.Flatten">
  25071. <summary>
  25072. Flatten this composite collection into a single properties dictionary
  25073. </summary>
  25074. <returns>the flattened dictionary</returns>
  25075. <remarks>
  25076. <para>
  25077. Reduces the collection of ordered dictionaries to a single dictionary
  25078. containing the resultant values for the keys.
  25079. </para>
  25080. </remarks>
  25081. </member>
  25082. <member name="P:log4net.Util.CompositeProperties.Item(System.String)">
  25083. <summary>
  25084. Gets the value of a property
  25085. </summary>
  25086. <value>
  25087. The value for the property with the specified key
  25088. </value>
  25089. <remarks>
  25090. <para>
  25091. Looks up the value for the <paramref name="key"/> specified.
  25092. The <see cref="T:log4net.Util.PropertiesDictionary"/> collections are searched
  25093. in the order in which they were added to this collection. The value
  25094. returned is the value held by the first collection that contains
  25095. the specified key.
  25096. </para>
  25097. <para>
  25098. If none of the collections contain the specified key then
  25099. <c>null</c> is returned.
  25100. </para>
  25101. </remarks>
  25102. </member>
  25103. <member name="T:log4net.Util.ContextPropertiesBase">
  25104. <summary>
  25105. Base class for Context Properties implementations
  25106. </summary>
  25107. <remarks>
  25108. <para>
  25109. This class defines a basic property get set accessor
  25110. </para>
  25111. </remarks>
  25112. <author>Nicko Cadell</author>
  25113. </member>
  25114. <member name="P:log4net.Util.ContextPropertiesBase.Item(System.String)">
  25115. <summary>
  25116. Gets or sets the value of a property
  25117. </summary>
  25118. <value>
  25119. The value for the property with the specified key
  25120. </value>
  25121. <remarks>
  25122. <para>
  25123. Gets or sets the value of a property
  25124. </para>
  25125. </remarks>
  25126. </member>
  25127. <member name="T:log4net.Util.ConverterInfo">
  25128. <summary>
  25129. Wrapper class used to map converter names to converter types
  25130. </summary>
  25131. <remarks>
  25132. <para>
  25133. Pattern converter info class used during configuration by custom
  25134. PatternString and PatternLayer converters.
  25135. </para>
  25136. </remarks>
  25137. </member>
  25138. <member name="M:log4net.Util.ConverterInfo.#ctor">
  25139. <summary>
  25140. default constructor
  25141. </summary>
  25142. </member>
  25143. <member name="M:log4net.Util.ConverterInfo.AddProperty(log4net.Util.PropertyEntry)">
  25144. <summary>
  25145. </summary>
  25146. <param name="entry"></param>
  25147. </member>
  25148. <member name="P:log4net.Util.ConverterInfo.Name">
  25149. <summary>
  25150. Gets or sets the name of the conversion pattern
  25151. </summary>
  25152. <remarks>
  25153. <para>
  25154. The name of the pattern in the format string
  25155. </para>
  25156. </remarks>
  25157. </member>
  25158. <member name="P:log4net.Util.ConverterInfo.Type">
  25159. <summary>
  25160. Gets or sets the type of the converter
  25161. </summary>
  25162. <remarks>
  25163. <para>
  25164. The value specified must extend the
  25165. <see cref="T:log4net.Util.PatternConverter"/> type.
  25166. </para>
  25167. </remarks>
  25168. </member>
  25169. <member name="P:log4net.Util.ConverterInfo.Properties">
  25170. <summary>
  25171. </summary>
  25172. </member>
  25173. <member name="T:log4net.Util.CountingQuietTextWriter">
  25174. <summary>
  25175. Subclass of <see cref="T:log4net.Util.QuietTextWriter"/> that maintains a count of
  25176. the number of bytes written.
  25177. </summary>
  25178. <remarks>
  25179. <para>
  25180. This writer counts the number of bytes written.
  25181. </para>
  25182. </remarks>
  25183. <author>Nicko Cadell</author>
  25184. <author>Gert Driesen</author>
  25185. </member>
  25186. <member name="T:log4net.Util.QuietTextWriter">
  25187. <summary>
  25188. <see cref="T:System.IO.TextWriter"/> that does not leak exceptions
  25189. </summary>
  25190. <remarks>
  25191. <para>
  25192. <see cref="T:log4net.Util.QuietTextWriter"/> does not throw exceptions when things go wrong.
  25193. Instead, it delegates error handling to its <see cref="T:log4net.Core.IErrorHandler"/>.
  25194. </para>
  25195. </remarks>
  25196. <author>Nicko Cadell</author>
  25197. <author>Gert Driesen</author>
  25198. </member>
  25199. <member name="T:log4net.Util.TextWriterAdapter">
  25200. <summary>
  25201. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  25202. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  25203. </summary>
  25204. <remarks>
  25205. <para>
  25206. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  25207. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  25208. </para>
  25209. </remarks>
  25210. <author>Nicko Cadell</author>
  25211. </member>
  25212. <member name="F:log4net.Util.TextWriterAdapter.m_writer">
  25213. <summary>
  25214. The writer to forward messages to
  25215. </summary>
  25216. </member>
  25217. <member name="M:log4net.Util.TextWriterAdapter.#ctor(System.IO.TextWriter)">
  25218. <summary>
  25219. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  25220. messages to a <see cref="T:System.IO.TextWriter"/>.
  25221. </summary>
  25222. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to forward to</param>
  25223. <remarks>
  25224. <para>
  25225. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  25226. messages to a <see cref="T:System.IO.TextWriter"/>.
  25227. </para>
  25228. </remarks>
  25229. </member>
  25230. <member name="M:log4net.Util.TextWriterAdapter.Close">
  25231. <summary>
  25232. Closes the writer and releases any system resources associated with the writer
  25233. </summary>
  25234. <remarks>
  25235. <para>
  25236. </para>
  25237. </remarks>
  25238. </member>
  25239. <member name="M:log4net.Util.TextWriterAdapter.Dispose(System.Boolean)">
  25240. <summary>
  25241. Dispose this writer
  25242. </summary>
  25243. <param name="disposing">flag indicating if we are being disposed</param>
  25244. <remarks>
  25245. <para>
  25246. Dispose this writer
  25247. </para>
  25248. </remarks>
  25249. </member>
  25250. <member name="M:log4net.Util.TextWriterAdapter.Flush">
  25251. <summary>
  25252. Flushes any buffered output
  25253. </summary>
  25254. <remarks>
  25255. <para>
  25256. Clears all buffers for the writer and causes any buffered data to be written
  25257. to the underlying device
  25258. </para>
  25259. </remarks>
  25260. </member>
  25261. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char)">
  25262. <summary>
  25263. Writes a character to the wrapped TextWriter
  25264. </summary>
  25265. <param name="value">the value to write to the TextWriter</param>
  25266. <remarks>
  25267. <para>
  25268. Writes a character to the wrapped TextWriter
  25269. </para>
  25270. </remarks>
  25271. </member>
  25272. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char[],System.Int32,System.Int32)">
  25273. <summary>
  25274. Writes a character buffer to the wrapped TextWriter
  25275. </summary>
  25276. <param name="buffer">the data buffer</param>
  25277. <param name="index">the start index</param>
  25278. <param name="count">the number of characters to write</param>
  25279. <remarks>
  25280. <para>
  25281. Writes a character buffer to the wrapped TextWriter
  25282. </para>
  25283. </remarks>
  25284. </member>
  25285. <member name="M:log4net.Util.TextWriterAdapter.Write(System.String)">
  25286. <summary>
  25287. Writes a string to the wrapped TextWriter
  25288. </summary>
  25289. <param name="value">the value to write to the TextWriter</param>
  25290. <remarks>
  25291. <para>
  25292. Writes a string to the wrapped TextWriter
  25293. </para>
  25294. </remarks>
  25295. </member>
  25296. <member name="P:log4net.Util.TextWriterAdapter.Writer">
  25297. <summary>
  25298. Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>.
  25299. </summary>
  25300. <value>
  25301. The underlying <see cref="T:System.IO.TextWriter"/>.
  25302. </value>
  25303. <remarks>
  25304. <para>
  25305. Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>.
  25306. </para>
  25307. </remarks>
  25308. </member>
  25309. <member name="P:log4net.Util.TextWriterAdapter.Encoding">
  25310. <summary>
  25311. The Encoding in which the output is written
  25312. </summary>
  25313. <value>
  25314. The <see cref="P:log4net.Util.TextWriterAdapter.Encoding"/>
  25315. </value>
  25316. <remarks>
  25317. <para>
  25318. The Encoding in which the output is written
  25319. </para>
  25320. </remarks>
  25321. </member>
  25322. <member name="P:log4net.Util.TextWriterAdapter.FormatProvider">
  25323. <summary>
  25324. Gets an object that controls formatting
  25325. </summary>
  25326. <value>
  25327. The format provider
  25328. </value>
  25329. <remarks>
  25330. <para>
  25331. Gets an object that controls formatting
  25332. </para>
  25333. </remarks>
  25334. </member>
  25335. <member name="P:log4net.Util.TextWriterAdapter.NewLine">
  25336. <summary>
  25337. Gets or sets the line terminator string used by the TextWriter
  25338. </summary>
  25339. <value>
  25340. The line terminator to use
  25341. </value>
  25342. <remarks>
  25343. <para>
  25344. Gets or sets the line terminator string used by the TextWriter
  25345. </para>
  25346. </remarks>
  25347. </member>
  25348. <member name="M:log4net.Util.QuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  25349. <summary>
  25350. Constructor
  25351. </summary>
  25352. <param name="writer">the writer to actually write to</param>
  25353. <param name="errorHandler">the error handler to report error to</param>
  25354. <remarks>
  25355. <para>
  25356. Create a new QuietTextWriter using a writer and error handler
  25357. </para>
  25358. </remarks>
  25359. </member>
  25360. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char)">
  25361. <summary>
  25362. Writes a character to the underlying writer
  25363. </summary>
  25364. <param name="value">the char to write</param>
  25365. <remarks>
  25366. <para>
  25367. Writes a character to the underlying writer
  25368. </para>
  25369. </remarks>
  25370. </member>
  25371. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  25372. <summary>
  25373. Writes a buffer to the underlying writer
  25374. </summary>
  25375. <param name="buffer">the buffer to write</param>
  25376. <param name="index">the start index to write from</param>
  25377. <param name="count">the number of characters to write</param>
  25378. <remarks>
  25379. <para>
  25380. Writes a buffer to the underlying writer
  25381. </para>
  25382. </remarks>
  25383. </member>
  25384. <member name="M:log4net.Util.QuietTextWriter.Write(System.String)">
  25385. <summary>
  25386. Writes a string to the output.
  25387. </summary>
  25388. <param name="value">The string data to write to the output.</param>
  25389. <remarks>
  25390. <para>
  25391. Writes a string to the output.
  25392. </para>
  25393. </remarks>
  25394. </member>
  25395. <member name="M:log4net.Util.QuietTextWriter.Close">
  25396. <summary>
  25397. Closes the underlying output writer.
  25398. </summary>
  25399. <remarks>
  25400. <para>
  25401. Closes the underlying output writer.
  25402. </para>
  25403. </remarks>
  25404. </member>
  25405. <member name="F:log4net.Util.QuietTextWriter.m_errorHandler">
  25406. <summary>
  25407. The error handler instance to pass all errors to
  25408. </summary>
  25409. </member>
  25410. <member name="F:log4net.Util.QuietTextWriter.m_closed">
  25411. <summary>
  25412. Flag to indicate if this writer is closed
  25413. </summary>
  25414. </member>
  25415. <member name="P:log4net.Util.QuietTextWriter.ErrorHandler">
  25416. <summary>
  25417. Gets or sets the error handler that all errors are passed to.
  25418. </summary>
  25419. <value>
  25420. The error handler that all errors are passed to.
  25421. </value>
  25422. <remarks>
  25423. <para>
  25424. Gets or sets the error handler that all errors are passed to.
  25425. </para>
  25426. </remarks>
  25427. </member>
  25428. <member name="P:log4net.Util.QuietTextWriter.Closed">
  25429. <summary>
  25430. Gets a value indicating whether this writer is closed.
  25431. </summary>
  25432. <value>
  25433. <c>true</c> if this writer is closed, otherwise <c>false</c>.
  25434. </value>
  25435. <remarks>
  25436. <para>
  25437. Gets a value indicating whether this writer is closed.
  25438. </para>
  25439. </remarks>
  25440. </member>
  25441. <member name="M:log4net.Util.CountingQuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  25442. <summary>
  25443. Constructor
  25444. </summary>
  25445. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to actually write to.</param>
  25446. <param name="errorHandler">The <see cref="T:log4net.Core.IErrorHandler"/> to report errors to.</param>
  25447. <remarks>
  25448. <para>
  25449. Creates a new instance of the <see cref="T:log4net.Util.CountingQuietTextWriter"/> class
  25450. with the specified <see cref="T:System.IO.TextWriter"/> and <see cref="T:log4net.Core.IErrorHandler"/>.
  25451. </para>
  25452. </remarks>
  25453. </member>
  25454. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char)">
  25455. <summary>
  25456. Writes a character to the underlying writer and counts the number of bytes written.
  25457. </summary>
  25458. <param name="value">the char to write</param>
  25459. <remarks>
  25460. <para>
  25461. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  25462. the number of bytes written.
  25463. </para>
  25464. </remarks>
  25465. </member>
  25466. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  25467. <summary>
  25468. Writes a buffer to the underlying writer and counts the number of bytes written.
  25469. </summary>
  25470. <param name="buffer">the buffer to write</param>
  25471. <param name="index">the start index to write from</param>
  25472. <param name="count">the number of characters to write</param>
  25473. <remarks>
  25474. <para>
  25475. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  25476. the number of bytes written.
  25477. </para>
  25478. </remarks>
  25479. </member>
  25480. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.String)">
  25481. <summary>
  25482. Writes a string to the output and counts the number of bytes written.
  25483. </summary>
  25484. <param name="str">The string data to write to the output.</param>
  25485. <remarks>
  25486. <para>
  25487. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  25488. the number of bytes written.
  25489. </para>
  25490. </remarks>
  25491. </member>
  25492. <member name="F:log4net.Util.CountingQuietTextWriter.m_countBytes">
  25493. <summary>
  25494. Total number of bytes written.
  25495. </summary>
  25496. </member>
  25497. <member name="P:log4net.Util.CountingQuietTextWriter.Count">
  25498. <summary>
  25499. Gets or sets the total number of bytes written.
  25500. </summary>
  25501. <value>
  25502. The total number of bytes written.
  25503. </value>
  25504. <remarks>
  25505. <para>
  25506. Gets or sets the total number of bytes written.
  25507. </para>
  25508. </remarks>
  25509. </member>
  25510. <member name="T:log4net.Util.CyclicBuffer">
  25511. <summary>
  25512. A fixed size rolling buffer of logging events.
  25513. </summary>
  25514. <remarks>
  25515. <para>
  25516. An array backed fixed size leaky bucket.
  25517. </para>
  25518. </remarks>
  25519. <author>Nicko Cadell</author>
  25520. <author>Gert Driesen</author>
  25521. </member>
  25522. <member name="M:log4net.Util.CyclicBuffer.#ctor(System.Int32)">
  25523. <summary>
  25524. Constructor
  25525. </summary>
  25526. <param name="maxSize">The maximum number of logging events in the buffer.</param>
  25527. <remarks>
  25528. <para>
  25529. Initializes a new instance of the <see cref="T:log4net.Util.CyclicBuffer"/> class with
  25530. the specified maximum number of buffered logging events.
  25531. </para>
  25532. </remarks>
  25533. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="maxSize"/> argument is not a positive integer.</exception>
  25534. </member>
  25535. <member name="M:log4net.Util.CyclicBuffer.Append(log4net.Core.LoggingEvent)">
  25536. <summary>
  25537. Appends a <paramref name="loggingEvent"/> to the buffer.
  25538. </summary>
  25539. <param name="loggingEvent">The event to append to the buffer.</param>
  25540. <returns>The event discarded from the buffer, if the buffer is full, otherwise <c>null</c>.</returns>
  25541. <remarks>
  25542. <para>
  25543. Append an event to the buffer. If the buffer still contains free space then
  25544. <c>null</c> is returned. If the buffer is full then an event will be dropped
  25545. to make space for the new event, the event dropped is returned.
  25546. </para>
  25547. </remarks>
  25548. </member>
  25549. <member name="M:log4net.Util.CyclicBuffer.PopOldest">
  25550. <summary>
  25551. Get and remove the oldest event in the buffer.
  25552. </summary>
  25553. <returns>The oldest logging event in the buffer</returns>
  25554. <remarks>
  25555. <para>
  25556. Gets the oldest (first) logging event in the buffer and removes it
  25557. from the buffer.
  25558. </para>
  25559. </remarks>
  25560. </member>
  25561. <member name="M:log4net.Util.CyclicBuffer.PopAll">
  25562. <summary>
  25563. Pops all the logging events from the buffer into an array.
  25564. </summary>
  25565. <returns>An array of all the logging events in the buffer.</returns>
  25566. <remarks>
  25567. <para>
  25568. Get all the events in the buffer and clear the buffer.
  25569. </para>
  25570. </remarks>
  25571. </member>
  25572. <member name="M:log4net.Util.CyclicBuffer.Clear">
  25573. <summary>
  25574. Clear the buffer
  25575. </summary>
  25576. <remarks>
  25577. <para>
  25578. Clear the buffer of all events. The events in the buffer are lost.
  25579. </para>
  25580. </remarks>
  25581. </member>
  25582. <member name="P:log4net.Util.CyclicBuffer.Item(System.Int32)">
  25583. <summary>
  25584. Gets the <paramref name="i"/>th oldest event currently in the buffer.
  25585. </summary>
  25586. <value>The <paramref name="i"/>th oldest event currently in the buffer.</value>
  25587. <remarks>
  25588. <para>
  25589. If <paramref name="i"/> is outside the range 0 to the number of events
  25590. currently in the buffer, then <c>null</c> is returned.
  25591. </para>
  25592. </remarks>
  25593. </member>
  25594. <member name="P:log4net.Util.CyclicBuffer.MaxSize">
  25595. <summary>
  25596. Gets the maximum size of the buffer.
  25597. </summary>
  25598. <value>The maximum size of the buffer.</value>
  25599. <remarks>
  25600. <para>
  25601. Gets the maximum size of the buffer
  25602. </para>
  25603. </remarks>
  25604. </member>
  25605. <member name="P:log4net.Util.CyclicBuffer.Length">
  25606. <summary>
  25607. Gets the number of logging events in the buffer.
  25608. </summary>
  25609. <value>The number of logging events in the buffer.</value>
  25610. <remarks>
  25611. <para>
  25612. This number is guaranteed to be in the range 0 to <see cref="P:log4net.Util.CyclicBuffer.MaxSize"/>
  25613. (inclusive).
  25614. </para>
  25615. </remarks>
  25616. </member>
  25617. <member name="T:log4net.Util.EmptyCollection">
  25618. <summary>
  25619. An always empty <see cref="T:System.Collections.ICollection"/>.
  25620. </summary>
  25621. <remarks>
  25622. <para>
  25623. A singleton implementation of the <see cref="T:System.Collections.ICollection"/>
  25624. interface that always represents an empty collection.
  25625. </para>
  25626. </remarks>
  25627. <author>Nicko Cadell</author>
  25628. <author>Gert Driesen</author>
  25629. </member>
  25630. <member name="M:log4net.Util.EmptyCollection.#ctor">
  25631. <summary>
  25632. Initializes a new instance of the <see cref="T:log4net.Util.EmptyCollection"/> class.
  25633. </summary>
  25634. <remarks>
  25635. <para>
  25636. Uses a private access modifier to enforce the singleton pattern.
  25637. </para>
  25638. </remarks>
  25639. </member>
  25640. <member name="M:log4net.Util.EmptyCollection.CopyTo(System.Array,System.Int32)">
  25641. <summary>
  25642. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  25643. <see cref="T:System.Array"/>, starting at a particular Array index.
  25644. </summary>
  25645. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  25646. that is the destination of the elements copied from
  25647. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  25648. indexing.</param>
  25649. <param name="index">The zero-based index in array at which
  25650. copying begins.</param>
  25651. <remarks>
  25652. <para>
  25653. As the collection is empty no values are copied into the array.
  25654. </para>
  25655. </remarks>
  25656. </member>
  25657. <member name="M:log4net.Util.EmptyCollection.GetEnumerator">
  25658. <summary>
  25659. Returns an enumerator that can iterate through a collection.
  25660. </summary>
  25661. <returns>
  25662. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25663. iterate through the collection.
  25664. </returns>
  25665. <remarks>
  25666. <para>
  25667. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25668. </para>
  25669. </remarks>
  25670. </member>
  25671. <member name="F:log4net.Util.EmptyCollection.s_instance">
  25672. <summary>
  25673. The singleton instance of the empty collection.
  25674. </summary>
  25675. </member>
  25676. <member name="P:log4net.Util.EmptyCollection.Instance">
  25677. <summary>
  25678. Gets the singleton instance of the empty collection.
  25679. </summary>
  25680. <returns>The singleton instance of the empty collection.</returns>
  25681. <remarks>
  25682. <para>
  25683. Gets the singleton instance of the empty collection.
  25684. </para>
  25685. </remarks>
  25686. </member>
  25687. <member name="P:log4net.Util.EmptyCollection.IsSynchronized">
  25688. <summary>
  25689. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  25690. </summary>
  25691. <value>
  25692. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  25693. </value>
  25694. <remarks>
  25695. <para>
  25696. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <c>true</c>.
  25697. </para>
  25698. </remarks>
  25699. </member>
  25700. <member name="P:log4net.Util.EmptyCollection.Count">
  25701. <summary>
  25702. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  25703. </summary>
  25704. <value>
  25705. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  25706. </value>
  25707. <remarks>
  25708. <para>
  25709. As the collection is empty the <see cref="P:log4net.Util.EmptyCollection.Count"/> is always <c>0</c>.
  25710. </para>
  25711. </remarks>
  25712. </member>
  25713. <member name="P:log4net.Util.EmptyCollection.SyncRoot">
  25714. <summary>
  25715. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25716. </summary>
  25717. <value>
  25718. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25719. </value>
  25720. <remarks>
  25721. <para>
  25722. As the collection is empty and thread safe and synchronized this instance is also
  25723. the <see cref="P:log4net.Util.EmptyCollection.SyncRoot"/> object.
  25724. </para>
  25725. </remarks>
  25726. </member>
  25727. <member name="T:log4net.Util.EmptyDictionary">
  25728. <summary>
  25729. An always empty <see cref="T:System.Collections.IDictionary"/>.
  25730. </summary>
  25731. <remarks>
  25732. <para>
  25733. A singleton implementation of the <see cref="T:System.Collections.IDictionary"/>
  25734. interface that always represents an empty collection.
  25735. </para>
  25736. </remarks>
  25737. <author>Nicko Cadell</author>
  25738. <author>Gert Driesen</author>
  25739. </member>
  25740. <member name="M:log4net.Util.EmptyDictionary.#ctor">
  25741. <summary>
  25742. Initializes a new instance of the <see cref="T:log4net.Util.EmptyDictionary"/> class.
  25743. </summary>
  25744. <remarks>
  25745. <para>
  25746. Uses a private access modifier to enforce the singleton pattern.
  25747. </para>
  25748. </remarks>
  25749. </member>
  25750. <member name="M:log4net.Util.EmptyDictionary.CopyTo(System.Array,System.Int32)">
  25751. <summary>
  25752. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  25753. <see cref="T:System.Array"/>, starting at a particular Array index.
  25754. </summary>
  25755. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  25756. that is the destination of the elements copied from
  25757. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  25758. indexing.</param>
  25759. <param name="index">The zero-based index in array at which
  25760. copying begins.</param>
  25761. <remarks>
  25762. <para>
  25763. As the collection is empty no values are copied into the array.
  25764. </para>
  25765. </remarks>
  25766. </member>
  25767. <member name="M:log4net.Util.EmptyDictionary.System#Collections#IEnumerable#GetEnumerator">
  25768. <summary>
  25769. Returns an enumerator that can iterate through a collection.
  25770. </summary>
  25771. <returns>
  25772. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25773. iterate through the collection.
  25774. </returns>
  25775. <remarks>
  25776. <para>
  25777. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25778. </para>
  25779. </remarks>
  25780. </member>
  25781. <member name="M:log4net.Util.EmptyDictionary.Add(System.Object,System.Object)">
  25782. <summary>
  25783. Adds an element with the provided key and value to the
  25784. <see cref="T:log4net.Util.EmptyDictionary"/>.
  25785. </summary>
  25786. <param name="key">The <see cref="T:System.Object"/> to use as the key of the element to add.</param>
  25787. <param name="value">The <see cref="T:System.Object"/> to use as the value of the element to add.</param>
  25788. <remarks>
  25789. <para>
  25790. As the collection is empty no new values can be added. A <see cref="T:System.InvalidOperationException"/>
  25791. is thrown if this method is called.
  25792. </para>
  25793. </remarks>
  25794. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25795. </member>
  25796. <member name="M:log4net.Util.EmptyDictionary.Clear">
  25797. <summary>
  25798. Removes all elements from the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25799. </summary>
  25800. <remarks>
  25801. <para>
  25802. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  25803. is thrown if this method is called.
  25804. </para>
  25805. </remarks>
  25806. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25807. </member>
  25808. <member name="M:log4net.Util.EmptyDictionary.Contains(System.Object)">
  25809. <summary>
  25810. Determines whether the <see cref="T:log4net.Util.EmptyDictionary"/> contains an element
  25811. with the specified key.
  25812. </summary>
  25813. <param name="key">The key to locate in the <see cref="T:log4net.Util.EmptyDictionary"/>.</param>
  25814. <returns><c>false</c></returns>
  25815. <remarks>
  25816. <para>
  25817. As the collection is empty the <see cref="M:log4net.Util.EmptyDictionary.Contains(System.Object)"/> method always returns <c>false</c>.
  25818. </para>
  25819. </remarks>
  25820. </member>
  25821. <member name="M:log4net.Util.EmptyDictionary.GetEnumerator">
  25822. <summary>
  25823. Returns an enumerator that can iterate through a collection.
  25824. </summary>
  25825. <returns>
  25826. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25827. iterate through the collection.
  25828. </returns>
  25829. <remarks>
  25830. <para>
  25831. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25832. </para>
  25833. </remarks>
  25834. </member>
  25835. <member name="M:log4net.Util.EmptyDictionary.Remove(System.Object)">
  25836. <summary>
  25837. Removes the element with the specified key from the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25838. </summary>
  25839. <param name="key">The key of the element to remove.</param>
  25840. <remarks>
  25841. <para>
  25842. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  25843. is thrown if this method is called.
  25844. </para>
  25845. </remarks>
  25846. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25847. </member>
  25848. <member name="F:log4net.Util.EmptyDictionary.s_instance">
  25849. <summary>
  25850. The singleton instance of the empty dictionary.
  25851. </summary>
  25852. </member>
  25853. <member name="P:log4net.Util.EmptyDictionary.Instance">
  25854. <summary>
  25855. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25856. </summary>
  25857. <returns>The singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.</returns>
  25858. <remarks>
  25859. <para>
  25860. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25861. </para>
  25862. </remarks>
  25863. </member>
  25864. <member name="P:log4net.Util.EmptyDictionary.IsSynchronized">
  25865. <summary>
  25866. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  25867. </summary>
  25868. <value>
  25869. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  25870. </value>
  25871. <remarks>
  25872. <para>
  25873. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <b>true</b>.
  25874. </para>
  25875. </remarks>
  25876. </member>
  25877. <member name="P:log4net.Util.EmptyDictionary.Count">
  25878. <summary>
  25879. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>
  25880. </summary>
  25881. <value>
  25882. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  25883. </value>
  25884. <remarks>
  25885. <para>
  25886. As the collection is empty the <see cref="P:log4net.Util.EmptyDictionary.Count"/> is always <c>0</c>.
  25887. </para>
  25888. </remarks>
  25889. </member>
  25890. <member name="P:log4net.Util.EmptyDictionary.SyncRoot">
  25891. <summary>
  25892. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25893. </summary>
  25894. <value>
  25895. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25896. </value>
  25897. <remarks>
  25898. <para>
  25899. As the collection is empty and thread safe and synchronized this instance is also
  25900. the <see cref="P:log4net.Util.EmptyDictionary.SyncRoot"/> object.
  25901. </para>
  25902. </remarks>
  25903. </member>
  25904. <member name="P:log4net.Util.EmptyDictionary.IsFixedSize">
  25905. <summary>
  25906. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> has a fixed size.
  25907. </summary>
  25908. <value><c>true</c></value>
  25909. <remarks>
  25910. <para>
  25911. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsFixedSize"/> always returns <c>true</c>.
  25912. </para>
  25913. </remarks>
  25914. </member>
  25915. <member name="P:log4net.Util.EmptyDictionary.IsReadOnly">
  25916. <summary>
  25917. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> is read-only.
  25918. </summary>
  25919. <value><c>true</c></value>
  25920. <remarks>
  25921. <para>
  25922. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsReadOnly"/> always returns <c>true</c>.
  25923. </para>
  25924. </remarks>
  25925. </member>
  25926. <member name="P:log4net.Util.EmptyDictionary.Keys">
  25927. <summary>
  25928. Gets an <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25929. </summary>
  25930. <value>An <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value>
  25931. <remarks>
  25932. <para>
  25933. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  25934. </para>
  25935. </remarks>
  25936. </member>
  25937. <member name="P:log4net.Util.EmptyDictionary.Values">
  25938. <summary>
  25939. Gets an <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25940. </summary>
  25941. <value>An <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value>
  25942. <remarks>
  25943. <para>
  25944. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  25945. </para>
  25946. </remarks>
  25947. </member>
  25948. <member name="P:log4net.Util.EmptyDictionary.Item(System.Object)">
  25949. <summary>
  25950. Gets or sets the element with the specified key.
  25951. </summary>
  25952. <param name="key">The key of the element to get or set.</param>
  25953. <value><c>null</c></value>
  25954. <remarks>
  25955. <para>
  25956. As the collection is empty no values can be looked up or stored.
  25957. If the index getter is called then <c>null</c> is returned.
  25958. A <see cref="T:System.InvalidOperationException"/> is thrown if the setter is called.
  25959. </para>
  25960. </remarks>
  25961. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25962. </member>
  25963. <member name="T:log4net.Util.FormattingInfo">
  25964. <summary>
  25965. Contain the information obtained when parsing formatting modifiers
  25966. in conversion modifiers.
  25967. </summary>
  25968. <remarks>
  25969. <para>
  25970. Holds the formatting information extracted from the format string by
  25971. the <see cref="T:log4net.Util.PatternParser"/>. This is used by the <see cref="T:log4net.Util.PatternConverter"/>
  25972. objects when rendering the output.
  25973. </para>
  25974. </remarks>
  25975. <author>Nicko Cadell</author>
  25976. <author>Gert Driesen</author>
  25977. </member>
  25978. <member name="M:log4net.Util.FormattingInfo.#ctor">
  25979. <summary>
  25980. Defaut Constructor
  25981. </summary>
  25982. <remarks>
  25983. <para>
  25984. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class.
  25985. </para>
  25986. </remarks>
  25987. </member>
  25988. <member name="M:log4net.Util.FormattingInfo.#ctor(System.Int32,System.Int32,System.Boolean)">
  25989. <summary>
  25990. Constructor
  25991. </summary>
  25992. <remarks>
  25993. <para>
  25994. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class
  25995. with the specified parameters.
  25996. </para>
  25997. </remarks>
  25998. </member>
  25999. <member name="P:log4net.Util.FormattingInfo.Min">
  26000. <summary>
  26001. Gets or sets the minimum value.
  26002. </summary>
  26003. <value>
  26004. The minimum value.
  26005. </value>
  26006. <remarks>
  26007. <para>
  26008. Gets or sets the minimum value.
  26009. </para>
  26010. </remarks>
  26011. </member>
  26012. <member name="P:log4net.Util.FormattingInfo.Max">
  26013. <summary>
  26014. Gets or sets the maximum value.
  26015. </summary>
  26016. <value>
  26017. The maximum value.
  26018. </value>
  26019. <remarks>
  26020. <para>
  26021. Gets or sets the maximum value.
  26022. </para>
  26023. </remarks>
  26024. </member>
  26025. <member name="P:log4net.Util.FormattingInfo.LeftAlign">
  26026. <summary>
  26027. Gets or sets a flag indicating whether left align is enabled
  26028. or not.
  26029. </summary>
  26030. <value>
  26031. A flag indicating whether left align is enabled or not.
  26032. </value>
  26033. <remarks>
  26034. <para>
  26035. Gets or sets a flag indicating whether left align is enabled or not.
  26036. </para>
  26037. </remarks>
  26038. </member>
  26039. <member name="T:log4net.Util.GlobalContextProperties">
  26040. <summary>
  26041. Implementation of Properties collection for the <see cref="T:log4net.GlobalContext"/>
  26042. </summary>
  26043. <remarks>
  26044. <para>
  26045. This class implements a properties collection that is thread safe and supports both
  26046. storing properties and capturing a read only copy of the current propertied.
  26047. </para>
  26048. <para>
  26049. This class is optimized to the scenario where the properties are read frequently
  26050. and are modified infrequently.
  26051. </para>
  26052. </remarks>
  26053. <author>Nicko Cadell</author>
  26054. </member>
  26055. <member name="F:log4net.Util.GlobalContextProperties.m_readOnlyProperties">
  26056. <summary>
  26057. The read only copy of the properties.
  26058. </summary>
  26059. <remarks>
  26060. <para>
  26061. This variable is declared <c>volatile</c> to prevent the compiler and JIT from
  26062. reordering reads and writes of this thread performed on different threads.
  26063. </para>
  26064. </remarks>
  26065. </member>
  26066. <member name="F:log4net.Util.GlobalContextProperties.m_syncRoot">
  26067. <summary>
  26068. Lock object used to synchronize updates within this instance
  26069. </summary>
  26070. </member>
  26071. <member name="M:log4net.Util.GlobalContextProperties.#ctor">
  26072. <summary>
  26073. Constructor
  26074. </summary>
  26075. <remarks>
  26076. <para>
  26077. Initializes a new instance of the <see cref="T:log4net.Util.GlobalContextProperties"/> class.
  26078. </para>
  26079. </remarks>
  26080. </member>
  26081. <member name="M:log4net.Util.GlobalContextProperties.Remove(System.String)">
  26082. <summary>
  26083. Remove a property from the global context
  26084. </summary>
  26085. <param name="key">the key for the entry to remove</param>
  26086. <remarks>
  26087. <para>
  26088. Removing an entry from the global context properties is relatively expensive compared
  26089. with reading a value.
  26090. </para>
  26091. </remarks>
  26092. </member>
  26093. <member name="M:log4net.Util.GlobalContextProperties.Clear">
  26094. <summary>
  26095. Clear the global context properties
  26096. </summary>
  26097. </member>
  26098. <member name="M:log4net.Util.GlobalContextProperties.GetReadOnlyProperties">
  26099. <summary>
  26100. Get a readonly immutable copy of the properties
  26101. </summary>
  26102. <returns>the current global context properties</returns>
  26103. <remarks>
  26104. <para>
  26105. This implementation is fast because the GlobalContextProperties class
  26106. stores a readonly copy of the properties.
  26107. </para>
  26108. </remarks>
  26109. </member>
  26110. <member name="P:log4net.Util.GlobalContextProperties.Item(System.String)">
  26111. <summary>
  26112. Gets or sets the value of a property
  26113. </summary>
  26114. <value>
  26115. The value for the property with the specified key
  26116. </value>
  26117. <remarks>
  26118. <para>
  26119. Reading the value for a key is faster than setting the value.
  26120. When the value is written a new read only copy of
  26121. the properties is created.
  26122. </para>
  26123. </remarks>
  26124. </member>
  26125. <member name="T:log4net.Util.ILogExtensions">
  26126. <summary>
  26127. The static class ILogExtensions contains a set of widely used
  26128. methods that ease the interaction with the ILog interface implementations.
  26129. </summary>
  26130. <remarks>
  26131. <para>
  26132. This class contains methods for logging at different levels and checks the
  26133. properties for determining if those logging levels are enabled in the current
  26134. configuration.
  26135. </para>
  26136. </remarks>
  26137. <example>Simple example of logging messages
  26138. <code lang="C#">
  26139. using log4net.Util;
  26140. ILog log = LogManager.GetLogger("application-log");
  26141. log.InfoExt("Application Start");
  26142. log.DebugExt("This is a debug message");
  26143. </code>
  26144. </example>
  26145. </member>
  26146. <member name="F:log4net.Util.ILogExtensions.declaringType">
  26147. <summary>
  26148. The fully qualified type of the Logger class.
  26149. </summary>
  26150. </member>
  26151. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object})">
  26152. <summary>
  26153. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26154. </summary>
  26155. <param name="logger">The logger on which the message is logged.</param>
  26156. <param name="callback">The lambda expression that gets the object to log.</param>
  26157. <remarks>
  26158. <para>
  26159. This method first checks if this logger is <c>INFO</c>
  26160. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  26161. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26162. implementation. If this logger is <c>INFO</c> enabled, then it converts
  26163. the message object (retrieved by invocation of the provided callback) to a
  26164. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26165. It then proceeds to call all the registered appenders in this logger
  26166. and also higher in the hierarchy depending on the value of
  26167. the additivity flag.
  26168. </para>
  26169. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26170. to this method will print the name of the <see cref="T:System.Exception"/>
  26171. but no stack trace. To print a stack trace use the
  26172. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26173. </para>
  26174. </remarks>
  26175. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26176. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26177. </member>
  26178. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26179. <summary>
  26180. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  26181. the stack trace of the <see cref="T:System.Exception"/> passed
  26182. as a parameter.
  26183. </summary>
  26184. <param name="logger">The logger on which the message is logged.</param>
  26185. <param name="callback">The lambda expression that gets the object to log.</param>
  26186. <param name="exception">The exception to log, including its stack trace.</param>
  26187. <remarks>
  26188. <para>
  26189. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26190. </para>
  26191. </remarks>
  26192. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26193. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26194. </member>
  26195. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)">
  26196. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads> //TODO
  26197. <summary>
  26198. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26199. </summary>
  26200. <param name="logger">The logger on which the message is logged.</param>
  26201. <param name="message">The message object to log.</param>
  26202. <remarks>
  26203. <para>
  26204. This method first checks if this logger is <c>INFO</c>
  26205. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  26206. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26207. implementation. If this logger is <c>INFO</c> enabled, then it converts
  26208. the message object (passed as parameter) to a string by invoking the appropriate
  26209. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26210. proceeds to call all the registered appenders in this logger
  26211. and also higher in the hierarchy depending on the value of
  26212. the additivity flag.
  26213. </para>
  26214. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26215. to this method will print the name of the <see cref="T:System.Exception"/>
  26216. but no stack trace. To print a stack trace use the
  26217. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26218. </para>
  26219. </remarks>
  26220. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26221. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26222. </member>
  26223. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)">
  26224. <summary>
  26225. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  26226. the stack trace of the <see cref="T:System.Exception"/> passed
  26227. as a parameter.
  26228. </summary>
  26229. <param name="logger">The logger on which the message is logged.</param>
  26230. <param name="message">The message object to log.</param>
  26231. <param name="exception">The exception to log, including its stack trace.</param>
  26232. <remarks>
  26233. <para>
  26234. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26235. </para>
  26236. </remarks>
  26237. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26238. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26239. </member>
  26240. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object)">
  26241. <summary>
  26242. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26243. </summary>
  26244. <param name="logger">The logger on which the message is logged.</param>
  26245. <param name="format">A String containing zero or more format items</param>
  26246. <param name="arg0">An Object to format</param>
  26247. <remarks>
  26248. <para>
  26249. The message is formatted using the <c>String.Format</c> method. See
  26250. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26251. of the formatting.
  26252. </para>
  26253. <para>
  26254. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26255. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
  26256. methods instead.
  26257. </para>
  26258. </remarks>
  26259. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26260. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26261. </member>
  26262. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object[])">
  26263. <summary>
  26264. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26265. </summary>
  26266. <param name="logger">The logger on which the message is logged.</param>
  26267. <param name="format">A String containing zero or more format items</param>
  26268. <param name="args">An Object array containing zero or more objects to format</param>
  26269. <remarks>
  26270. <para>
  26271. The message is formatted using the <c>String.Format</c> method. See
  26272. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26273. of the formatting.
  26274. </para>
  26275. <para>
  26276. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26277. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
  26278. methods instead.
  26279. </para>
  26280. </remarks>
  26281. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26282. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26283. </member>
  26284. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26285. <summary>
  26286. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26287. </summary>
  26288. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26289. <param name="logger">The logger on which the message is logged.</param>
  26290. <param name="format">A String containing zero or more format items</param>
  26291. <param name="args">An Object array containing zero or more objects to format</param>
  26292. <remarks>
  26293. <para>
  26294. The message is formatted using the <c>String.Format</c> method. See
  26295. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26296. of the formatting.
  26297. </para>
  26298. <para>
  26299. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26300. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
  26301. methods instead.
  26302. </para>
  26303. </remarks>
  26304. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26305. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26306. </member>
  26307. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26308. <summary>
  26309. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26310. </summary>
  26311. <param name="logger">The logger on which the message is logged.</param>
  26312. <param name="format">A String containing zero or more format items</param>
  26313. <param name="arg0">An Object to format</param>
  26314. <param name="arg1">An Object to format</param>
  26315. <remarks>
  26316. <para>
  26317. The message is formatted using the <c>String.Format</c> method. See
  26318. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26319. of the formatting.
  26320. </para>
  26321. <para>
  26322. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26323. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
  26324. methods instead.
  26325. </para>
  26326. </remarks>
  26327. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26328. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26329. </member>
  26330. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26331. <summary>
  26332. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26333. </summary>
  26334. <param name="logger">The logger on which the message is logged.</param>
  26335. <param name="format">A String containing zero or more format items</param>
  26336. <param name="arg0">An Object to format</param>
  26337. <param name="arg1">An Object to format</param>
  26338. <param name="arg2">An Object to format</param>
  26339. <remarks>
  26340. <para>
  26341. The message is formatted using the <c>String.Format</c> method. See
  26342. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26343. of the formatting.
  26344. </para>
  26345. <para>
  26346. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26347. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
  26348. methods instead.
  26349. </para>
  26350. </remarks>
  26351. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26352. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26353. </member>
  26354. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object})">
  26355. <summary>
  26356. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  26357. </summary>
  26358. <param name="logger">The logger on which the message is logged.</param>
  26359. <param name="callback">The lambda expression that gets the object to log.</param>
  26360. <remarks>
  26361. <para>
  26362. This method first checks if this logger is <c>INFO</c>
  26363. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  26364. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26365. implementation. If this logger is <c>INFO</c> enabled, then it converts
  26366. the message object (retrieved by invocation of the provided callback) to a
  26367. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26368. It then proceeds to call all the registered appenders in this logger
  26369. and also higher in the hierarchy depending on the value of
  26370. the additivity flag.
  26371. </para>
  26372. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26373. to this method will print the name of the <see cref="T:System.Exception"/>
  26374. but no stack trace. To print a stack trace use the
  26375. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26376. </para>
  26377. </remarks>
  26378. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26379. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26380. </member>
  26381. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26382. <summary>
  26383. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  26384. the stack trace of the <see cref="T:System.Exception"/> passed
  26385. as a parameter.
  26386. </summary>
  26387. <param name="logger">The logger on which the message is logged.</param>
  26388. <param name="callback">The lambda expression that gets the object to log.</param>
  26389. <param name="exception">The exception to log, including its stack trace.</param>
  26390. <remarks>
  26391. <para>
  26392. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26393. </para>
  26394. </remarks>
  26395. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26396. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26397. </member>
  26398. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)">
  26399. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads> //TODO
  26400. <summary>
  26401. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  26402. </summary>
  26403. <param name="logger">The logger on which the message is logged.</param>
  26404. <param name="message">The message object to log.</param>
  26405. <remarks>
  26406. <para>
  26407. This method first checks if this logger is <c>INFO</c>
  26408. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  26409. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26410. implementation. If this logger is <c>INFO</c> enabled, then it converts
  26411. the message object (passed as parameter) to a string by invoking the appropriate
  26412. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26413. proceeds to call all the registered appenders in this logger
  26414. and also higher in the hierarchy depending on the value of
  26415. the additivity flag.
  26416. </para>
  26417. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26418. to this method will print the name of the <see cref="T:System.Exception"/>
  26419. but no stack trace. To print a stack trace use the
  26420. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26421. </para>
  26422. </remarks>
  26423. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26424. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26425. </member>
  26426. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)">
  26427. <summary>
  26428. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  26429. the stack trace of the <see cref="T:System.Exception"/> passed
  26430. as a parameter.
  26431. </summary>
  26432. <param name="logger">The logger on which the message is logged.</param>
  26433. <param name="message">The message object to log.</param>
  26434. <param name="exception">The exception to log, including its stack trace.</param>
  26435. <remarks>
  26436. <para>
  26437. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26438. </para>
  26439. </remarks>
  26440. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26441. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26442. </member>
  26443. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object)">
  26444. <summary>
  26445. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  26446. </summary>
  26447. <param name="logger">The logger on which the message is logged.</param>
  26448. <param name="format">A String containing zero or more format items</param>
  26449. <param name="arg0">An Object to format</param>
  26450. <remarks>
  26451. <para>
  26452. The message is formatted using the <c>String.Format</c> method. See
  26453. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26454. of the formatting.
  26455. </para>
  26456. <para>
  26457. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26458. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
  26459. methods instead.
  26460. </para>
  26461. </remarks>
  26462. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26463. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26464. </member>
  26465. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object[])">
  26466. <summary>
  26467. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  26468. </summary>
  26469. <param name="logger">The logger on which the message is logged.</param>
  26470. <param name="format">A String containing zero or more format items</param>
  26471. <param name="args">An Object array containing zero or more objects to format</param>
  26472. <remarks>
  26473. <para>
  26474. The message is formatted using the <c>String.Format</c> method. See
  26475. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26476. of the formatting.
  26477. </para>
  26478. <para>
  26479. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26480. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
  26481. methods instead.
  26482. </para>
  26483. </remarks>
  26484. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26485. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26486. </member>
  26487. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26488. <summary>
  26489. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  26490. </summary>
  26491. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26492. <param name="logger">The logger on which the message is logged.</param>
  26493. <param name="format">A String containing zero or more format items</param>
  26494. <param name="args">An Object array containing zero or more objects to format</param>
  26495. <remarks>
  26496. <para>
  26497. The message is formatted using the <c>String.Format</c> method. See
  26498. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26499. of the formatting.
  26500. </para>
  26501. <para>
  26502. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26503. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
  26504. methods instead.
  26505. </para>
  26506. </remarks>
  26507. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26508. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26509. </member>
  26510. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26511. <summary>
  26512. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  26513. </summary>
  26514. <param name="logger">The logger on which the message is logged.</param>
  26515. <param name="format">A String containing zero or more format items</param>
  26516. <param name="arg0">An Object to format</param>
  26517. <param name="arg1">An Object to format</param>
  26518. <remarks>
  26519. <para>
  26520. The message is formatted using the <c>String.Format</c> method. See
  26521. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26522. of the formatting.
  26523. </para>
  26524. <para>
  26525. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26526. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
  26527. methods instead.
  26528. </para>
  26529. </remarks>
  26530. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26531. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26532. </member>
  26533. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26534. <summary>
  26535. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  26536. </summary>
  26537. <param name="logger">The logger on which the message is logged.</param>
  26538. <param name="format">A String containing zero or more format items</param>
  26539. <param name="arg0">An Object to format</param>
  26540. <param name="arg1">An Object to format</param>
  26541. <param name="arg2">An Object to format</param>
  26542. <remarks>
  26543. <para>
  26544. The message is formatted using the <c>String.Format</c> method. See
  26545. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26546. of the formatting.
  26547. </para>
  26548. <para>
  26549. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26550. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
  26551. methods instead.
  26552. </para>
  26553. </remarks>
  26554. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26555. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26556. </member>
  26557. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object})">
  26558. <summary>
  26559. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26560. </summary>
  26561. <param name="logger">The logger on which the message is logged.</param>
  26562. <param name="callback">The lambda expression that gets the object to log.</param>
  26563. <remarks>
  26564. <para>
  26565. This method first checks if this logger is <c>WARN</c>
  26566. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  26567. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26568. implementation. If this logger is <c>WARN</c> enabled, then it converts
  26569. the message object (retrieved by invocation of the provided callback) to a
  26570. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26571. It then proceeds to call all the registered appenders in this logger
  26572. and also higher in the hierarchy depending on the value of
  26573. the additivity flag.
  26574. </para>
  26575. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26576. to this method will print the name of the <see cref="T:System.Exception"/>
  26577. but no stack trace. To print a stack trace use the
  26578. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26579. </para>
  26580. </remarks>
  26581. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26582. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26583. </member>
  26584. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26585. <summary>
  26586. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  26587. the stack trace of the <see cref="T:System.Exception"/> passed
  26588. as a parameter.
  26589. </summary>
  26590. <param name="logger">The logger on which the message is logged.</param>
  26591. <param name="callback">The lambda expression that gets the object to log.</param>
  26592. <param name="exception">The exception to log, including its stack trace.</param>
  26593. <remarks>
  26594. <para>
  26595. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26596. </para>
  26597. </remarks>
  26598. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26599. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26600. </member>
  26601. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)">
  26602. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads> //TODO
  26603. <summary>
  26604. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26605. </summary>
  26606. <param name="logger">The logger on which the message is logged.</param>
  26607. <param name="message">The message object to log.</param>
  26608. <remarks>
  26609. <para>
  26610. This method first checks if this logger is <c>WARN</c>
  26611. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  26612. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26613. implementation. If this logger is <c>WARN</c> enabled, then it converts
  26614. the message object (passed as parameter) to a string by invoking the appropriate
  26615. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26616. proceeds to call all the registered appenders in this logger
  26617. and also higher in the hierarchy depending on the value of
  26618. the additivity flag.
  26619. </para>
  26620. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26621. to this method will print the name of the <see cref="T:System.Exception"/>
  26622. but no stack trace. To print a stack trace use the
  26623. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26624. </para>
  26625. </remarks>
  26626. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26627. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26628. </member>
  26629. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)">
  26630. <summary>
  26631. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  26632. the stack trace of the <see cref="T:System.Exception"/> passed
  26633. as a parameter.
  26634. </summary>
  26635. <param name="logger">The logger on which the message is logged.</param>
  26636. <param name="message">The message object to log.</param>
  26637. <param name="exception">The exception to log, including its stack trace.</param>
  26638. <remarks>
  26639. <para>
  26640. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26641. </para>
  26642. </remarks>
  26643. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26644. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26645. </member>
  26646. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object)">
  26647. <summary>
  26648. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26649. </summary>
  26650. <param name="logger">The logger on which the message is logged.</param>
  26651. <param name="format">A String containing zero or more format items</param>
  26652. <param name="arg0">An Object to format</param>
  26653. <remarks>
  26654. <para>
  26655. The message is formatted using the <c>String.Format</c> method. See
  26656. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26657. of the formatting.
  26658. </para>
  26659. <para>
  26660. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26661. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
  26662. methods instead.
  26663. </para>
  26664. </remarks>
  26665. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26666. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26667. </member>
  26668. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object[])">
  26669. <summary>
  26670. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26671. </summary>
  26672. <param name="logger">The logger on which the message is logged.</param>
  26673. <param name="format">A String containing zero or more format items</param>
  26674. <param name="args">An Object array containing zero or more objects to format</param>
  26675. <remarks>
  26676. <para>
  26677. The message is formatted using the <c>String.Format</c> method. See
  26678. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26679. of the formatting.
  26680. </para>
  26681. <para>
  26682. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26683. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
  26684. methods instead.
  26685. </para>
  26686. </remarks>
  26687. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26688. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26689. </member>
  26690. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26691. <summary>
  26692. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26693. </summary>
  26694. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26695. <param name="logger">The logger on which the message is logged.</param>
  26696. <param name="format">A String containing zero or more format items</param>
  26697. <param name="args">An Object array containing zero or more objects to format</param>
  26698. <remarks>
  26699. <para>
  26700. The message is formatted using the <c>String.Format</c> method. See
  26701. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26702. of the formatting.
  26703. </para>
  26704. <para>
  26705. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26706. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
  26707. methods instead.
  26708. </para>
  26709. </remarks>
  26710. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26711. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26712. </member>
  26713. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26714. <summary>
  26715. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26716. </summary>
  26717. <param name="logger">The logger on which the message is logged.</param>
  26718. <param name="format">A String containing zero or more format items</param>
  26719. <param name="arg0">An Object to format</param>
  26720. <param name="arg1">An Object to format</param>
  26721. <remarks>
  26722. <para>
  26723. The message is formatted using the <c>String.Format</c> method. See
  26724. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26725. of the formatting.
  26726. </para>
  26727. <para>
  26728. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26729. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
  26730. methods instead.
  26731. </para>
  26732. </remarks>
  26733. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26734. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26735. </member>
  26736. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26737. <summary>
  26738. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26739. </summary>
  26740. <param name="logger">The logger on which the message is logged.</param>
  26741. <param name="format">A String containing zero or more format items</param>
  26742. <param name="arg0">An Object to format</param>
  26743. <param name="arg1">An Object to format</param>
  26744. <param name="arg2">An Object to format</param>
  26745. <remarks>
  26746. <para>
  26747. The message is formatted using the <c>String.Format</c> method. See
  26748. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26749. of the formatting.
  26750. </para>
  26751. <para>
  26752. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26753. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
  26754. methods instead.
  26755. </para>
  26756. </remarks>
  26757. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26758. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26759. </member>
  26760. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object})">
  26761. <summary>
  26762. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  26763. </summary>
  26764. <param name="logger">The logger on which the message is logged.</param>
  26765. <param name="callback">The lambda expression that gets the object to log.</param>
  26766. <remarks>
  26767. <para>
  26768. This method first checks if this logger is <c>ERROR</c>
  26769. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  26770. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26771. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  26772. the message object (retrieved by invocation of the provided callback) to a
  26773. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26774. It then proceeds to call all the registered appenders in this logger
  26775. and also higher in the hierarchy depending on the value of
  26776. the additivity flag.
  26777. </para>
  26778. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26779. to this method will print the name of the <see cref="T:System.Exception"/>
  26780. but no stack trace. To print a stack trace use the
  26781. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26782. </para>
  26783. </remarks>
  26784. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26785. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26786. </member>
  26787. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26788. <summary>
  26789. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  26790. the stack trace of the <see cref="T:System.Exception"/> passed
  26791. as a parameter.
  26792. </summary>
  26793. <param name="logger">The logger on which the message is logged.</param>
  26794. <param name="callback">The lambda expression that gets the object to log.</param>
  26795. <param name="exception">The exception to log, including its stack trace.</param>
  26796. <remarks>
  26797. <para>
  26798. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26799. </para>
  26800. </remarks>
  26801. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26802. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26803. </member>
  26804. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)">
  26805. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads> //TODO
  26806. <summary>
  26807. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  26808. </summary>
  26809. <param name="logger">The logger on which the message is logged.</param>
  26810. <param name="message">The message object to log.</param>
  26811. <remarks>
  26812. <para>
  26813. This method first checks if this logger is <c>ERROR</c>
  26814. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  26815. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26816. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  26817. the message object (passed as parameter) to a string by invoking the appropriate
  26818. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26819. proceeds to call all the registered appenders in this logger
  26820. and also higher in the hierarchy depending on the value of
  26821. the additivity flag.
  26822. </para>
  26823. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26824. to this method will print the name of the <see cref="T:System.Exception"/>
  26825. but no stack trace. To print a stack trace use the
  26826. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26827. </para>
  26828. </remarks>
  26829. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26830. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26831. </member>
  26832. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)">
  26833. <summary>
  26834. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  26835. the stack trace of the <see cref="T:System.Exception"/> passed
  26836. as a parameter.
  26837. </summary>
  26838. <param name="logger">The logger on which the message is logged.</param>
  26839. <param name="message">The message object to log.</param>
  26840. <param name="exception">The exception to log, including its stack trace.</param>
  26841. <remarks>
  26842. <para>
  26843. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26844. </para>
  26845. </remarks>
  26846. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26847. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26848. </member>
  26849. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object)">
  26850. <summary>
  26851. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26852. </summary>
  26853. <param name="logger">The logger on which the message is logged.</param>
  26854. <param name="format">A String containing zero or more format items</param>
  26855. <param name="arg0">An Object to format</param>
  26856. <remarks>
  26857. <para>
  26858. The message is formatted using the <c>String.Format</c> method. See
  26859. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26860. of the formatting.
  26861. </para>
  26862. <para>
  26863. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26864. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
  26865. methods instead.
  26866. </para>
  26867. </remarks>
  26868. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26869. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26870. </member>
  26871. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object[])">
  26872. <summary>
  26873. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26874. </summary>
  26875. <param name="logger">The logger on which the message is logged.</param>
  26876. <param name="format">A String containing zero or more format items</param>
  26877. <param name="args">An Object array containing zero or more objects to format</param>
  26878. <remarks>
  26879. <para>
  26880. The message is formatted using the <c>String.Format</c> method. See
  26881. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26882. of the formatting.
  26883. </para>
  26884. <para>
  26885. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26886. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
  26887. methods instead.
  26888. </para>
  26889. </remarks>
  26890. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26891. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26892. </member>
  26893. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26894. <summary>
  26895. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26896. </summary>
  26897. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26898. <param name="logger">The logger on which the message is logged.</param>
  26899. <param name="format">A String containing zero or more format items</param>
  26900. <param name="args">An Object array containing zero or more objects to format</param>
  26901. <remarks>
  26902. <para>
  26903. The message is formatted using the <c>String.Format</c> method. See
  26904. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26905. of the formatting.
  26906. </para>
  26907. <para>
  26908. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26909. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
  26910. methods instead.
  26911. </para>
  26912. </remarks>
  26913. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26914. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26915. </member>
  26916. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26917. <summary>
  26918. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26919. </summary>
  26920. <param name="logger">The logger on which the message is logged.</param>
  26921. <param name="format">A String containing zero or more format items</param>
  26922. <param name="arg0">An Object to format</param>
  26923. <param name="arg1">An Object to format</param>
  26924. <remarks>
  26925. <para>
  26926. The message is formatted using the <c>String.Format</c> method. See
  26927. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26928. of the formatting.
  26929. </para>
  26930. <para>
  26931. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26932. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
  26933. methods instead.
  26934. </para>
  26935. </remarks>
  26936. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26937. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26938. </member>
  26939. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26940. <summary>
  26941. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26942. </summary>
  26943. <param name="logger">The logger on which the message is logged.</param>
  26944. <param name="format">A String containing zero or more format items</param>
  26945. <param name="arg0">An Object to format</param>
  26946. <param name="arg1">An Object to format</param>
  26947. <param name="arg2">An Object to format</param>
  26948. <remarks>
  26949. <para>
  26950. The message is formatted using the <c>String.Format</c> method. See
  26951. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26952. of the formatting.
  26953. </para>
  26954. <para>
  26955. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26956. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
  26957. methods instead.
  26958. </para>
  26959. </remarks>
  26960. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26961. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26962. </member>
  26963. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object})">
  26964. <summary>
  26965. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26966. </summary>
  26967. <param name="logger">The logger on which the message is logged.</param>
  26968. <param name="callback">The lambda expression that gets the object to log.</param>
  26969. <remarks>
  26970. <para>
  26971. This method first checks if this logger is <c>FATAL</c>
  26972. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  26973. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26974. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  26975. the message object (retrieved by invocation of the provided callback) to a
  26976. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26977. It then proceeds to call all the registered appenders in this logger
  26978. and also higher in the hierarchy depending on the value of
  26979. the additivity flag.
  26980. </para>
  26981. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26982. to this method will print the name of the <see cref="T:System.Exception"/>
  26983. but no stack trace. To print a stack trace use the
  26984. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26985. </para>
  26986. </remarks>
  26987. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26988. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26989. </member>
  26990. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26991. <summary>
  26992. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  26993. the stack trace of the <see cref="T:System.Exception"/> passed
  26994. as a parameter.
  26995. </summary>
  26996. <param name="logger">The logger on which the message is logged.</param>
  26997. <param name="callback">The lambda expression that gets the object to log.</param>
  26998. <param name="exception">The exception to log, including its stack trace.</param>
  26999. <remarks>
  27000. <para>
  27001. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  27002. </para>
  27003. </remarks>
  27004. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  27005. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  27006. </member>
  27007. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)">
  27008. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads> //TODO
  27009. <summary>
  27010. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  27011. </summary>
  27012. <param name="logger">The logger on which the message is logged.</param>
  27013. <param name="message">The message object to log.</param>
  27014. <remarks>
  27015. <para>
  27016. This method first checks if this logger is <c>FATAL</c>
  27017. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  27018. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  27019. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  27020. the message object (passed as parameter) to a string by invoking the appropriate
  27021. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  27022. proceeds to call all the registered appenders in this logger
  27023. and also higher in the hierarchy depending on the value of
  27024. the additivity flag.
  27025. </para>
  27026. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  27027. to this method will print the name of the <see cref="T:System.Exception"/>
  27028. but no stack trace. To print a stack trace use the
  27029. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  27030. </para>
  27031. </remarks>
  27032. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  27033. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  27034. </member>
  27035. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)">
  27036. <summary>
  27037. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  27038. the stack trace of the <see cref="T:System.Exception"/> passed
  27039. as a parameter.
  27040. </summary>
  27041. <param name="logger">The logger on which the message is logged.</param>
  27042. <param name="message">The message object to log.</param>
  27043. <param name="exception">The exception to log, including its stack trace.</param>
  27044. <remarks>
  27045. <para>
  27046. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  27047. </para>
  27048. </remarks>
  27049. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  27050. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  27051. </member>
  27052. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object)">
  27053. <summary>
  27054. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  27055. </summary>
  27056. <param name="logger">The logger on which the message is logged.</param>
  27057. <param name="format">A String containing zero or more format items</param>
  27058. <param name="arg0">An Object to format</param>
  27059. <remarks>
  27060. <para>
  27061. The message is formatted using the <c>String.Format</c> method. See
  27062. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  27063. of the formatting.
  27064. </para>
  27065. <para>
  27066. This method does not take an <see cref="T:System.Exception"/> object to include in the
  27067. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
  27068. methods instead.
  27069. </para>
  27070. </remarks>
  27071. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  27072. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  27073. </member>
  27074. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object[])">
  27075. <summary>
  27076. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  27077. </summary>
  27078. <param name="logger">The logger on which the message is logged.</param>
  27079. <param name="format">A String containing zero or more format items</param>
  27080. <param name="args">An Object array containing zero or more objects to format</param>
  27081. <remarks>
  27082. <para>
  27083. The message is formatted using the <c>String.Format</c> method. See
  27084. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  27085. of the formatting.
  27086. </para>
  27087. <para>
  27088. This method does not take an <see cref="T:System.Exception"/> object to include in the
  27089. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
  27090. methods instead.
  27091. </para>
  27092. </remarks>
  27093. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  27094. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  27095. </member>
  27096. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  27097. <summary>
  27098. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  27099. </summary>
  27100. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  27101. <param name="logger">The logger on which the message is logged.</param>
  27102. <param name="format">A String containing zero or more format items</param>
  27103. <param name="args">An Object array containing zero or more objects to format</param>
  27104. <remarks>
  27105. <para>
  27106. The message is formatted using the <c>String.Format</c> method. See
  27107. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  27108. of the formatting.
  27109. </para>
  27110. <para>
  27111. This method does not take an <see cref="T:System.Exception"/> object to include in the
  27112. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
  27113. methods instead.
  27114. </para>
  27115. </remarks>
  27116. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  27117. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  27118. </member>
  27119. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  27120. <summary>
  27121. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  27122. </summary>
  27123. <param name="logger">The logger on which the message is logged.</param>
  27124. <param name="format">A String containing zero or more format items</param>
  27125. <param name="arg0">An Object to format</param>
  27126. <param name="arg1">An Object to format</param>
  27127. <remarks>
  27128. <para>
  27129. The message is formatted using the <c>String.Format</c> method. See
  27130. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  27131. of the formatting.
  27132. </para>
  27133. <para>
  27134. This method does not take an <see cref="T:System.Exception"/> object to include in the
  27135. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
  27136. methods instead.
  27137. </para>
  27138. </remarks>
  27139. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  27140. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  27141. </member>
  27142. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  27143. <summary>
  27144. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  27145. </summary>
  27146. <param name="logger">The logger on which the message is logged.</param>
  27147. <param name="format">A String containing zero or more format items</param>
  27148. <param name="arg0">An Object to format</param>
  27149. <param name="arg1">An Object to format</param>
  27150. <param name="arg2">An Object to format</param>
  27151. <remarks>
  27152. <para>
  27153. The message is formatted using the <c>String.Format</c> method. See
  27154. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  27155. of the formatting.
  27156. </para>
  27157. <para>
  27158. This method does not take an <see cref="T:System.Exception"/> object to include in the
  27159. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
  27160. methods instead.
  27161. </para>
  27162. </remarks>
  27163. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  27164. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  27165. </member>
  27166. <member name="T:log4net.Util.LevelMapping">
  27167. <summary>
  27168. Manages a mapping from levels to <see cref="T:log4net.Util.LevelMappingEntry"/>
  27169. </summary>
  27170. <remarks>
  27171. <para>
  27172. Manages an ordered mapping from <see cref="T:log4net.Core.Level"/> instances
  27173. to <see cref="T:log4net.Util.LevelMappingEntry"/> subclasses.
  27174. </para>
  27175. </remarks>
  27176. <author>Nicko Cadell</author>
  27177. </member>
  27178. <member name="M:log4net.Util.LevelMapping.#ctor">
  27179. <summary>
  27180. Default constructor
  27181. </summary>
  27182. <remarks>
  27183. <para>
  27184. Initialise a new instance of <see cref="T:log4net.Util.LevelMapping"/>.
  27185. </para>
  27186. </remarks>
  27187. </member>
  27188. <member name="M:log4net.Util.LevelMapping.Add(log4net.Util.LevelMappingEntry)">
  27189. <summary>
  27190. Add a <see cref="T:log4net.Util.LevelMappingEntry"/> to this mapping
  27191. </summary>
  27192. <param name="entry">the entry to add</param>
  27193. <remarks>
  27194. <para>
  27195. If a <see cref="T:log4net.Util.LevelMappingEntry"/> has previously been added
  27196. for the same <see cref="T:log4net.Core.Level"/> then that entry will be
  27197. overwritten.
  27198. </para>
  27199. </remarks>
  27200. </member>
  27201. <member name="M:log4net.Util.LevelMapping.Lookup(log4net.Core.Level)">
  27202. <summary>
  27203. Lookup the mapping for the specified level
  27204. </summary>
  27205. <param name="level">the level to lookup</param>
  27206. <returns>the <see cref="T:log4net.Util.LevelMappingEntry"/> for the level or <c>null</c> if no mapping found</returns>
  27207. <remarks>
  27208. <para>
  27209. Lookup the value for the specified level. Finds the nearest
  27210. mapping value for the level that is equal to or less than the
  27211. <paramref name="level"/> specified.
  27212. </para>
  27213. <para>
  27214. If no mapping could be found then <c>null</c> is returned.
  27215. </para>
  27216. </remarks>
  27217. </member>
  27218. <member name="M:log4net.Util.LevelMapping.ActivateOptions">
  27219. <summary>
  27220. Initialize options
  27221. </summary>
  27222. <remarks>
  27223. <para>
  27224. Caches the sorted list of <see cref="T:log4net.Util.LevelMappingEntry"/> in an array
  27225. </para>
  27226. </remarks>
  27227. </member>
  27228. <member name="T:log4net.Util.LogicalThreadContextProperties">
  27229. <summary>
  27230. Implementation of Properties collection for the <see cref="T:log4net.LogicalThreadContext"/>
  27231. </summary>
  27232. <remarks>
  27233. <para>
  27234. Class implements a collection of properties that is specific to each thread.
  27235. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  27236. </para>
  27237. <para>
  27238. This class stores its properties in a slot on the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> named
  27239. <c>log4net.Util.LogicalThreadContextProperties</c>.
  27240. </para>
  27241. <para>
  27242. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  27243. <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
  27244. <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  27245. If the calling code does not have this permission then this context will be disabled.
  27246. It will not store any property values set on it.
  27247. </para>
  27248. </remarks>
  27249. <author>Nicko Cadell</author>
  27250. </member>
  27251. <member name="F:log4net.Util.LogicalThreadContextProperties.m_disabled">
  27252. <summary>
  27253. Flag used to disable this context if we don't have permission to access the CallContext.
  27254. </summary>
  27255. </member>
  27256. <member name="M:log4net.Util.LogicalThreadContextProperties.#ctor">
  27257. <summary>
  27258. Constructor
  27259. </summary>
  27260. <remarks>
  27261. <para>
  27262. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextProperties"/> class.
  27263. </para>
  27264. </remarks>
  27265. </member>
  27266. <member name="M:log4net.Util.LogicalThreadContextProperties.Remove(System.String)">
  27267. <summary>
  27268. Remove a property
  27269. </summary>
  27270. <param name="key">the key for the entry to remove</param>
  27271. <remarks>
  27272. <para>
  27273. Remove the value for the specified <paramref name="key"/> from the context.
  27274. </para>
  27275. </remarks>
  27276. </member>
  27277. <member name="M:log4net.Util.LogicalThreadContextProperties.Clear">
  27278. <summary>
  27279. Clear all the context properties
  27280. </summary>
  27281. <remarks>
  27282. <para>
  27283. Clear all the context properties
  27284. </para>
  27285. </remarks>
  27286. </member>
  27287. <member name="M:log4net.Util.LogicalThreadContextProperties.GetProperties(System.Boolean)">
  27288. <summary>
  27289. Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread.
  27290. </summary>
  27291. <param name="create">create the dictionary if it does not exist, otherwise return null if is does not exist</param>
  27292. <returns>the properties for this thread</returns>
  27293. <remarks>
  27294. <para>
  27295. The collection returned is only to be used on the calling thread. If the
  27296. caller needs to share the collection between different threads then the
  27297. caller must clone the collection before doings so.
  27298. </para>
  27299. </remarks>
  27300. </member>
  27301. <member name="M:log4net.Util.LogicalThreadContextProperties.GetCallContextData">
  27302. <summary>
  27303. Gets the call context get data.
  27304. </summary>
  27305. <returns>The peroperties dictionary stored in the call context</returns>
  27306. <remarks>
  27307. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.GetData(System.String)"/> has a
  27308. security link demand, therfore we must put the method call in a seperate method
  27309. that we can wrap in an exception handler.
  27310. </remarks>
  27311. </member>
  27312. <member name="M:log4net.Util.LogicalThreadContextProperties.SetCallContextData(log4net.Util.PropertiesDictionary)">
  27313. <summary>
  27314. Sets the call context data.
  27315. </summary>
  27316. <param name="properties">The properties.</param>
  27317. <remarks>
  27318. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.SetData(System.String,System.Object)"/> has a
  27319. security link demand, therfore we must put the method call in a seperate method
  27320. that we can wrap in an exception handler.
  27321. </remarks>
  27322. </member>
  27323. <member name="F:log4net.Util.LogicalThreadContextProperties.declaringType">
  27324. <summary>
  27325. The fully qualified type of the LogicalThreadContextProperties class.
  27326. </summary>
  27327. <remarks>
  27328. Used by the internal logger to record the Type of the
  27329. log message.
  27330. </remarks>
  27331. </member>
  27332. <member name="P:log4net.Util.LogicalThreadContextProperties.Item(System.String)">
  27333. <summary>
  27334. Gets or sets the value of a property
  27335. </summary>
  27336. <value>
  27337. The value for the property with the specified key
  27338. </value>
  27339. <remarks>
  27340. <para>
  27341. Get or set the property value for the <paramref name="key"/> specified.
  27342. </para>
  27343. </remarks>
  27344. </member>
  27345. <member name="T:log4net.Util.TwoArgAction`2">
  27346. <summary>
  27347. Delegate type used for LogicalThreadContextStack's callbacks.
  27348. </summary>
  27349. </member>
  27350. <member name="T:log4net.Util.LogicalThreadContextStack">
  27351. <summary>
  27352. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  27353. </summary>
  27354. <remarks>
  27355. <para>
  27356. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  27357. </para>
  27358. </remarks>
  27359. <author>Nicko Cadell</author>
  27360. </member>
  27361. <member name="F:log4net.Util.LogicalThreadContextStack.m_stack">
  27362. <summary>
  27363. The stack store.
  27364. </summary>
  27365. </member>
  27366. <member name="F:log4net.Util.LogicalThreadContextStack.m_propertyKey">
  27367. <summary>
  27368. The name of this <see cref="T:log4net.Util.LogicalThreadContextStack"/> within the
  27369. <see cref="T:log4net.Util.LogicalThreadContextProperties"/>.
  27370. </summary>
  27371. </member>
  27372. <member name="F:log4net.Util.LogicalThreadContextStack.m_registerNew">
  27373. <summary>
  27374. The callback used to let the <see cref="T:log4net.Util.LogicalThreadContextStacks"/> register a
  27375. new instance of a <see cref="T:log4net.Util.LogicalThreadContextStack"/>.
  27376. </summary>
  27377. </member>
  27378. <member name="M:log4net.Util.LogicalThreadContextStack.#ctor(System.String,log4net.Util.TwoArgAction{System.String,log4net.Util.LogicalThreadContextStack})">
  27379. <summary>
  27380. Internal constructor
  27381. </summary>
  27382. <remarks>
  27383. <para>
  27384. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack"/> class.
  27385. </para>
  27386. </remarks>
  27387. </member>
  27388. <member name="M:log4net.Util.LogicalThreadContextStack.Clear">
  27389. <summary>
  27390. Clears all the contextual information held in this stack.
  27391. </summary>
  27392. <remarks>
  27393. <para>
  27394. Clears all the contextual information held in this stack.
  27395. Only call this if you think that this thread is being reused after
  27396. a previous call execution which may not have completed correctly.
  27397. You do not need to use this method if you always guarantee to call
  27398. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  27399. returned from <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  27400. for example by using the <c>using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  27401. syntax.
  27402. </para>
  27403. </remarks>
  27404. </member>
  27405. <member name="M:log4net.Util.LogicalThreadContextStack.Pop">
  27406. <summary>
  27407. Removes the top context from this stack.
  27408. </summary>
  27409. <returns>The message in the context that was removed from the top of this stack.</returns>
  27410. <remarks>
  27411. <para>
  27412. Remove the top context from this stack, and return
  27413. it to the caller. If this stack is empty then an
  27414. empty string (not <see langword="null"/>) is returned.
  27415. </para>
  27416. </remarks>
  27417. </member>
  27418. <member name="M:log4net.Util.LogicalThreadContextStack.Push(System.String)">
  27419. <summary>
  27420. Pushes a new context message into this stack.
  27421. </summary>
  27422. <param name="message">The new context message.</param>
  27423. <returns>
  27424. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  27425. </returns>
  27426. <remarks>
  27427. <para>
  27428. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  27429. is returned that can be used to clean up this stack. This
  27430. can be easily combined with the <c>using</c> keyword to scope the
  27431. context.
  27432. </para>
  27433. </remarks>
  27434. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  27435. <code lang="C#">
  27436. using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))
  27437. {
  27438. log.Warn("This should have an ThreadContext Stack message");
  27439. }
  27440. </code>
  27441. </example>
  27442. </member>
  27443. <member name="M:log4net.Util.LogicalThreadContextStack.GetFullMessage">
  27444. <summary>
  27445. Gets the current context information for this stack.
  27446. </summary>
  27447. <returns>The current context information.</returns>
  27448. </member>
  27449. <member name="M:log4net.Util.LogicalThreadContextStack.ToString">
  27450. <summary>
  27451. Gets the current context information for this stack.
  27452. </summary>
  27453. <returns>Gets the current context information</returns>
  27454. <remarks>
  27455. <para>
  27456. Gets the current context information for this stack.
  27457. </para>
  27458. </remarks>
  27459. </member>
  27460. <member name="M:log4net.Util.LogicalThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  27461. <summary>
  27462. Get a portable version of this object
  27463. </summary>
  27464. <returns>the portable instance of this object</returns>
  27465. <remarks>
  27466. <para>
  27467. Get a cross thread portable version of this object
  27468. </para>
  27469. </remarks>
  27470. </member>
  27471. <member name="P:log4net.Util.LogicalThreadContextStack.Count">
  27472. <summary>
  27473. The number of messages in the stack
  27474. </summary>
  27475. <value>
  27476. The current number of messages in the stack
  27477. </value>
  27478. <remarks>
  27479. <para>
  27480. The current number of messages in the stack. That is
  27481. the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> has been called
  27482. minus the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Pop"/> has been called.
  27483. </para>
  27484. </remarks>
  27485. </member>
  27486. <member name="P:log4net.Util.LogicalThreadContextStack.InternalStack">
  27487. <summary>
  27488. Gets and sets the internal stack used by this <see cref="T:log4net.Util.LogicalThreadContextStack"/>
  27489. </summary>
  27490. <value>The internal storage stack</value>
  27491. <remarks>
  27492. <para>
  27493. This property is provided only to support backward compatability
  27494. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  27495. be modified.
  27496. </para>
  27497. </remarks>
  27498. </member>
  27499. <member name="T:log4net.Util.LogicalThreadContextStack.StackFrame">
  27500. <summary>
  27501. Inner class used to represent a single context frame in the stack.
  27502. </summary>
  27503. <remarks>
  27504. <para>
  27505. Inner class used to represent a single context frame in the stack.
  27506. </para>
  27507. </remarks>
  27508. </member>
  27509. <member name="M:log4net.Util.LogicalThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.LogicalThreadContextStack.StackFrame)">
  27510. <summary>
  27511. Constructor
  27512. </summary>
  27513. <param name="message">The message for this context.</param>
  27514. <param name="parent">The parent context in the chain.</param>
  27515. <remarks>
  27516. <para>
  27517. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.StackFrame"/> class
  27518. with the specified message and parent context.
  27519. </para>
  27520. </remarks>
  27521. </member>
  27522. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.Message">
  27523. <summary>
  27524. Get the message.
  27525. </summary>
  27526. <value>The message.</value>
  27527. <remarks>
  27528. <para>
  27529. Get the message.
  27530. </para>
  27531. </remarks>
  27532. </member>
  27533. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.FullMessage">
  27534. <summary>
  27535. Gets the full text of the context down to the root level.
  27536. </summary>
  27537. <value>
  27538. The full text of the context down to the root level.
  27539. </value>
  27540. <remarks>
  27541. <para>
  27542. Gets the full text of the context down to the root level.
  27543. </para>
  27544. </remarks>
  27545. </member>
  27546. <member name="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame">
  27547. <summary>
  27548. Struct returned from the <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> method.
  27549. </summary>
  27550. <remarks>
  27551. <para>
  27552. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  27553. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  27554. </para>
  27555. </remarks>
  27556. </member>
  27557. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_frameDepth">
  27558. <summary>
  27559. The depth to trim the stack to when this instance is disposed
  27560. </summary>
  27561. </member>
  27562. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_logicalThreadContextStack">
  27563. <summary>
  27564. The outer LogicalThreadContextStack.
  27565. </summary>
  27566. </member>
  27567. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.#ctor(log4net.Util.LogicalThreadContextStack,System.Int32)">
  27568. <summary>
  27569. Constructor
  27570. </summary>
  27571. <param name="logicalThreadContextStack">The internal stack used by the ThreadContextStack.</param>
  27572. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  27573. <remarks>
  27574. <para>
  27575. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame"/> class with
  27576. the specified stack and return depth.
  27577. </para>
  27578. </remarks>
  27579. </member>
  27580. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.Dispose">
  27581. <summary>
  27582. Returns the stack to the correct depth.
  27583. </summary>
  27584. <remarks>
  27585. <para>
  27586. Returns the stack to the correct depth.
  27587. </para>
  27588. </remarks>
  27589. </member>
  27590. <member name="T:log4net.Util.LogicalThreadContextStacks">
  27591. <summary>
  27592. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  27593. </summary>
  27594. <remarks>
  27595. <para>
  27596. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  27597. </para>
  27598. </remarks>
  27599. <author>Nicko Cadell</author>
  27600. </member>
  27601. <member name="M:log4net.Util.LogicalThreadContextStacks.#ctor(log4net.Util.LogicalThreadContextProperties)">
  27602. <summary>
  27603. Internal constructor
  27604. </summary>
  27605. <remarks>
  27606. <para>
  27607. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks"/> class.
  27608. </para>
  27609. </remarks>
  27610. </member>
  27611. <member name="F:log4net.Util.LogicalThreadContextStacks.declaringType">
  27612. <summary>
  27613. The fully qualified type of the ThreadContextStacks class.
  27614. </summary>
  27615. <remarks>
  27616. Used by the internal logger to record the Type of the
  27617. log message.
  27618. </remarks>
  27619. </member>
  27620. <member name="P:log4net.Util.LogicalThreadContextStacks.Item(System.String)">
  27621. <summary>
  27622. Gets the named thread context stack
  27623. </summary>
  27624. <value>
  27625. The named stack
  27626. </value>
  27627. <remarks>
  27628. <para>
  27629. Gets the named thread context stack
  27630. </para>
  27631. </remarks>
  27632. </member>
  27633. <member name="T:log4net.Util.LogReceivedEventHandler">
  27634. <summary>
  27635. </summary>
  27636. <param name="source"></param>
  27637. <param name="e"></param>
  27638. </member>
  27639. <member name="T:log4net.Util.LogLog">
  27640. <summary>
  27641. Outputs log statements from within the log4net assembly.
  27642. </summary>
  27643. <remarks>
  27644. <para>
  27645. Log4net components cannot make log4net logging calls. However, it is
  27646. sometimes useful for the user to learn about what log4net is
  27647. doing.
  27648. </para>
  27649. <para>
  27650. All log4net internal debug calls go to the standard output stream
  27651. whereas internal error messages are sent to the standard error output
  27652. stream.
  27653. </para>
  27654. </remarks>
  27655. <author>Nicko Cadell</author>
  27656. <author>Gert Driesen</author>
  27657. </member>
  27658. <member name="M:log4net.Util.LogLog.ToString">
  27659. <summary>
  27660. Formats Prefix, Source, and Message in the same format as the value
  27661. sent to Console.Out and Trace.Write.
  27662. </summary>
  27663. <returns></returns>
  27664. </member>
  27665. <member name="M:log4net.Util.LogLog.#ctor(System.Type,System.String,System.String,System.Exception)">
  27666. <summary>
  27667. Initializes a new instance of the <see cref="T:log4net.Util.LogLog"/> class.
  27668. </summary>
  27669. <param name="source"></param>
  27670. <param name="prefix"></param>
  27671. <param name="message"></param>
  27672. <param name="exception"></param>
  27673. </member>
  27674. <member name="M:log4net.Util.LogLog.#cctor">
  27675. <summary>
  27676. Static constructor that initializes logging by reading
  27677. settings from the application configuration file.
  27678. </summary>
  27679. <remarks>
  27680. <para>
  27681. The <c>log4net.Internal.Debug</c> application setting
  27682. controls internal debugging. This setting should be set
  27683. to <c>true</c> to enable debugging.
  27684. </para>
  27685. <para>
  27686. The <c>log4net.Internal.Quiet</c> application setting
  27687. suppresses all internal logging including error messages.
  27688. This setting should be set to <c>true</c> to enable message
  27689. suppression.
  27690. </para>
  27691. </remarks>
  27692. </member>
  27693. <member name="M:log4net.Util.LogLog.OnLogReceived(System.Type,System.String,System.String,System.Exception)">
  27694. <summary>
  27695. Raises the LogReceived event when an internal messages is received.
  27696. </summary>
  27697. <param name="source"></param>
  27698. <param name="prefix"></param>
  27699. <param name="message"></param>
  27700. <param name="exception"></param>
  27701. </member>
  27702. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String)">
  27703. <summary>
  27704. Writes log4net internal debug messages to the
  27705. standard output stream.
  27706. </summary>
  27707. <param name="source"></param>
  27708. <param name="message">The message to log.</param>
  27709. <remarks>
  27710. <para>
  27711. All internal debug messages are prepended with
  27712. the string "log4net: ".
  27713. </para>
  27714. </remarks>
  27715. </member>
  27716. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String,System.Exception)">
  27717. <summary>
  27718. Writes log4net internal debug messages to the
  27719. standard output stream.
  27720. </summary>
  27721. <param name="source">The Type that generated this message.</param>
  27722. <param name="message">The message to log.</param>
  27723. <param name="exception">An exception to log.</param>
  27724. <remarks>
  27725. <para>
  27726. All internal debug messages are prepended with
  27727. the string "log4net: ".
  27728. </para>
  27729. </remarks>
  27730. </member>
  27731. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String)">
  27732. <summary>
  27733. Writes log4net internal warning messages to the
  27734. standard error stream.
  27735. </summary>
  27736. <param name="source">The Type that generated this message.</param>
  27737. <param name="message">The message to log.</param>
  27738. <remarks>
  27739. <para>
  27740. All internal warning messages are prepended with
  27741. the string "log4net:WARN ".
  27742. </para>
  27743. </remarks>
  27744. </member>
  27745. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String,System.Exception)">
  27746. <summary>
  27747. Writes log4net internal warning messages to the
  27748. standard error stream.
  27749. </summary>
  27750. <param name="source">The Type that generated this message.</param>
  27751. <param name="message">The message to log.</param>
  27752. <param name="exception">An exception to log.</param>
  27753. <remarks>
  27754. <para>
  27755. All internal warning messages are prepended with
  27756. the string "log4net:WARN ".
  27757. </para>
  27758. </remarks>
  27759. </member>
  27760. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String)">
  27761. <summary>
  27762. Writes log4net internal error messages to the
  27763. standard error stream.
  27764. </summary>
  27765. <param name="source">The Type that generated this message.</param>
  27766. <param name="message">The message to log.</param>
  27767. <remarks>
  27768. <para>
  27769. All internal error messages are prepended with
  27770. the string "log4net:ERROR ".
  27771. </para>
  27772. </remarks>
  27773. </member>
  27774. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String,System.Exception)">
  27775. <summary>
  27776. Writes log4net internal error messages to the
  27777. standard error stream.
  27778. </summary>
  27779. <param name="source">The Type that generated this message.</param>
  27780. <param name="message">The message to log.</param>
  27781. <param name="exception">An exception to log.</param>
  27782. <remarks>
  27783. <para>
  27784. All internal debug messages are prepended with
  27785. the string "log4net:ERROR ".
  27786. </para>
  27787. </remarks>
  27788. </member>
  27789. <member name="M:log4net.Util.LogLog.EmitOutLine(System.String)">
  27790. <summary>
  27791. Writes output to the standard output stream.
  27792. </summary>
  27793. <param name="message">The message to log.</param>
  27794. <remarks>
  27795. <para>
  27796. Writes to both Console.Out and System.Diagnostics.Trace.
  27797. Note that the System.Diagnostics.Trace is not supported
  27798. on the Compact Framework.
  27799. </para>
  27800. <para>
  27801. If the AppDomain is not configured with a config file then
  27802. the call to System.Diagnostics.Trace may fail. This is only
  27803. an issue if you are programmatically creating your own AppDomains.
  27804. </para>
  27805. </remarks>
  27806. </member>
  27807. <member name="M:log4net.Util.LogLog.EmitErrorLine(System.String)">
  27808. <summary>
  27809. Writes output to the standard error stream.
  27810. </summary>
  27811. <param name="message">The message to log.</param>
  27812. <remarks>
  27813. <para>
  27814. Writes to both Console.Error and System.Diagnostics.Trace.
  27815. Note that the System.Diagnostics.Trace is not supported
  27816. on the Compact Framework.
  27817. </para>
  27818. <para>
  27819. If the AppDomain is not configured with a config file then
  27820. the call to System.Diagnostics.Trace may fail. This is only
  27821. an issue if you are programmatically creating your own AppDomains.
  27822. </para>
  27823. </remarks>
  27824. </member>
  27825. <member name="F:log4net.Util.LogLog.s_debugEnabled">
  27826. <summary>
  27827. Default debug level
  27828. </summary>
  27829. </member>
  27830. <member name="F:log4net.Util.LogLog.s_quietMode">
  27831. <summary>
  27832. In quietMode not even errors generate any output.
  27833. </summary>
  27834. </member>
  27835. <member name="E:log4net.Util.LogLog.LogReceived">
  27836. <summary>
  27837. The event raised when an internal message has been received.
  27838. </summary>
  27839. </member>
  27840. <member name="P:log4net.Util.LogLog.Source">
  27841. <summary>
  27842. The Type that generated the internal message.
  27843. </summary>
  27844. </member>
  27845. <member name="P:log4net.Util.LogLog.TimeStamp">
  27846. <summary>
  27847. The DateTime stamp of when the internal message was received.
  27848. </summary>
  27849. </member>
  27850. <member name="P:log4net.Util.LogLog.TimeStampUtc">
  27851. <summary>
  27852. The UTC DateTime stamp of when the internal message was received.
  27853. </summary>
  27854. </member>
  27855. <member name="P:log4net.Util.LogLog.Prefix">
  27856. <summary>
  27857. A string indicating the severity of the internal message.
  27858. </summary>
  27859. <remarks>
  27860. "log4net: ",
  27861. "log4net:ERROR ",
  27862. "log4net:WARN "
  27863. </remarks>
  27864. </member>
  27865. <member name="P:log4net.Util.LogLog.Message">
  27866. <summary>
  27867. The internal log message.
  27868. </summary>
  27869. </member>
  27870. <member name="P:log4net.Util.LogLog.Exception">
  27871. <summary>
  27872. The Exception related to the message.
  27873. </summary>
  27874. <remarks>
  27875. Optional. Will be null if no Exception was passed.
  27876. </remarks>
  27877. </member>
  27878. <member name="P:log4net.Util.LogLog.InternalDebugging">
  27879. <summary>
  27880. Gets or sets a value indicating whether log4net internal logging
  27881. is enabled or disabled.
  27882. </summary>
  27883. <value>
  27884. <c>true</c> if log4net internal logging is enabled, otherwise
  27885. <c>false</c>.
  27886. </value>
  27887. <remarks>
  27888. <para>
  27889. When set to <c>true</c>, internal debug level logging will be
  27890. displayed.
  27891. </para>
  27892. <para>
  27893. This value can be set by setting the application setting
  27894. <c>log4net.Internal.Debug</c> in the application configuration
  27895. file.
  27896. </para>
  27897. <para>
  27898. The default value is <c>false</c>, i.e. debugging is
  27899. disabled.
  27900. </para>
  27901. </remarks>
  27902. <example>
  27903. <para>
  27904. The following example enables internal debugging using the
  27905. application configuration file :
  27906. </para>
  27907. <code lang="XML" escaped="true">
  27908. <configuration>
  27909. <appSettings>
  27910. <add key="log4net.Internal.Debug" value="true" />
  27911. </appSettings>
  27912. </configuration>
  27913. </code>
  27914. </example>
  27915. </member>
  27916. <member name="P:log4net.Util.LogLog.QuietMode">
  27917. <summary>
  27918. Gets or sets a value indicating whether log4net should generate no output
  27919. from internal logging, not even for errors.
  27920. </summary>
  27921. <value>
  27922. <c>true</c> if log4net should generate no output at all from internal
  27923. logging, otherwise <c>false</c>.
  27924. </value>
  27925. <remarks>
  27926. <para>
  27927. When set to <c>true</c> will cause internal logging at all levels to be
  27928. suppressed. This means that no warning or error reports will be logged.
  27929. This option overrides the <see cref="P:log4net.Util.LogLog.InternalDebugging"/> setting and
  27930. disables all debug also.
  27931. </para>
  27932. <para>This value can be set by setting the application setting
  27933. <c>log4net.Internal.Quiet</c> in the application configuration file.
  27934. </para>
  27935. <para>
  27936. The default value is <c>false</c>, i.e. internal logging is not
  27937. disabled.
  27938. </para>
  27939. </remarks>
  27940. <example>
  27941. The following example disables internal logging using the
  27942. application configuration file :
  27943. <code lang="XML" escaped="true">
  27944. <configuration>
  27945. <appSettings>
  27946. <add key="log4net.Internal.Quiet" value="true"/>
  27947. </appSettings>
  27948. </configuration>
  27949. </code>
  27950. </example>
  27951. </member>
  27952. <member name="P:log4net.Util.LogLog.EmitInternalMessages">
  27953. <summary>
  27954. </summary>
  27955. </member>
  27956. <member name="P:log4net.Util.LogLog.IsDebugEnabled">
  27957. <summary>
  27958. Test if LogLog.Debug is enabled for output.
  27959. </summary>
  27960. <value>
  27961. <c>true</c> if Debug is enabled
  27962. </value>
  27963. <remarks>
  27964. <para>
  27965. Test if LogLog.Debug is enabled for output.
  27966. </para>
  27967. </remarks>
  27968. </member>
  27969. <member name="P:log4net.Util.LogLog.IsWarnEnabled">
  27970. <summary>
  27971. Test if LogLog.Warn is enabled for output.
  27972. </summary>
  27973. <value>
  27974. <c>true</c> if Warn is enabled
  27975. </value>
  27976. <remarks>
  27977. <para>
  27978. Test if LogLog.Warn is enabled for output.
  27979. </para>
  27980. </remarks>
  27981. </member>
  27982. <member name="P:log4net.Util.LogLog.IsErrorEnabled">
  27983. <summary>
  27984. Test if LogLog.Error is enabled for output.
  27985. </summary>
  27986. <value>
  27987. <c>true</c> if Error is enabled
  27988. </value>
  27989. <remarks>
  27990. <para>
  27991. Test if LogLog.Error is enabled for output.
  27992. </para>
  27993. </remarks>
  27994. </member>
  27995. <member name="T:log4net.Util.LogLog.LogReceivedAdapter">
  27996. <summary>
  27997. Subscribes to the LogLog.LogReceived event and stores messages
  27998. to the supplied IList instance.
  27999. </summary>
  28000. </member>
  28001. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.#ctor(System.Collections.IList)">
  28002. <summary>
  28003. </summary>
  28004. <param name="items"></param>
  28005. </member>
  28006. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.Dispose">
  28007. <summary>
  28008. </summary>
  28009. </member>
  28010. <member name="P:log4net.Util.LogLog.LogReceivedAdapter.Items">
  28011. <summary>
  28012. </summary>
  28013. </member>
  28014. <member name="T:log4net.Util.LogReceivedEventArgs">
  28015. <summary>
  28016. </summary>
  28017. </member>
  28018. <member name="M:log4net.Util.LogReceivedEventArgs.#ctor(log4net.Util.LogLog)">
  28019. <summary>
  28020. </summary>
  28021. <param name="loglog"></param>
  28022. </member>
  28023. <member name="P:log4net.Util.LogReceivedEventArgs.LogLog">
  28024. <summary>
  28025. </summary>
  28026. </member>
  28027. <member name="T:log4net.Util.NativeError">
  28028. <summary>
  28029. Represents a native error code and message.
  28030. </summary>
  28031. <remarks>
  28032. <para>
  28033. Represents a Win32 platform native error.
  28034. </para>
  28035. </remarks>
  28036. <author>Nicko Cadell</author>
  28037. <author>Gert Driesen</author>
  28038. </member>
  28039. <member name="M:log4net.Util.NativeError.#ctor(System.Int32,System.String)">
  28040. <summary>
  28041. Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
  28042. error number and message.
  28043. </summary>
  28044. <param name="number">The number of the native error.</param>
  28045. <param name="message">The message of the native error.</param>
  28046. <remarks>
  28047. <para>
  28048. Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
  28049. error number and message.
  28050. </para>
  28051. </remarks>
  28052. </member>
  28053. <member name="M:log4net.Util.NativeError.GetLastError">
  28054. <summary>
  28055. Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class for the last Windows error.
  28056. </summary>
  28057. <returns>
  28058. An instance of the <see cref="T:log4net.Util.NativeError"/> class for the last windows error.
  28059. </returns>
  28060. <remarks>
  28061. <para>
  28062. The message for the <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/> error number is lookup up using the
  28063. native Win32 <c>FormatMessage</c> function.
  28064. </para>
  28065. </remarks>
  28066. </member>
  28067. <member name="M:log4net.Util.NativeError.GetError(System.Int32)">
  28068. <summary>
  28069. Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class.
  28070. </summary>
  28071. <param name="number">the error number for the native error</param>
  28072. <returns>
  28073. An instance of the <see cref="T:log4net.Util.NativeError"/> class for the specified
  28074. error number.
  28075. </returns>
  28076. <remarks>
  28077. <para>
  28078. The message for the specified error number is lookup up using the
  28079. native Win32 <c>FormatMessage</c> function.
  28080. </para>
  28081. </remarks>
  28082. </member>
  28083. <member name="M:log4net.Util.NativeError.GetErrorMessage(System.Int32)">
  28084. <summary>
  28085. Retrieves the message corresponding with a Win32 message identifier.
  28086. </summary>
  28087. <param name="messageId">Message identifier for the requested message.</param>
  28088. <returns>
  28089. The message corresponding with the specified message identifier.
  28090. </returns>
  28091. <remarks>
  28092. <para>
  28093. The message will be searched for in system message-table resource(s)
  28094. using the native <c>FormatMessage</c> function.
  28095. </para>
  28096. </remarks>
  28097. </member>
  28098. <member name="M:log4net.Util.NativeError.ToString">
  28099. <summary>
  28100. Return error information string
  28101. </summary>
  28102. <returns>error information string</returns>
  28103. <remarks>
  28104. <para>
  28105. Return error information string
  28106. </para>
  28107. </remarks>
  28108. </member>
  28109. <member name="M:log4net.Util.NativeError.FormatMessage(System.Int32,System.IntPtr@,System.Int32,System.Int32,System.String@,System.Int32,System.IntPtr)">
  28110. <summary>
  28111. Formats a message string.
  28112. </summary>
  28113. <param name="dwFlags">Formatting options, and how to interpret the <paramref name="lpSource" /> parameter.</param>
  28114. <param name="lpSource">Location of the message definition.</param>
  28115. <param name="dwMessageId">Message identifier for the requested message.</param>
  28116. <param name="dwLanguageId">Language identifier for the requested message.</param>
  28117. <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>
  28118. <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>
  28119. <param name="Arguments">Pointer to an array of values that are used as insert values in the formatted message.</param>
  28120. <remarks>
  28121. <para>
  28122. The function requires a message definition as input. The message definition can come from a
  28123. buffer passed into the function. It can come from a message table resource in an
  28124. already-loaded module. Or the caller can ask the function to search the system's message
  28125. table resource(s) for the message definition. The function finds the message definition
  28126. in a message table resource based on a message identifier and a language identifier.
  28127. The function copies the formatted message text to an output buffer, processing any embedded
  28128. insert sequences if requested.
  28129. </para>
  28130. <para>
  28131. To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message.
  28132. </para>
  28133. </remarks>
  28134. <returns>
  28135. <para>
  28136. If the function succeeds, the return value is the number of TCHARs stored in the output
  28137. buffer, excluding the terminating null character.
  28138. </para>
  28139. <para>
  28140. If the function fails, the return value is zero. To get extended error information,
  28141. call <see cref="M:Marshal.GetLastWin32Error()" />.
  28142. </para>
  28143. </returns>
  28144. </member>
  28145. <member name="P:log4net.Util.NativeError.Number">
  28146. <summary>
  28147. Gets the number of the native error.
  28148. </summary>
  28149. <value>
  28150. The number of the native error.
  28151. </value>
  28152. <remarks>
  28153. <para>
  28154. Gets the number of the native error.
  28155. </para>
  28156. </remarks>
  28157. </member>
  28158. <member name="P:log4net.Util.NativeError.Message">
  28159. <summary>
  28160. Gets the message of the native error.
  28161. </summary>
  28162. <value>
  28163. The message of the native error.
  28164. </value>
  28165. <remarks>
  28166. <para>
  28167. </para>
  28168. Gets the message of the native error.
  28169. </remarks>
  28170. </member>
  28171. <member name="T:log4net.Util.NullDictionaryEnumerator">
  28172. <summary>
  28173. An always empty <see cref="T:System.Collections.IDictionaryEnumerator"/>.
  28174. </summary>
  28175. <remarks>
  28176. <para>
  28177. A singleton implementation of the <see cref="T:System.Collections.IDictionaryEnumerator"/> over a collection
  28178. that is empty and not modifiable.
  28179. </para>
  28180. </remarks>
  28181. <author>Nicko Cadell</author>
  28182. <author>Gert Driesen</author>
  28183. </member>
  28184. <member name="M:log4net.Util.NullDictionaryEnumerator.#ctor">
  28185. <summary>
  28186. Initializes a new instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> class.
  28187. </summary>
  28188. <remarks>
  28189. <para>
  28190. Uses a private access modifier to enforce the singleton pattern.
  28191. </para>
  28192. </remarks>
  28193. </member>
  28194. <member name="M:log4net.Util.NullDictionaryEnumerator.MoveNext">
  28195. <summary>
  28196. Test if the enumerator can advance, if so advance.
  28197. </summary>
  28198. <returns><c>false</c> as the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> cannot advance.</returns>
  28199. <remarks>
  28200. <para>
  28201. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28202. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullDictionaryEnumerator.MoveNext"/>
  28203. will always return <c>false</c>.
  28204. </para>
  28205. </remarks>
  28206. </member>
  28207. <member name="M:log4net.Util.NullDictionaryEnumerator.Reset">
  28208. <summary>
  28209. Resets the enumerator back to the start.
  28210. </summary>
  28211. <remarks>
  28212. <para>
  28213. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullDictionaryEnumerator.Reset"/> does nothing.
  28214. </para>
  28215. </remarks>
  28216. </member>
  28217. <member name="F:log4net.Util.NullDictionaryEnumerator.s_instance">
  28218. <summary>
  28219. The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
  28220. </summary>
  28221. </member>
  28222. <member name="P:log4net.Util.NullDictionaryEnumerator.Instance">
  28223. <summary>
  28224. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
  28225. </summary>
  28226. <returns>The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.</returns>
  28227. <remarks>
  28228. <para>
  28229. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
  28230. </para>
  28231. </remarks>
  28232. </member>
  28233. <member name="P:log4net.Util.NullDictionaryEnumerator.Current">
  28234. <summary>
  28235. Gets the current object from the enumerator.
  28236. </summary>
  28237. <remarks>
  28238. Throws an <see cref="T:System.InvalidOperationException"/> because the
  28239. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
  28240. </remarks>
  28241. <remarks>
  28242. <para>
  28243. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28244. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28245. will throw an <see cref="T:System.InvalidOperationException"/>.
  28246. </para>
  28247. </remarks>
  28248. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28249. cannot be positioned over a valid location.</exception>
  28250. </member>
  28251. <member name="P:log4net.Util.NullDictionaryEnumerator.Key">
  28252. <summary>
  28253. Gets the current key from the enumerator.
  28254. </summary>
  28255. <remarks>
  28256. Throws an exception because the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>
  28257. never has a current value.
  28258. </remarks>
  28259. <remarks>
  28260. <para>
  28261. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28262. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Key"/>
  28263. will throw an <see cref="T:System.InvalidOperationException"/>.
  28264. </para>
  28265. </remarks>
  28266. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28267. cannot be positioned over a valid location.</exception>
  28268. </member>
  28269. <member name="P:log4net.Util.NullDictionaryEnumerator.Value">
  28270. <summary>
  28271. Gets the current value from the enumerator.
  28272. </summary>
  28273. <value>The current value from the enumerator.</value>
  28274. <remarks>
  28275. Throws an <see cref="T:System.InvalidOperationException"/> because the
  28276. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
  28277. </remarks>
  28278. <remarks>
  28279. <para>
  28280. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28281. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Value"/>
  28282. will throw an <see cref="T:System.InvalidOperationException"/>.
  28283. </para>
  28284. </remarks>
  28285. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28286. cannot be positioned over a valid location.</exception>
  28287. </member>
  28288. <member name="P:log4net.Util.NullDictionaryEnumerator.Entry">
  28289. <summary>
  28290. Gets the current entry from the enumerator.
  28291. </summary>
  28292. <remarks>
  28293. Throws an <see cref="T:System.InvalidOperationException"/> because the
  28294. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current entry.
  28295. </remarks>
  28296. <remarks>
  28297. <para>
  28298. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28299. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Entry"/>
  28300. will throw an <see cref="T:System.InvalidOperationException"/>.
  28301. </para>
  28302. </remarks>
  28303. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28304. cannot be positioned over a valid location.</exception>
  28305. </member>
  28306. <member name="T:log4net.Util.NullEnumerator">
  28307. <summary>
  28308. An always empty <see cref="T:System.Collections.IEnumerator"/>.
  28309. </summary>
  28310. <remarks>
  28311. <para>
  28312. A singleton implementation of the <see cref="T:System.Collections.IEnumerator"/> over a collection
  28313. that is empty and not modifiable.
  28314. </para>
  28315. </remarks>
  28316. <author>Nicko Cadell</author>
  28317. <author>Gert Driesen</author>
  28318. </member>
  28319. <member name="M:log4net.Util.NullEnumerator.#ctor">
  28320. <summary>
  28321. Initializes a new instance of the <see cref="T:log4net.Util.NullEnumerator"/> class.
  28322. </summary>
  28323. <remarks>
  28324. <para>
  28325. Uses a private access modifier to enforce the singleton pattern.
  28326. </para>
  28327. </remarks>
  28328. </member>
  28329. <member name="M:log4net.Util.NullEnumerator.MoveNext">
  28330. <summary>
  28331. Test if the enumerator can advance, if so advance
  28332. </summary>
  28333. <returns><c>false</c> as the <see cref="T:log4net.Util.NullEnumerator"/> cannot advance.</returns>
  28334. <remarks>
  28335. <para>
  28336. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  28337. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullEnumerator.MoveNext"/>
  28338. will always return <c>false</c>.
  28339. </para>
  28340. </remarks>
  28341. </member>
  28342. <member name="M:log4net.Util.NullEnumerator.Reset">
  28343. <summary>
  28344. Resets the enumerator back to the start.
  28345. </summary>
  28346. <remarks>
  28347. <para>
  28348. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullEnumerator.Reset"/> does nothing.
  28349. </para>
  28350. </remarks>
  28351. </member>
  28352. <member name="F:log4net.Util.NullEnumerator.s_instance">
  28353. <summary>
  28354. The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
  28355. </summary>
  28356. </member>
  28357. <member name="P:log4net.Util.NullEnumerator.Instance">
  28358. <summary>
  28359. Get the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
  28360. </summary>
  28361. <returns>The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.</returns>
  28362. <remarks>
  28363. <para>
  28364. Gets the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
  28365. </para>
  28366. </remarks>
  28367. </member>
  28368. <member name="P:log4net.Util.NullEnumerator.Current">
  28369. <summary>
  28370. Gets the current object from the enumerator.
  28371. </summary>
  28372. <remarks>
  28373. Throws an <see cref="T:System.InvalidOperationException"/> because the
  28374. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
  28375. </remarks>
  28376. <remarks>
  28377. <para>
  28378. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  28379. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullEnumerator.Current"/>
  28380. will throw an <see cref="T:System.InvalidOperationException"/>.
  28381. </para>
  28382. </remarks>
  28383. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullEnumerator.Current"/>
  28384. cannot be positioned over a valid location.</exception>
  28385. </member>
  28386. <member name="T:log4net.Util.NullSecurityContext">
  28387. <summary>
  28388. A SecurityContext used when a SecurityContext is not required
  28389. </summary>
  28390. <remarks>
  28391. <para>
  28392. The <see cref="T:log4net.Util.NullSecurityContext"/> is a no-op implementation of the
  28393. <see cref="T:log4net.Core.SecurityContext"/> base class. It is used where a <see cref="T:log4net.Core.SecurityContext"/>
  28394. is required but one has not been provided.
  28395. </para>
  28396. </remarks>
  28397. <author>Nicko Cadell</author>
  28398. </member>
  28399. <member name="F:log4net.Util.NullSecurityContext.Instance">
  28400. <summary>
  28401. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  28402. </summary>
  28403. <remarks>
  28404. <para>
  28405. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  28406. </para>
  28407. </remarks>
  28408. </member>
  28409. <member name="M:log4net.Util.NullSecurityContext.#ctor">
  28410. <summary>
  28411. Private constructor
  28412. </summary>
  28413. <remarks>
  28414. <para>
  28415. Private constructor for singleton pattern.
  28416. </para>
  28417. </remarks>
  28418. </member>
  28419. <member name="M:log4net.Util.NullSecurityContext.Impersonate(System.Object)">
  28420. <summary>
  28421. Impersonate this SecurityContext
  28422. </summary>
  28423. <param name="state">State supplied by the caller</param>
  28424. <returns><c>null</c></returns>
  28425. <remarks>
  28426. <para>
  28427. No impersonation is done and <c>null</c> is always returned.
  28428. </para>
  28429. </remarks>
  28430. </member>
  28431. <member name="T:log4net.Util.OnlyOnceErrorHandler">
  28432. <summary>
  28433. Implements log4net's default error handling policy which consists
  28434. of emitting a message for the first error in an appender and
  28435. ignoring all subsequent errors.
  28436. </summary>
  28437. <remarks>
  28438. <para>
  28439. The error message is processed using the LogLog sub-system by default.
  28440. </para>
  28441. <para>
  28442. This policy aims at protecting an otherwise working application
  28443. from being flooded with error messages when logging fails.
  28444. </para>
  28445. </remarks>
  28446. <author>Nicko Cadell</author>
  28447. <author>Gert Driesen</author>
  28448. <author>Ron Grabowski</author>
  28449. </member>
  28450. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor">
  28451. <summary>
  28452. Default Constructor
  28453. </summary>
  28454. <remarks>
  28455. <para>
  28456. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class.
  28457. </para>
  28458. </remarks>
  28459. </member>
  28460. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor(System.String)">
  28461. <summary>
  28462. Constructor
  28463. </summary>
  28464. <param name="prefix">The prefix to use for each message.</param>
  28465. <remarks>
  28466. <para>
  28467. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class
  28468. with the specified prefix.
  28469. </para>
  28470. </remarks>
  28471. </member>
  28472. <member name="M:log4net.Util.OnlyOnceErrorHandler.Reset">
  28473. <summary>
  28474. Reset the error handler back to its initial disabled state.
  28475. </summary>
  28476. </member>
  28477. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  28478. <summary>
  28479. Log an Error
  28480. </summary>
  28481. <param name="message">The error message.</param>
  28482. <param name="e">The exception.</param>
  28483. <param name="errorCode">The internal error code.</param>
  28484. <remarks>
  28485. <para>
  28486. Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
  28487. </para>
  28488. </remarks>
  28489. </member>
  28490. <member name="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)">
  28491. <summary>
  28492. Log the very first error
  28493. </summary>
  28494. <param name="message">The error message.</param>
  28495. <param name="e">The exception.</param>
  28496. <param name="errorCode">The internal error code.</param>
  28497. <remarks>
  28498. <para>
  28499. Sends the error information to <see cref="T:log4net.Util.LogLog"/>'s Error method.
  28500. </para>
  28501. </remarks>
  28502. </member>
  28503. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception)">
  28504. <summary>
  28505. Log an Error
  28506. </summary>
  28507. <param name="message">The error message.</param>
  28508. <param name="e">The exception.</param>
  28509. <remarks>
  28510. <para>
  28511. Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
  28512. </para>
  28513. </remarks>
  28514. </member>
  28515. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String)">
  28516. <summary>
  28517. Log an error
  28518. </summary>
  28519. <param name="message">The error message.</param>
  28520. <remarks>
  28521. <para>
  28522. Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
  28523. </para>
  28524. </remarks>
  28525. </member>
  28526. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_enabledDateUtc">
  28527. <summary>
  28528. The UTC date the error was recorded.
  28529. </summary>
  28530. </member>
  28531. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_firstTime">
  28532. <summary>
  28533. Flag to indicate if it is the first error
  28534. </summary>
  28535. </member>
  28536. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_message">
  28537. <summary>
  28538. The message recorded during the first error.
  28539. </summary>
  28540. </member>
  28541. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_exception">
  28542. <summary>
  28543. The exception recorded during the first error.
  28544. </summary>
  28545. </member>
  28546. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_errorCode">
  28547. <summary>
  28548. The error code recorded during the first error.
  28549. </summary>
  28550. </member>
  28551. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_prefix">
  28552. <summary>
  28553. String to prefix each message with
  28554. </summary>
  28555. </member>
  28556. <member name="F:log4net.Util.OnlyOnceErrorHandler.declaringType">
  28557. <summary>
  28558. The fully qualified type of the OnlyOnceErrorHandler class.
  28559. </summary>
  28560. <remarks>
  28561. Used by the internal logger to record the Type of the
  28562. log message.
  28563. </remarks>
  28564. </member>
  28565. <member name="P:log4net.Util.OnlyOnceErrorHandler.IsEnabled">
  28566. <summary>
  28567. Is error logging enabled
  28568. </summary>
  28569. <remarks>
  28570. <para>
  28571. Is error logging enabled. Logging is only enabled for the
  28572. first error delivered to the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/>.
  28573. </para>
  28574. </remarks>
  28575. </member>
  28576. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDate">
  28577. <summary>
  28578. The date the first error that trigged this error handler occurred, or <see cref="F:System.DateTime.MinValue"/> if it has not been triggered.
  28579. </summary>
  28580. </member>
  28581. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDateUtc">
  28582. <summary>
  28583. The UTC date the first error that trigged this error handler occured, or <see cref="F:System.DateTime.MinValue"/> if it has not been triggered.
  28584. </summary>
  28585. </member>
  28586. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorMessage">
  28587. <summary>
  28588. The message from the first error that trigged this error handler.
  28589. </summary>
  28590. </member>
  28591. <member name="P:log4net.Util.OnlyOnceErrorHandler.Exception">
  28592. <summary>
  28593. The exception from the first error that trigged this error handler.
  28594. </summary>
  28595. <remarks>
  28596. May be <see langword="null" />.
  28597. </remarks>
  28598. </member>
  28599. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorCode">
  28600. <summary>
  28601. The error code from the first error that trigged this error handler.
  28602. </summary>
  28603. <remarks>
  28604. Defaults to <see cref="F:log4net.Core.ErrorCode.GenericFailure"/>
  28605. </remarks>
  28606. </member>
  28607. <member name="T:log4net.Util.OptionConverter">
  28608. <summary>
  28609. A convenience class to convert property values to specific types.
  28610. </summary>
  28611. <remarks>
  28612. <para>
  28613. Utility functions for converting types and parsing values.
  28614. </para>
  28615. </remarks>
  28616. <author>Nicko Cadell</author>
  28617. <author>Gert Driesen</author>
  28618. </member>
  28619. <member name="M:log4net.Util.OptionConverter.#ctor">
  28620. <summary>
  28621. Initializes a new instance of the <see cref="T:log4net.Util.OptionConverter"/> class.
  28622. </summary>
  28623. <remarks>
  28624. <para>
  28625. Uses a private access modifier to prevent instantiation of this class.
  28626. </para>
  28627. </remarks>
  28628. </member>
  28629. <member name="M:log4net.Util.OptionConverter.ToBoolean(System.String,System.Boolean)">
  28630. <summary>
  28631. Converts a string to a <see cref="T:System.Boolean"/> value.
  28632. </summary>
  28633. <param name="argValue">String to convert.</param>
  28634. <param name="defaultValue">The default value.</param>
  28635. <returns>The <see cref="T:System.Boolean"/> value of <paramref name="argValue"/>.</returns>
  28636. <remarks>
  28637. <para>
  28638. If <paramref name="argValue"/> is "true", then <c>true</c> is returned.
  28639. If <paramref name="argValue"/> is "false", then <c>false</c> is returned.
  28640. Otherwise, <paramref name="defaultValue"/> is returned.
  28641. </para>
  28642. </remarks>
  28643. </member>
  28644. <member name="M:log4net.Util.OptionConverter.ToFileSize(System.String,System.Int64)">
  28645. <summary>
  28646. Parses a file size into a number.
  28647. </summary>
  28648. <param name="argValue">String to parse.</param>
  28649. <param name="defaultValue">The default value.</param>
  28650. <returns>The <see cref="T:System.Int64"/> value of <paramref name="argValue"/>.</returns>
  28651. <remarks>
  28652. <para>
  28653. Parses a file size of the form: number[KB|MB|GB] into a
  28654. long value. It is scaled with the appropriate multiplier.
  28655. </para>
  28656. <para>
  28657. <paramref name="defaultValue"/> is returned when <paramref name="argValue"/>
  28658. cannot be converted to a <see cref="T:System.Int64"/> value.
  28659. </para>
  28660. </remarks>
  28661. </member>
  28662. <member name="M:log4net.Util.OptionConverter.ConvertStringTo(System.Type,System.String)">
  28663. <summary>
  28664. Converts a string to an object.
  28665. </summary>
  28666. <param name="target">The target type to convert to.</param>
  28667. <param name="txt">The string to convert to an object.</param>
  28668. <returns>
  28669. The object converted from a string or <c>null</c> when the
  28670. conversion failed.
  28671. </returns>
  28672. <remarks>
  28673. <para>
  28674. Converts a string to an object. Uses the converter registry to try
  28675. to convert the string value into the specified target type.
  28676. </para>
  28677. </remarks>
  28678. </member>
  28679. <member name="M:log4net.Util.OptionConverter.CanConvertTypeTo(System.Type,System.Type)">
  28680. <summary>
  28681. Checks if there is an appropriate type conversion from the source type to the target type.
  28682. </summary>
  28683. <param name="sourceType">The type to convert from.</param>
  28684. <param name="targetType">The type to convert to.</param>
  28685. <returns><c>true</c> if there is a conversion from the source type to the target type.</returns>
  28686. <remarks>
  28687. Checks if there is an appropriate type conversion from the source type to the target type.
  28688. <para>
  28689. </para>
  28690. </remarks>
  28691. </member>
  28692. <member name="M:log4net.Util.OptionConverter.ConvertTypeTo(System.Object,System.Type)">
  28693. <summary>
  28694. Converts an object to the target type.
  28695. </summary>
  28696. <param name="sourceInstance">The object to convert to the target type.</param>
  28697. <param name="targetType">The type to convert to.</param>
  28698. <returns>The converted object.</returns>
  28699. <remarks>
  28700. <para>
  28701. Converts an object to the target type.
  28702. </para>
  28703. </remarks>
  28704. </member>
  28705. <member name="M:log4net.Util.OptionConverter.InstantiateByClassName(System.String,System.Type,System.Object)">
  28706. <summary>
  28707. Instantiates an object given a class name.
  28708. </summary>
  28709. <param name="className">The fully qualified class name of the object to instantiate.</param>
  28710. <param name="superClass">The class to which the new object should belong.</param>
  28711. <param name="defaultValue">The object to return in case of non-fulfillment.</param>
  28712. <returns>
  28713. An instance of the <paramref name="className"/> or <paramref name="defaultValue"/>
  28714. if the object could not be instantiated.
  28715. </returns>
  28716. <remarks>
  28717. <para>
  28718. Checks that the <paramref name="className"/> is a subclass of
  28719. <paramref name="superClass"/>. If that test fails or the object could
  28720. not be instantiated, then <paramref name="defaultValue"/> is returned.
  28721. </para>
  28722. </remarks>
  28723. </member>
  28724. <member name="M:log4net.Util.OptionConverter.SubstituteVariables(System.String,System.Collections.IDictionary)">
  28725. <summary>
  28726. Performs variable substitution in string <paramref name="value"/> from the
  28727. values of keys found in <paramref name="props"/>.
  28728. </summary>
  28729. <param name="value">The string on which variable substitution is performed.</param>
  28730. <param name="props">The dictionary to use to lookup variables.</param>
  28731. <returns>The result of the substitutions.</returns>
  28732. <remarks>
  28733. <para>
  28734. The variable substitution delimiters are <b>${</b> and <b>}</b>.
  28735. </para>
  28736. <para>
  28737. For example, if props contains <c>key=value</c>, then the call
  28738. </para>
  28739. <para>
  28740. <code lang="C#">
  28741. string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
  28742. </code>
  28743. </para>
  28744. <para>
  28745. will set the variable <c>s</c> to "Value of key is value.".
  28746. </para>
  28747. <para>
  28748. If no value could be found for the specified key, then substitution
  28749. defaults to an empty string.
  28750. </para>
  28751. <para>
  28752. For example, if system properties contains no value for the key
  28753. "nonExistentKey", then the call
  28754. </para>
  28755. <para>
  28756. <code lang="C#">
  28757. string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
  28758. </code>
  28759. </para>
  28760. <para>
  28761. will set <s>s</s> to "Value of nonExistentKey is []".
  28762. </para>
  28763. <para>
  28764. An Exception is thrown if <paramref name="value"/> contains a start
  28765. delimiter "${" which is not balanced by a stop delimiter "}".
  28766. </para>
  28767. </remarks>
  28768. </member>
  28769. <member name="M:log4net.Util.OptionConverter.ParseEnum(System.Type,System.String,System.Boolean)">
  28770. <summary>
  28771. Converts the string representation of the name or numeric value of one or
  28772. more enumerated constants to an equivalent enumerated object.
  28773. </summary>
  28774. <param name="enumType">The type to convert to.</param>
  28775. <param name="value">The enum string value.</param>
  28776. <param name="ignoreCase">If <c>true</c>, ignore case; otherwise, regard case.</param>
  28777. <returns>An object of type <paramref name="enumType" /> whose value is represented by <paramref name="value" />.</returns>
  28778. </member>
  28779. <member name="F:log4net.Util.OptionConverter.declaringType">
  28780. <summary>
  28781. The fully qualified type of the OptionConverter class.
  28782. </summary>
  28783. <remarks>
  28784. Used by the internal logger to record the Type of the
  28785. log message.
  28786. </remarks>
  28787. </member>
  28788. <member name="T:log4net.Util.PatternParser">
  28789. <summary>
  28790. Most of the work of the <see cref="T:log4net.Layout.PatternLayout"/> class
  28791. is delegated to the PatternParser class.
  28792. </summary>
  28793. <remarks>
  28794. <para>
  28795. The <c>PatternParser</c> processes a pattern string and
  28796. returns a chain of <see cref="T:log4net.Util.PatternConverter"/> objects.
  28797. </para>
  28798. </remarks>
  28799. <author>Nicko Cadell</author>
  28800. <author>Gert Driesen</author>
  28801. </member>
  28802. <member name="M:log4net.Util.PatternParser.#ctor(System.String)">
  28803. <summary>
  28804. Constructor
  28805. </summary>
  28806. <param name="pattern">The pattern to parse.</param>
  28807. <remarks>
  28808. <para>
  28809. Initializes a new instance of the <see cref="T:log4net.Util.PatternParser"/> class
  28810. with the specified pattern string.
  28811. </para>
  28812. </remarks>
  28813. </member>
  28814. <member name="M:log4net.Util.PatternParser.Parse">
  28815. <summary>
  28816. Parses the pattern into a chain of pattern converters.
  28817. </summary>
  28818. <returns>The head of a chain of pattern converters.</returns>
  28819. <remarks>
  28820. <para>
  28821. Parses the pattern into a chain of pattern converters.
  28822. </para>
  28823. </remarks>
  28824. </member>
  28825. <member name="M:log4net.Util.PatternParser.BuildCache">
  28826. <summary>
  28827. Build the unified cache of converters from the static and instance maps
  28828. </summary>
  28829. <returns>the list of all the converter names</returns>
  28830. <remarks>
  28831. <para>
  28832. Build the unified cache of converters from the static and instance maps
  28833. </para>
  28834. </remarks>
  28835. </member>
  28836. <member name="M:log4net.Util.PatternParser.ParseInternal(System.String,System.String[])">
  28837. <summary>
  28838. Internal method to parse the specified pattern to find specified matches
  28839. </summary>
  28840. <param name="pattern">the pattern to parse</param>
  28841. <param name="matches">the converter names to match in the pattern</param>
  28842. <remarks>
  28843. <para>
  28844. The matches param must be sorted such that longer strings come before shorter ones.
  28845. </para>
  28846. </remarks>
  28847. </member>
  28848. <member name="M:log4net.Util.PatternParser.ProcessLiteral(System.String)">
  28849. <summary>
  28850. Process a parsed literal
  28851. </summary>
  28852. <param name="text">the literal text</param>
  28853. </member>
  28854. <member name="M:log4net.Util.PatternParser.ProcessConverter(System.String,System.String,log4net.Util.FormattingInfo)">
  28855. <summary>
  28856. Process a parsed converter pattern
  28857. </summary>
  28858. <param name="converterName">the name of the converter</param>
  28859. <param name="option">the optional option for the converter</param>
  28860. <param name="formattingInfo">the formatting info for the converter</param>
  28861. </member>
  28862. <member name="M:log4net.Util.PatternParser.AddConverter(log4net.Util.PatternConverter)">
  28863. <summary>
  28864. Resets the internal state of the parser and adds the specified pattern converter
  28865. to the chain.
  28866. </summary>
  28867. <param name="pc">The pattern converter to add.</param>
  28868. </member>
  28869. <member name="F:log4net.Util.PatternParser.m_head">
  28870. <summary>
  28871. The first pattern converter in the chain
  28872. </summary>
  28873. </member>
  28874. <member name="F:log4net.Util.PatternParser.m_tail">
  28875. <summary>
  28876. the last pattern converter in the chain
  28877. </summary>
  28878. </member>
  28879. <member name="F:log4net.Util.PatternParser.m_pattern">
  28880. <summary>
  28881. The pattern
  28882. </summary>
  28883. </member>
  28884. <member name="F:log4net.Util.PatternParser.m_patternConverters">
  28885. <summary>
  28886. Internal map of converter identifiers to converter types
  28887. </summary>
  28888. <remarks>
  28889. <para>
  28890. This map overrides the static s_globalRulesRegistry map.
  28891. </para>
  28892. </remarks>
  28893. </member>
  28894. <member name="F:log4net.Util.PatternParser.declaringType">
  28895. <summary>
  28896. The fully qualified type of the PatternParser class.
  28897. </summary>
  28898. <remarks>
  28899. Used by the internal logger to record the Type of the
  28900. log message.
  28901. </remarks>
  28902. </member>
  28903. <member name="P:log4net.Util.PatternParser.PatternConverters">
  28904. <summary>
  28905. Get the converter registry used by this parser
  28906. </summary>
  28907. <value>
  28908. The converter registry used by this parser
  28909. </value>
  28910. <remarks>
  28911. <para>
  28912. Get the converter registry used by this parser
  28913. </para>
  28914. </remarks>
  28915. </member>
  28916. <member name="T:log4net.Util.PatternParser.StringLengthComparer">
  28917. <summary>
  28918. Sort strings by length
  28919. </summary>
  28920. <remarks>
  28921. <para>
  28922. <see cref="T:System.Collections.IComparer"/> that orders strings by string length.
  28923. The longest strings are placed first
  28924. </para>
  28925. </remarks>
  28926. </member>
  28927. <member name="T:log4net.Util.PatternString">
  28928. <summary>
  28929. This class implements a patterned string.
  28930. </summary>
  28931. <remarks>
  28932. <para>
  28933. This string has embedded patterns that are resolved and expanded
  28934. when the string is formatted.
  28935. </para>
  28936. <para>
  28937. This class functions similarly to the <see cref="T:log4net.Layout.PatternLayout"/>
  28938. in that it accepts a pattern and renders it to a string. Unlike the
  28939. <see cref="T:log4net.Layout.PatternLayout"/> however the <c>PatternString</c>
  28940. does not render the properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but
  28941. of the process in general.
  28942. </para>
  28943. <para>
  28944. The recognized conversion pattern names are:
  28945. </para>
  28946. <list type="table">
  28947. <listheader>
  28948. <term>Conversion Pattern Name</term>
  28949. <description>Effect</description>
  28950. </listheader>
  28951. <item>
  28952. <term>appdomain</term>
  28953. <description>
  28954. <para>
  28955. Used to output the friendly name of the current AppDomain.
  28956. </para>
  28957. </description>
  28958. </item>
  28959. <item>
  28960. <term>appsetting</term>
  28961. <description>
  28962. <para>
  28963. Used to output the value of a specific appSetting key in the application
  28964. configuration file.
  28965. </para>
  28966. </description>
  28967. </item>
  28968. <item>
  28969. <term>date</term>
  28970. <description>
  28971. <para>
  28972. Used to output the current date and time in the local time zone.
  28973. To output the date in universal time use the <c>%utcdate</c> pattern.
  28974. The date conversion
  28975. specifier may be followed by a <i>date format specifier</i> enclosed
  28976. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  28977. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  28978. given then ISO8601 format is
  28979. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  28980. </para>
  28981. <para>
  28982. The date format specifier admits the same syntax as the
  28983. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  28984. </para>
  28985. <para>
  28986. For better results it is recommended to use the log4net date
  28987. formatters. These can be specified using one of the strings
  28988. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  28989. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  28990. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  28991. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  28992. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  28993. </para>
  28994. <para>
  28995. These dedicated date formatters perform significantly
  28996. better than <see cref="M:DateTime.ToString(string)"/>.
  28997. </para>
  28998. </description>
  28999. </item>
  29000. <item>
  29001. <term>env</term>
  29002. <description>
  29003. <para>
  29004. Used to output the a specific environment variable. The key to
  29005. lookup must be specified within braces and directly following the
  29006. pattern specifier, e.g. <b>%env{COMPUTERNAME}</b> would include the value
  29007. of the <c>COMPUTERNAME</c> environment variable.
  29008. </para>
  29009. <para>
  29010. The <c>env</c> pattern is not supported on the .NET Compact Framework.
  29011. </para>
  29012. </description>
  29013. </item>
  29014. <item>
  29015. <term>identity</term>
  29016. <description>
  29017. <para>
  29018. Used to output the user name for the currently active user
  29019. (Principal.Identity.Name).
  29020. </para>
  29021. </description>
  29022. </item>
  29023. <item>
  29024. <term>newline</term>
  29025. <description>
  29026. <para>
  29027. Outputs the platform dependent line separator character or
  29028. characters.
  29029. </para>
  29030. <para>
  29031. This conversion pattern name offers the same performance as using
  29032. non-portable line separator strings such as "\n", or "\r\n".
  29033. Thus, it is the preferred way of specifying a line separator.
  29034. </para>
  29035. </description>
  29036. </item>
  29037. <item>
  29038. <term>processid</term>
  29039. <description>
  29040. <para>
  29041. Used to output the system process ID for the current process.
  29042. </para>
  29043. </description>
  29044. </item>
  29045. <item>
  29046. <term>property</term>
  29047. <description>
  29048. <para>
  29049. Used to output a specific context property. The key to
  29050. lookup must be specified within braces and directly following the
  29051. pattern specifier, e.g. <b>%property{user}</b> would include the value
  29052. from the property that is keyed by the string 'user'. Each property value
  29053. that is to be included in the log must be specified separately.
  29054. Properties are stored in logging contexts. By default
  29055. the <c>log4net:HostName</c> property is set to the name of machine on
  29056. which the event was originally logged.
  29057. </para>
  29058. <para>
  29059. If no key is specified, e.g. <b>%property</b> then all the keys and their
  29060. values are printed in a comma separated list.
  29061. </para>
  29062. <para>
  29063. The properties of an event are combined from a number of different
  29064. contexts. These are listed below in the order in which they are searched.
  29065. </para>
  29066. <list type="definition">
  29067. <item>
  29068. <term>the thread properties</term>
  29069. <description>
  29070. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  29071. thread. These properties are shared by all events logged on this thread.
  29072. </description>
  29073. </item>
  29074. <item>
  29075. <term>the global properties</term>
  29076. <description>
  29077. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  29078. properties are shared by all the threads in the AppDomain.
  29079. </description>
  29080. </item>
  29081. </list>
  29082. </description>
  29083. </item>
  29084. <item>
  29085. <term>random</term>
  29086. <description>
  29087. <para>
  29088. Used to output a random string of characters. The string is made up of
  29089. uppercase letters and numbers. By default the string is 4 characters long.
  29090. The length of the string can be specified within braces directly following the
  29091. pattern specifier, e.g. <b>%random{8}</b> would output an 8 character string.
  29092. </para>
  29093. </description>
  29094. </item>
  29095. <item>
  29096. <term>username</term>
  29097. <description>
  29098. <para>
  29099. Used to output the WindowsIdentity for the currently
  29100. active user.
  29101. </para>
  29102. </description>
  29103. </item>
  29104. <item>
  29105. <term>utcdate</term>
  29106. <description>
  29107. <para>
  29108. Used to output the date of the logging event in universal time.
  29109. The date conversion
  29110. specifier may be followed by a <i>date format specifier</i> enclosed
  29111. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  29112. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  29113. given then ISO8601 format is
  29114. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  29115. </para>
  29116. <para>
  29117. The date format specifier admits the same syntax as the
  29118. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  29119. </para>
  29120. <para>
  29121. For better results it is recommended to use the log4net date
  29122. formatters. These can be specified using one of the strings
  29123. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  29124. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  29125. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  29126. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  29127. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  29128. </para>
  29129. <para>
  29130. These dedicated date formatters perform significantly
  29131. better than <see cref="M:DateTime.ToString(string)"/>.
  29132. </para>
  29133. </description>
  29134. </item>
  29135. <item>
  29136. <term>%</term>
  29137. <description>
  29138. <para>
  29139. The sequence %% outputs a single percent sign.
  29140. </para>
  29141. </description>
  29142. </item>
  29143. </list>
  29144. <para>
  29145. Additional pattern converters may be registered with a specific <see cref="T:log4net.Util.PatternString"/>
  29146. instance using <see cref="M:AddConverter(ConverterInfo)"/> or
  29147. <see cref="M:AddConverter(string, Type)"/>.
  29148. </para>
  29149. <para>
  29150. See the <see cref="T:log4net.Layout.PatternLayout"/> for details on the
  29151. <i>format modifiers</i> supported by the patterns.
  29152. </para>
  29153. </remarks>
  29154. <author>Nicko Cadell</author>
  29155. </member>
  29156. <member name="F:log4net.Util.PatternString.s_globalRulesRegistry">
  29157. <summary>
  29158. Internal map of converter identifiers to converter types.
  29159. </summary>
  29160. </member>
  29161. <member name="F:log4net.Util.PatternString.m_pattern">
  29162. <summary>
  29163. the pattern
  29164. </summary>
  29165. </member>
  29166. <member name="F:log4net.Util.PatternString.m_head">
  29167. <summary>
  29168. the head of the pattern converter chain
  29169. </summary>
  29170. </member>
  29171. <member name="F:log4net.Util.PatternString.m_instanceRulesRegistry">
  29172. <summary>
  29173. patterns defined on this PatternString only
  29174. </summary>
  29175. </member>
  29176. <member name="M:log4net.Util.PatternString.#cctor">
  29177. <summary>
  29178. Initialize the global registry
  29179. </summary>
  29180. </member>
  29181. <member name="M:log4net.Util.PatternString.#ctor">
  29182. <summary>
  29183. Default constructor
  29184. </summary>
  29185. <remarks>
  29186. <para>
  29187. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/>
  29188. </para>
  29189. </remarks>
  29190. </member>
  29191. <member name="M:log4net.Util.PatternString.#ctor(System.String)">
  29192. <summary>
  29193. Constructs a PatternString
  29194. </summary>
  29195. <param name="pattern">The pattern to use with this PatternString</param>
  29196. <remarks>
  29197. <para>
  29198. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/> with the pattern specified.
  29199. </para>
  29200. </remarks>
  29201. </member>
  29202. <member name="M:log4net.Util.PatternString.ActivateOptions">
  29203. <summary>
  29204. Initialize object options
  29205. </summary>
  29206. <remarks>
  29207. <para>
  29208. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  29209. activation scheme. The <see cref="M:log4net.Util.PatternString.ActivateOptions"/> method must
  29210. be called on this object after the configuration properties have
  29211. been set. Until <see cref="M:log4net.Util.PatternString.ActivateOptions"/> is called this
  29212. object is in an undefined state and must not be used.
  29213. </para>
  29214. <para>
  29215. If any of the configuration properties are modified then
  29216. <see cref="M:log4net.Util.PatternString.ActivateOptions"/> must be called again.
  29217. </para>
  29218. </remarks>
  29219. </member>
  29220. <member name="M:log4net.Util.PatternString.CreatePatternParser(System.String)">
  29221. <summary>
  29222. Create the <see cref="T:log4net.Util.PatternParser"/> used to parse the pattern
  29223. </summary>
  29224. <param name="pattern">the pattern to parse</param>
  29225. <returns>The <see cref="T:log4net.Util.PatternParser"/></returns>
  29226. <remarks>
  29227. <para>
  29228. Returns PatternParser used to parse the conversion string. Subclasses
  29229. may override this to return a subclass of PatternParser which recognize
  29230. custom conversion pattern name.
  29231. </para>
  29232. </remarks>
  29233. </member>
  29234. <member name="M:log4net.Util.PatternString.Format(System.IO.TextWriter)">
  29235. <summary>
  29236. Produces a formatted string as specified by the conversion pattern.
  29237. </summary>
  29238. <param name="writer">The TextWriter to write the formatted event to</param>
  29239. <remarks>
  29240. <para>
  29241. Format the pattern to the <paramref name="writer"/>.
  29242. </para>
  29243. </remarks>
  29244. </member>
  29245. <member name="M:log4net.Util.PatternString.Format">
  29246. <summary>
  29247. Format the pattern as a string
  29248. </summary>
  29249. <returns>the pattern formatted as a string</returns>
  29250. <remarks>
  29251. <para>
  29252. Format the pattern to a string.
  29253. </para>
  29254. </remarks>
  29255. </member>
  29256. <member name="M:log4net.Util.PatternString.AddConverter(log4net.Util.ConverterInfo)">
  29257. <summary>
  29258. Add a converter to this PatternString
  29259. </summary>
  29260. <param name="converterInfo">the converter info</param>
  29261. <remarks>
  29262. <para>
  29263. This version of the method is used by the configurator.
  29264. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  29265. </para>
  29266. </remarks>
  29267. </member>
  29268. <member name="M:log4net.Util.PatternString.AddConverter(System.String,System.Type)">
  29269. <summary>
  29270. Add a converter to this PatternString
  29271. </summary>
  29272. <param name="name">the name of the conversion pattern for this converter</param>
  29273. <param name="type">the type of the converter</param>
  29274. <remarks>
  29275. <para>
  29276. Add a converter to this PatternString
  29277. </para>
  29278. </remarks>
  29279. </member>
  29280. <member name="P:log4net.Util.PatternString.ConversionPattern">
  29281. <summary>
  29282. Gets or sets the pattern formatting string
  29283. </summary>
  29284. <value>
  29285. The pattern formatting string
  29286. </value>
  29287. <remarks>
  29288. <para>
  29289. The <b>ConversionPattern</b> option. This is the string which
  29290. controls formatting and consists of a mix of literal content and
  29291. conversion specifiers.
  29292. </para>
  29293. </remarks>
  29294. </member>
  29295. <member name="T:log4net.Util.PropertiesDictionary">
  29296. <summary>
  29297. String keyed object map.
  29298. </summary>
  29299. <remarks>
  29300. <para>
  29301. While this collection is serializable only member
  29302. objects that are serializable will
  29303. be serialized along with this collection.
  29304. </para>
  29305. </remarks>
  29306. <author>Nicko Cadell</author>
  29307. <author>Gert Driesen</author>
  29308. </member>
  29309. <member name="T:log4net.Util.ReadOnlyPropertiesDictionary">
  29310. <summary>
  29311. String keyed object map that is read only.
  29312. </summary>
  29313. <remarks>
  29314. <para>
  29315. This collection is readonly and cannot be modified.
  29316. </para>
  29317. <para>
  29318. While this collection is serializable only member
  29319. objects that are serializable will
  29320. be serialized along with this collection.
  29321. </para>
  29322. </remarks>
  29323. <author>Nicko Cadell</author>
  29324. <author>Gert Driesen</author>
  29325. </member>
  29326. <member name="F:log4net.Util.ReadOnlyPropertiesDictionary.m_hashtable">
  29327. <summary>
  29328. The Hashtable used to store the properties data
  29329. </summary>
  29330. </member>
  29331. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor">
  29332. <summary>
  29333. Constructor
  29334. </summary>
  29335. <remarks>
  29336. <para>
  29337. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class.
  29338. </para>
  29339. </remarks>
  29340. </member>
  29341. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  29342. <summary>
  29343. Copy Constructor
  29344. </summary>
  29345. <param name="propertiesDictionary">properties to copy</param>
  29346. <remarks>
  29347. <para>
  29348. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class.
  29349. </para>
  29350. </remarks>
  29351. </member>
  29352. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29353. <summary>
  29354. Deserialization constructor
  29355. </summary>
  29356. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
  29357. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  29358. <remarks>
  29359. <para>
  29360. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class
  29361. with serialized data.
  29362. </para>
  29363. </remarks>
  29364. </member>
  29365. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetKeys">
  29366. <summary>
  29367. Gets the key names.
  29368. </summary>
  29369. <returns>An array of all the keys.</returns>
  29370. <remarks>
  29371. <para>
  29372. Gets the key names.
  29373. </para>
  29374. </remarks>
  29375. </member>
  29376. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Contains(System.String)">
  29377. <summary>
  29378. Test if the dictionary contains a specified key
  29379. </summary>
  29380. <param name="key">the key to look for</param>
  29381. <returns>true if the dictionary contains the specified key</returns>
  29382. <remarks>
  29383. <para>
  29384. Test if the dictionary contains a specified key
  29385. </para>
  29386. </remarks>
  29387. </member>
  29388. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29389. <summary>
  29390. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
  29391. </summary>
  29392. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
  29393. <param name="context">The destination for this serialization.</param>
  29394. <remarks>
  29395. <para>
  29396. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
  29397. </para>
  29398. </remarks>
  29399. </member>
  29400. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  29401. <summary>
  29402. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  29403. </summary>
  29404. </member>
  29405. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  29406. <summary>
  29407. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  29408. </summary>
  29409. <param name="key"></param>
  29410. </member>
  29411. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  29412. <summary>
  29413. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  29414. </summary>
  29415. <param name="key"></param>
  29416. <returns></returns>
  29417. </member>
  29418. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Clear">
  29419. <summary>
  29420. Remove all properties from the properties collection
  29421. </summary>
  29422. </member>
  29423. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  29424. <summary>
  29425. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  29426. </summary>
  29427. <param name="key"></param>
  29428. <param name="value"></param>
  29429. </member>
  29430. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  29431. <summary>
  29432. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  29433. </summary>
  29434. <param name="array"></param>
  29435. <param name="index"></param>
  29436. </member>
  29437. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  29438. <summary>
  29439. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  29440. </summary>
  29441. </member>
  29442. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Item(System.String)">
  29443. <summary>
  29444. Gets or sets the value of the property with the specified key.
  29445. </summary>
  29446. <value>
  29447. The value of the property with the specified key.
  29448. </value>
  29449. <param name="key">The key of the property to get or set.</param>
  29450. <remarks>
  29451. <para>
  29452. The property value will only be serialized if it is serializable.
  29453. If it cannot be serialized it will be silently ignored if
  29454. a serialization operation is performed.
  29455. </para>
  29456. </remarks>
  29457. </member>
  29458. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.InnerHashtable">
  29459. <summary>
  29460. The hashtable used to store the properties
  29461. </summary>
  29462. <value>
  29463. The internal collection used to store the properties
  29464. </value>
  29465. <remarks>
  29466. <para>
  29467. The hashtable used to store the properties
  29468. </para>
  29469. </remarks>
  29470. </member>
  29471. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  29472. <summary>
  29473. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  29474. </summary>
  29475. </member>
  29476. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  29477. <summary>
  29478. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  29479. </summary>
  29480. </member>
  29481. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Values">
  29482. <summary>
  29483. See <see cref="P:System.Collections.IDictionary.Values"/>
  29484. </summary>
  29485. </member>
  29486. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Keys">
  29487. <summary>
  29488. See <see cref="P:System.Collections.IDictionary.Keys"/>
  29489. </summary>
  29490. </member>
  29491. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  29492. <summary>
  29493. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  29494. </summary>
  29495. </member>
  29496. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  29497. <summary>
  29498. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  29499. </summary>
  29500. </member>
  29501. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Count">
  29502. <summary>
  29503. The number of properties in this collection
  29504. </summary>
  29505. </member>
  29506. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#SyncRoot">
  29507. <summary>
  29508. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  29509. </summary>
  29510. </member>
  29511. <member name="M:log4net.Util.PropertiesDictionary.#ctor">
  29512. <summary>
  29513. Constructor
  29514. </summary>
  29515. <remarks>
  29516. <para>
  29517. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class.
  29518. </para>
  29519. </remarks>
  29520. </member>
  29521. <member name="M:log4net.Util.PropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  29522. <summary>
  29523. Constructor
  29524. </summary>
  29525. <param name="propertiesDictionary">properties to copy</param>
  29526. <remarks>
  29527. <para>
  29528. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class.
  29529. </para>
  29530. </remarks>
  29531. </member>
  29532. <member name="M:log4net.Util.PropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29533. <summary>
  29534. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class
  29535. with serialized data.
  29536. </summary>
  29537. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
  29538. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  29539. <remarks>
  29540. <para>
  29541. Because this class is sealed the serialization constructor is private.
  29542. </para>
  29543. </remarks>
  29544. </member>
  29545. <member name="M:log4net.Util.PropertiesDictionary.Remove(System.String)">
  29546. <summary>
  29547. Remove the entry with the specified key from this dictionary
  29548. </summary>
  29549. <param name="key">the key for the entry to remove</param>
  29550. <remarks>
  29551. <para>
  29552. Remove the entry with the specified key from this dictionary
  29553. </para>
  29554. </remarks>
  29555. </member>
  29556. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  29557. <summary>
  29558. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  29559. </summary>
  29560. <returns>an enumerator</returns>
  29561. <remarks>
  29562. <para>
  29563. Returns a <see cref="T:System.Collections.IDictionaryEnumerator"/> over the contest of this collection.
  29564. </para>
  29565. </remarks>
  29566. </member>
  29567. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  29568. <summary>
  29569. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  29570. </summary>
  29571. <param name="key">the key to remove</param>
  29572. <remarks>
  29573. <para>
  29574. Remove the entry with the specified key from this dictionary
  29575. </para>
  29576. </remarks>
  29577. </member>
  29578. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  29579. <summary>
  29580. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  29581. </summary>
  29582. <param name="key">the key to lookup in the collection</param>
  29583. <returns><c>true</c> if the collection contains the specified key</returns>
  29584. <remarks>
  29585. <para>
  29586. Test if this collection contains a specified key.
  29587. </para>
  29588. </remarks>
  29589. </member>
  29590. <member name="M:log4net.Util.PropertiesDictionary.Clear">
  29591. <summary>
  29592. Remove all properties from the properties collection
  29593. </summary>
  29594. <remarks>
  29595. <para>
  29596. Remove all properties from the properties collection
  29597. </para>
  29598. </remarks>
  29599. </member>
  29600. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  29601. <summary>
  29602. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  29603. </summary>
  29604. <param name="key">the key</param>
  29605. <param name="value">the value to store for the key</param>
  29606. <remarks>
  29607. <para>
  29608. Store a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  29609. </para>
  29610. </remarks>
  29611. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  29612. </member>
  29613. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  29614. <summary>
  29615. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  29616. </summary>
  29617. <param name="array"></param>
  29618. <param name="index"></param>
  29619. </member>
  29620. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  29621. <summary>
  29622. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  29623. </summary>
  29624. </member>
  29625. <member name="P:log4net.Util.PropertiesDictionary.Item(System.String)">
  29626. <summary>
  29627. Gets or sets the value of the property with the specified key.
  29628. </summary>
  29629. <value>
  29630. The value of the property with the specified key.
  29631. </value>
  29632. <param name="key">The key of the property to get or set.</param>
  29633. <remarks>
  29634. <para>
  29635. The property value will only be serialized if it is serializable.
  29636. If it cannot be serialized it will be silently ignored if
  29637. a serialization operation is performed.
  29638. </para>
  29639. </remarks>
  29640. </member>
  29641. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  29642. <summary>
  29643. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  29644. </summary>
  29645. <value>
  29646. <c>false</c>
  29647. </value>
  29648. <remarks>
  29649. <para>
  29650. This collection is modifiable. This property always
  29651. returns <c>false</c>.
  29652. </para>
  29653. </remarks>
  29654. </member>
  29655. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  29656. <summary>
  29657. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  29658. </summary>
  29659. <value>
  29660. The value for the key specified.
  29661. </value>
  29662. <remarks>
  29663. <para>
  29664. Get or set a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  29665. </para>
  29666. </remarks>
  29667. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  29668. </member>
  29669. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Values">
  29670. <summary>
  29671. See <see cref="P:System.Collections.IDictionary.Values"/>
  29672. </summary>
  29673. </member>
  29674. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Keys">
  29675. <summary>
  29676. See <see cref="P:System.Collections.IDictionary.Keys"/>
  29677. </summary>
  29678. </member>
  29679. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  29680. <summary>
  29681. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  29682. </summary>
  29683. </member>
  29684. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  29685. <summary>
  29686. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  29687. </summary>
  29688. </member>
  29689. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#SyncRoot">
  29690. <summary>
  29691. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  29692. </summary>
  29693. </member>
  29694. <member name="T:log4net.Util.PropertyEntry">
  29695. <summary>
  29696. A class to hold the key and data for a property set in the config file
  29697. </summary>
  29698. <remarks>
  29699. <para>
  29700. A class to hold the key and data for a property set in the config file
  29701. </para>
  29702. </remarks>
  29703. </member>
  29704. <member name="M:log4net.Util.PropertyEntry.ToString">
  29705. <summary>
  29706. Override <c>Object.ToString</c> to return sensible debug info
  29707. </summary>
  29708. <returns>string info about this object</returns>
  29709. </member>
  29710. <member name="P:log4net.Util.PropertyEntry.Key">
  29711. <summary>
  29712. Property Key
  29713. </summary>
  29714. <value>
  29715. Property Key
  29716. </value>
  29717. <remarks>
  29718. <para>
  29719. Property Key.
  29720. </para>
  29721. </remarks>
  29722. </member>
  29723. <member name="P:log4net.Util.PropertyEntry.Value">
  29724. <summary>
  29725. Property Value
  29726. </summary>
  29727. <value>
  29728. Property Value
  29729. </value>
  29730. <remarks>
  29731. <para>
  29732. Property Value.
  29733. </para>
  29734. </remarks>
  29735. </member>
  29736. <member name="T:log4net.Util.ProtectCloseTextWriter">
  29737. <summary>
  29738. A <see cref="T:System.IO.TextWriter"/> that ignores the <see cref="M:log4net.Util.ProtectCloseTextWriter.Close"/> message
  29739. </summary>
  29740. <remarks>
  29741. <para>
  29742. This writer is used in special cases where it is necessary
  29743. to protect a writer from being closed by a client.
  29744. </para>
  29745. </remarks>
  29746. <author>Nicko Cadell</author>
  29747. </member>
  29748. <member name="M:log4net.Util.ProtectCloseTextWriter.#ctor(System.IO.TextWriter)">
  29749. <summary>
  29750. Constructor
  29751. </summary>
  29752. <param name="writer">the writer to actually write to</param>
  29753. <remarks>
  29754. <para>
  29755. Create a new ProtectCloseTextWriter using a writer
  29756. </para>
  29757. </remarks>
  29758. </member>
  29759. <member name="M:log4net.Util.ProtectCloseTextWriter.Attach(System.IO.TextWriter)">
  29760. <summary>
  29761. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  29762. </summary>
  29763. <param name="writer">the writer to attach to</param>
  29764. <remarks>
  29765. <para>
  29766. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  29767. </para>
  29768. </remarks>
  29769. </member>
  29770. <member name="M:log4net.Util.ProtectCloseTextWriter.Close">
  29771. <summary>
  29772. Does not close the underlying output writer.
  29773. </summary>
  29774. <remarks>
  29775. <para>
  29776. Does not close the underlying output writer.
  29777. This method does nothing.
  29778. </para>
  29779. </remarks>
  29780. </member>
  29781. <member name="T:log4net.Util.ReaderWriterLock">
  29782. <summary>
  29783. Defines a lock that supports single writers and multiple readers
  29784. </summary>
  29785. <remarks>
  29786. <para>
  29787. <c>ReaderWriterLock</c> is used to synchronize access to a resource.
  29788. At any given time, it allows either concurrent read access for
  29789. multiple threads, or write access for a single thread. In a
  29790. situation where a resource is changed infrequently, a
  29791. <c>ReaderWriterLock</c> provides better throughput than a simple
  29792. one-at-a-time lock, such as <see cref="T:System.Threading.Monitor"/>.
  29793. </para>
  29794. <para>
  29795. If a platform does not support a <c>System.Threading.ReaderWriterLock</c>
  29796. implementation then all readers and writers are serialized. Therefore
  29797. the caller must not rely on multiple simultaneous readers.
  29798. </para>
  29799. </remarks>
  29800. <author>Nicko Cadell</author>
  29801. </member>
  29802. <member name="M:log4net.Util.ReaderWriterLock.#ctor">
  29803. <summary>
  29804. Constructor
  29805. </summary>
  29806. <remarks>
  29807. <para>
  29808. Initializes a new instance of the <see cref="T:log4net.Util.ReaderWriterLock"/> class.
  29809. </para>
  29810. </remarks>
  29811. </member>
  29812. <member name="M:log4net.Util.ReaderWriterLock.AcquireReaderLock">
  29813. <summary>
  29814. Acquires a reader lock
  29815. </summary>
  29816. <remarks>
  29817. <para>
  29818. <see cref="M:log4net.Util.ReaderWriterLock.AcquireReaderLock"/> blocks if a different thread has the writer
  29819. lock, or if at least one thread is waiting for the writer lock.
  29820. </para>
  29821. </remarks>
  29822. </member>
  29823. <member name="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock">
  29824. <summary>
  29825. Decrements the lock count
  29826. </summary>
  29827. <remarks>
  29828. <para>
  29829. <see cref="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock"/> decrements the lock count. When the count
  29830. reaches zero, the lock is released.
  29831. </para>
  29832. </remarks>
  29833. </member>
  29834. <member name="M:log4net.Util.ReaderWriterLock.AcquireWriterLock">
  29835. <summary>
  29836. Acquires the writer lock
  29837. </summary>
  29838. <remarks>
  29839. <para>
  29840. This method blocks if another thread has a reader lock or writer lock.
  29841. </para>
  29842. </remarks>
  29843. </member>
  29844. <member name="M:log4net.Util.ReaderWriterLock.ReleaseWriterLock">
  29845. <summary>
  29846. Decrements the lock count on the writer lock
  29847. </summary>
  29848. <remarks>
  29849. <para>
  29850. ReleaseWriterLock decrements the writer lock count.
  29851. When the count reaches zero, the writer lock is released.
  29852. </para>
  29853. </remarks>
  29854. </member>
  29855. <member name="T:log4net.Util.ReusableStringWriter">
  29856. <summary>
  29857. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused
  29858. </summary>
  29859. <remarks>
  29860. <para>
  29861. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused.
  29862. This uses a single buffer for string operations.
  29863. </para>
  29864. </remarks>
  29865. <author>Nicko Cadell</author>
  29866. </member>
  29867. <member name="M:log4net.Util.ReusableStringWriter.#ctor(System.IFormatProvider)">
  29868. <summary>
  29869. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  29870. </summary>
  29871. <param name="formatProvider">the format provider to use</param>
  29872. <remarks>
  29873. <para>
  29874. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  29875. </para>
  29876. </remarks>
  29877. </member>
  29878. <member name="M:log4net.Util.ReusableStringWriter.Dispose(System.Boolean)">
  29879. <summary>
  29880. Override Dispose to prevent closing of writer
  29881. </summary>
  29882. <param name="disposing">flag</param>
  29883. <remarks>
  29884. <para>
  29885. Override Dispose to prevent closing of writer
  29886. </para>
  29887. </remarks>
  29888. </member>
  29889. <member name="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)">
  29890. <summary>
  29891. Reset this string writer so that it can be reused.
  29892. </summary>
  29893. <param name="maxCapacity">the maximum buffer capacity before it is trimmed</param>
  29894. <param name="defaultSize">the default size to make the buffer</param>
  29895. <remarks>
  29896. <para>
  29897. Reset this string writer so that it can be reused.
  29898. The internal buffers are cleared and reset.
  29899. </para>
  29900. </remarks>
  29901. </member>
  29902. <member name="T:log4net.Util.SystemInfo">
  29903. <summary>
  29904. Utility class for system specific information.
  29905. </summary>
  29906. <remarks>
  29907. <para>
  29908. Utility class of static methods for system specific information.
  29909. </para>
  29910. </remarks>
  29911. <author>Nicko Cadell</author>
  29912. <author>Gert Driesen</author>
  29913. <author>Alexey Solofnenko</author>
  29914. </member>
  29915. <member name="M:log4net.Util.SystemInfo.#ctor">
  29916. <summary>
  29917. Private constructor to prevent instances.
  29918. </summary>
  29919. <remarks>
  29920. <para>
  29921. Only static methods are exposed from this type.
  29922. </para>
  29923. </remarks>
  29924. </member>
  29925. <member name="M:log4net.Util.SystemInfo.#cctor">
  29926. <summary>
  29927. Initialize default values for private static fields.
  29928. </summary>
  29929. <remarks>
  29930. <para>
  29931. Only static methods are exposed from this type.
  29932. </para>
  29933. </remarks>
  29934. </member>
  29935. <member name="M:log4net.Util.SystemInfo.AssemblyLocationInfo(System.Reflection.Assembly)">
  29936. <summary>
  29937. Gets the assembly location path for the specified assembly.
  29938. </summary>
  29939. <param name="myAssembly">The assembly to get the location for.</param>
  29940. <returns>The location of the assembly.</returns>
  29941. <remarks>
  29942. <para>
  29943. This method does not guarantee to return the correct path
  29944. to the assembly. If only tries to give an indication as to
  29945. where the assembly was loaded from.
  29946. </para>
  29947. </remarks>
  29948. </member>
  29949. <member name="M:log4net.Util.SystemInfo.AssemblyQualifiedName(System.Type)">
  29950. <summary>
  29951. Gets the fully qualified name of the <see cref="T:System.Type"/>, including
  29952. the name of the assembly from which the <see cref="T:System.Type"/> was
  29953. loaded.
  29954. </summary>
  29955. <param name="type">The <see cref="T:System.Type"/> to get the fully qualified name for.</param>
  29956. <returns>The fully qualified name for the <see cref="T:System.Type"/>.</returns>
  29957. <remarks>
  29958. <para>
  29959. This is equivalent to the <c>Type.AssemblyQualifiedName</c> property,
  29960. but this method works on the .NET Compact Framework 1.0 as well as
  29961. the full .NET runtime.
  29962. </para>
  29963. </remarks>
  29964. </member>
  29965. <member name="M:log4net.Util.SystemInfo.AssemblyShortName(System.Reflection.Assembly)">
  29966. <summary>
  29967. Gets the short name of the <see cref="T:System.Reflection.Assembly"/>.
  29968. </summary>
  29969. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the name for.</param>
  29970. <returns>The short name of the <see cref="T:System.Reflection.Assembly"/>.</returns>
  29971. <remarks>
  29972. <para>
  29973. The short name of the assembly is the <see cref="P:System.Reflection.Assembly.FullName"/>
  29974. without the version, culture, or public key. i.e. it is just the
  29975. assembly's file name without the extension.
  29976. </para>
  29977. <para>
  29978. Use this rather than <c>Assembly.GetName().Name</c> because that
  29979. is not available on the Compact Framework.
  29980. </para>
  29981. <para>
  29982. Because of a FileIOPermission security demand we cannot do
  29983. the obvious Assembly.GetName().Name. We are allowed to get
  29984. the <see cref="P:System.Reflection.Assembly.FullName"/> of the assembly so we
  29985. start from there and strip out just the assembly name.
  29986. </para>
  29987. </remarks>
  29988. </member>
  29989. <member name="M:log4net.Util.SystemInfo.AssemblyFileName(System.Reflection.Assembly)">
  29990. <summary>
  29991. Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension.
  29992. </summary>
  29993. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the file name for.</param>
  29994. <returns>The file name of the assembly.</returns>
  29995. <remarks>
  29996. <para>
  29997. Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension.
  29998. </para>
  29999. </remarks>
  30000. </member>
  30001. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Type,System.String,System.Boolean,System.Boolean)">
  30002. <summary>
  30003. Loads the type specified in the type string.
  30004. </summary>
  30005. <param name="relativeType">A sibling type to use to load the type.</param>
  30006. <param name="typeName">The name of the type to load.</param>
  30007. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  30008. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  30009. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  30010. <remarks>
  30011. <para>
  30012. If the type name is fully qualified, i.e. if contains an assembly name in
  30013. the type name, the type will be loaded from the system using
  30014. <see cref="M:Type.GetType(string,bool)"/>.
  30015. </para>
  30016. <para>
  30017. If the type name is not fully qualified, it will be loaded from the assembly
  30018. containing the specified relative type. If the type is not found in the assembly
  30019. then all the loaded assemblies will be searched for the type.
  30020. </para>
  30021. </remarks>
  30022. </member>
  30023. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.String,System.Boolean,System.Boolean)">
  30024. <summary>
  30025. Loads the type specified in the type string.
  30026. </summary>
  30027. <param name="typeName">The name of the type to load.</param>
  30028. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  30029. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  30030. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  30031. <remarks>
  30032. <para>
  30033. If the type name is fully qualified, i.e. if contains an assembly name in
  30034. the type name, the type will be loaded from the system using
  30035. <see cref="M:Type.GetType(string,bool)"/>.
  30036. </para>
  30037. <para>
  30038. If the type name is not fully qualified it will be loaded from the
  30039. assembly that is directly calling this method. If the type is not found
  30040. in the assembly then all the loaded assemblies will be searched for the type.
  30041. </para>
  30042. </remarks>
  30043. </member>
  30044. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Reflection.Assembly,System.String,System.Boolean,System.Boolean)">
  30045. <summary>
  30046. Loads the type specified in the type string.
  30047. </summary>
  30048. <param name="relativeAssembly">An assembly to load the type from.</param>
  30049. <param name="typeName">The name of the type to load.</param>
  30050. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  30051. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  30052. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  30053. <remarks>
  30054. <para>
  30055. If the type name is fully qualified, i.e. if contains an assembly name in
  30056. the type name, the type will be loaded from the system using
  30057. <see cref="M:Type.GetType(string,bool)"/>.
  30058. </para>
  30059. <para>
  30060. If the type name is not fully qualified it will be loaded from the specified
  30061. assembly. If the type is not found in the assembly then all the loaded assemblies
  30062. will be searched for the type.
  30063. </para>
  30064. </remarks>
  30065. </member>
  30066. <member name="M:log4net.Util.SystemInfo.NewGuid">
  30067. <summary>
  30068. Generate a new guid
  30069. </summary>
  30070. <returns>A new Guid</returns>
  30071. <remarks>
  30072. <para>
  30073. Generate a new guid
  30074. </para>
  30075. </remarks>
  30076. </member>
  30077. <member name="M:log4net.Util.SystemInfo.CreateArgumentOutOfRangeException(System.String,System.Object,System.String)">
  30078. <summary>
  30079. Create an <see cref="T:System.ArgumentOutOfRangeException"/>
  30080. </summary>
  30081. <param name="parameterName">The name of the parameter that caused the exception</param>
  30082. <param name="actualValue">The value of the argument that causes this exception</param>
  30083. <param name="message">The message that describes the error</param>
  30084. <returns>the ArgumentOutOfRangeException object</returns>
  30085. <remarks>
  30086. <para>
  30087. Create a new instance of the <see cref="T:System.ArgumentOutOfRangeException"/> class
  30088. with a specified error message, the parameter name, and the value
  30089. of the argument.
  30090. </para>
  30091. <para>
  30092. The Compact Framework does not support the 3 parameter constructor for the
  30093. <see cref="T:System.ArgumentOutOfRangeException"/> type. This method provides an
  30094. implementation that works for all platforms.
  30095. </para>
  30096. </remarks>
  30097. </member>
  30098. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int32@)">
  30099. <summary>
  30100. Parse a string into an <see cref="T:System.Int32"/> value
  30101. </summary>
  30102. <param name="s">the string to parse</param>
  30103. <param name="val">out param where the parsed value is placed</param>
  30104. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  30105. <remarks>
  30106. <para>
  30107. Attempts to parse the string into an integer. If the string cannot
  30108. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  30109. </para>
  30110. </remarks>
  30111. </member>
  30112. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int64@)">
  30113. <summary>
  30114. Parse a string into an <see cref="T:System.Int64"/> value
  30115. </summary>
  30116. <param name="s">the string to parse</param>
  30117. <param name="val">out param where the parsed value is placed</param>
  30118. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  30119. <remarks>
  30120. <para>
  30121. Attempts to parse the string into an integer. If the string cannot
  30122. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  30123. </para>
  30124. </remarks>
  30125. </member>
  30126. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int16@)">
  30127. <summary>
  30128. Parse a string into an <see cref="T:System.Int16"/> value
  30129. </summary>
  30130. <param name="s">the string to parse</param>
  30131. <param name="val">out param where the parsed value is placed</param>
  30132. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  30133. <remarks>
  30134. <para>
  30135. Attempts to parse the string into an integer. If the string cannot
  30136. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  30137. </para>
  30138. </remarks>
  30139. </member>
  30140. <member name="M:log4net.Util.SystemInfo.GetAppSetting(System.String)">
  30141. <summary>
  30142. Lookup an application setting
  30143. </summary>
  30144. <param name="key">the application settings key to lookup</param>
  30145. <returns>the value for the key, or <c>null</c></returns>
  30146. <remarks>
  30147. <para>
  30148. Configuration APIs are not supported under the Compact Framework
  30149. </para>
  30150. </remarks>
  30151. </member>
  30152. <member name="M:log4net.Util.SystemInfo.ConvertToFullPath(System.String)">
  30153. <summary>
  30154. Convert a path into a fully qualified local file path.
  30155. </summary>
  30156. <param name="path">The path to convert.</param>
  30157. <returns>The fully qualified path.</returns>
  30158. <remarks>
  30159. <para>
  30160. Converts the path specified to a fully
  30161. qualified path. If the path is relative it is
  30162. taken as relative from the application base
  30163. directory.
  30164. </para>
  30165. <para>
  30166. The path specified must be a local file path, a URI is not supported.
  30167. </para>
  30168. </remarks>
  30169. </member>
  30170. <member name="M:log4net.Util.SystemInfo.CreateCaseInsensitiveHashtable">
  30171. <summary>
  30172. Creates a new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity.
  30173. </summary>
  30174. <returns>A new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity</returns>
  30175. <remarks>
  30176. <para>
  30177. The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer.
  30178. </para>
  30179. </remarks>
  30180. </member>
  30181. <member name="M:log4net.Util.SystemInfo.EqualsIgnoringCase(System.String,System.String)">
  30182. <summary>
  30183. Tests two strings for equality, the ignoring case.
  30184. </summary>
  30185. <remarks>
  30186. If the platform permits, culture information is ignored completely (ordinal comparison).
  30187. The aim of this method is to provide a fast comparison that deals with <c>null</c> and ignores different casing.
  30188. It is not supposed to deal with various, culture-specific habits.
  30189. Use it to compare against pure ASCII constants, like keywords etc.
  30190. </remarks>
  30191. <param name="a">The one string.</param>
  30192. <param name="b">The other string.</param>
  30193. <returns><c>true</c> if the strings are equal, <c>false</c> otherwise.</returns>
  30194. </member>
  30195. <member name="F:log4net.Util.SystemInfo.EmptyTypes">
  30196. <summary>
  30197. Gets an empty array of types.
  30198. </summary>
  30199. <remarks>
  30200. <para>
  30201. The <c>Type.EmptyTypes</c> field is not available on
  30202. the .NET Compact Framework 1.0.
  30203. </para>
  30204. </remarks>
  30205. </member>
  30206. <member name="F:log4net.Util.SystemInfo.declaringType">
  30207. <summary>
  30208. The fully qualified type of the SystemInfo class.
  30209. </summary>
  30210. <remarks>
  30211. Used by the internal logger to record the Type of the
  30212. log message.
  30213. </remarks>
  30214. </member>
  30215. <member name="F:log4net.Util.SystemInfo.s_hostName">
  30216. <summary>
  30217. Cache the host name for the current machine
  30218. </summary>
  30219. </member>
  30220. <member name="F:log4net.Util.SystemInfo.s_appFriendlyName">
  30221. <summary>
  30222. Cache the application friendly name
  30223. </summary>
  30224. </member>
  30225. <member name="F:log4net.Util.SystemInfo.s_nullText">
  30226. <summary>
  30227. Text to output when a <c>null</c> is encountered.
  30228. </summary>
  30229. </member>
  30230. <member name="F:log4net.Util.SystemInfo.s_notAvailableText">
  30231. <summary>
  30232. Text to output when an unsupported feature is requested.
  30233. </summary>
  30234. </member>
  30235. <member name="F:log4net.Util.SystemInfo.s_processStartTimeUtc">
  30236. <summary>
  30237. Start time for the current process.
  30238. </summary>
  30239. </member>
  30240. <member name="P:log4net.Util.SystemInfo.NewLine">
  30241. <summary>
  30242. Gets the system dependent line terminator.
  30243. </summary>
  30244. <value>
  30245. The system dependent line terminator.
  30246. </value>
  30247. <remarks>
  30248. <para>
  30249. Gets the system dependent line terminator.
  30250. </para>
  30251. </remarks>
  30252. </member>
  30253. <member name="P:log4net.Util.SystemInfo.ApplicationBaseDirectory">
  30254. <summary>
  30255. Gets the base directory for this <see cref="T:System.AppDomain"/>.
  30256. </summary>
  30257. <value>The base directory path for the current <see cref="T:System.AppDomain"/>.</value>
  30258. <remarks>
  30259. <para>
  30260. Gets the base directory for this <see cref="T:System.AppDomain"/>.
  30261. </para>
  30262. <para>
  30263. The value returned may be either a local file path or a URI.
  30264. </para>
  30265. </remarks>
  30266. </member>
  30267. <member name="P:log4net.Util.SystemInfo.ConfigurationFileLocation">
  30268. <summary>
  30269. Gets the path to the configuration file for the current <see cref="T:System.AppDomain"/>.
  30270. </summary>
  30271. <value>The path to the configuration file for the current <see cref="T:System.AppDomain"/>.</value>
  30272. <remarks>
  30273. <para>
  30274. The .NET Compact Framework 1.0 does not have a concept of a configuration
  30275. file. For this runtime, we use the entry assembly location as the root for
  30276. the configuration file name.
  30277. </para>
  30278. <para>
  30279. The value returned may be either a local file path or a URI.
  30280. </para>
  30281. </remarks>
  30282. </member>
  30283. <member name="P:log4net.Util.SystemInfo.EntryAssemblyLocation">
  30284. <summary>
  30285. Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
  30286. </summary>
  30287. <value>The path to the entry assembly.</value>
  30288. <remarks>
  30289. <para>
  30290. Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
  30291. </para>
  30292. </remarks>
  30293. </member>
  30294. <member name="P:log4net.Util.SystemInfo.CurrentThreadId">
  30295. <summary>
  30296. Gets the ID of the current thread.
  30297. </summary>
  30298. <value>The ID of the current thread.</value>
  30299. <remarks>
  30300. <para>
  30301. On the .NET framework, the <c>AppDomain.GetCurrentThreadId</c> method
  30302. is used to obtain the thread ID for the current thread. This is the
  30303. operating system ID for the thread.
  30304. </para>
  30305. <para>
  30306. On the .NET Compact Framework 1.0 it is not possible to get the
  30307. operating system thread ID for the current thread. The native method
  30308. <c>GetCurrentThreadId</c> is implemented inline in a header file
  30309. and cannot be called.
  30310. </para>
  30311. <para>
  30312. On the .NET Framework 2.0 the <c>Thread.ManagedThreadId</c> is used as this
  30313. gives a stable id unrelated to the operating system thread ID which may
  30314. change if the runtime is using fibers.
  30315. </para>
  30316. </remarks>
  30317. </member>
  30318. <member name="P:log4net.Util.SystemInfo.HostName">
  30319. <summary>
  30320. Get the host name or machine name for the current machine
  30321. </summary>
  30322. <value>
  30323. The hostname or machine name
  30324. </value>
  30325. <remarks>
  30326. <para>
  30327. Get the host name or machine name for the current machine
  30328. </para>
  30329. <para>
  30330. The host name (<see cref="M:System.Net.Dns.GetHostName"/>) or
  30331. the machine name (<c>Environment.MachineName</c>) for
  30332. the current machine, or if neither of these are available
  30333. then <c>NOT AVAILABLE</c> is returned.
  30334. </para>
  30335. </remarks>
  30336. </member>
  30337. <member name="P:log4net.Util.SystemInfo.ApplicationFriendlyName">
  30338. <summary>
  30339. Get this application's friendly name
  30340. </summary>
  30341. <value>
  30342. The friendly name of this application as a string
  30343. </value>
  30344. <remarks>
  30345. <para>
  30346. If available the name of the application is retrieved from
  30347. the <c>AppDomain</c> using <c>AppDomain.CurrentDomain.FriendlyName</c>.
  30348. </para>
  30349. <para>
  30350. Otherwise the file name of the entry assembly is used.
  30351. </para>
  30352. </remarks>
  30353. </member>
  30354. <member name="P:log4net.Util.SystemInfo.ProcessStartTime">
  30355. <summary>
  30356. Get the start time for the current process.
  30357. </summary>
  30358. <remarks>
  30359. <para>
  30360. This is the time at which the log4net library was loaded into the
  30361. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  30362. this is not the start time for the current process.
  30363. </para>
  30364. <para>
  30365. The log4net library should be loaded by an application early during its
  30366. startup, therefore this start time should be a good approximation for
  30367. the actual start time.
  30368. </para>
  30369. <para>
  30370. Note that AppDomains may be loaded and unloaded within the
  30371. same process without the process terminating, however this start time
  30372. will be set per AppDomain.
  30373. </para>
  30374. </remarks>
  30375. </member>
  30376. <member name="P:log4net.Util.SystemInfo.ProcessStartTimeUtc">
  30377. <summary>
  30378. Get the UTC start time for the current process.
  30379. </summary>
  30380. <remarks>
  30381. <para>
  30382. This is the UTC time at which the log4net library was loaded into the
  30383. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  30384. this is not the start time for the current process.
  30385. </para>
  30386. <para>
  30387. The log4net library should be loaded by an application early during its
  30388. startup, therefore this start time should be a good approximation for
  30389. the actual start time.
  30390. </para>
  30391. <para>
  30392. Note that AppDomains may be loaded and unloaded within the
  30393. same process without the process terminating, however this start time
  30394. will be set per AppDomain.
  30395. </para>
  30396. </remarks>
  30397. </member>
  30398. <member name="P:log4net.Util.SystemInfo.NullText">
  30399. <summary>
  30400. Text to output when a <c>null</c> is encountered.
  30401. </summary>
  30402. <remarks>
  30403. <para>
  30404. Use this value to indicate a <c>null</c> has been encountered while
  30405. outputting a string representation of an item.
  30406. </para>
  30407. <para>
  30408. The default value is <c>(null)</c>. This value can be overridden by specifying
  30409. a value for the <c>log4net.NullText</c> appSetting in the application's
  30410. .config file.
  30411. </para>
  30412. </remarks>
  30413. </member>
  30414. <member name="P:log4net.Util.SystemInfo.NotAvailableText">
  30415. <summary>
  30416. Text to output when an unsupported feature is requested.
  30417. </summary>
  30418. <remarks>
  30419. <para>
  30420. Use this value when an unsupported feature is requested.
  30421. </para>
  30422. <para>
  30423. The default value is <c>NOT AVAILABLE</c>. This value can be overridden by specifying
  30424. a value for the <c>log4net.NotAvailableText</c> appSetting in the application's
  30425. .config file.
  30426. </para>
  30427. </remarks>
  30428. </member>
  30429. <member name="T:log4net.Util.SystemStringFormat">
  30430. <summary>
  30431. Utility class that represents a format string.
  30432. </summary>
  30433. <remarks>
  30434. <para>
  30435. Utility class that represents a format string.
  30436. </para>
  30437. </remarks>
  30438. <author>Nicko Cadell</author>
  30439. </member>
  30440. <member name="M:log4net.Util.SystemStringFormat.#ctor(System.IFormatProvider,System.String,System.Object[])">
  30441. <summary>
  30442. Initialise the <see cref="T:log4net.Util.SystemStringFormat"/>
  30443. </summary>
  30444. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  30445. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  30446. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  30447. </member>
  30448. <member name="M:log4net.Util.SystemStringFormat.ToString">
  30449. <summary>
  30450. Format the string and arguments
  30451. </summary>
  30452. <returns>the formatted string</returns>
  30453. </member>
  30454. <member name="M:log4net.Util.SystemStringFormat.StringFormat(System.IFormatProvider,System.String,System.Object[])">
  30455. <summary>
  30456. Replaces the format item in a specified <see cref="T:System.String"/> with the text equivalent
  30457. of the value of a corresponding <see cref="T:System.Object"/> instance in a specified array.
  30458. A specified parameter supplies culture-specific formatting information.
  30459. </summary>
  30460. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  30461. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  30462. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  30463. <returns>
  30464. A copy of format in which the format items have been replaced by the <see cref="T:System.String"/>
  30465. equivalent of the corresponding instances of <see cref="T:System.Object"/> in args.
  30466. </returns>
  30467. <remarks>
  30468. <para>
  30469. This method does not throw exceptions. If an exception thrown while formatting the result the
  30470. exception and arguments are returned in the result string.
  30471. </para>
  30472. </remarks>
  30473. </member>
  30474. <member name="M:log4net.Util.SystemStringFormat.StringFormatError(System.Exception,System.String,System.Object[])">
  30475. <summary>
  30476. Process an error during StringFormat
  30477. </summary>
  30478. </member>
  30479. <member name="M:log4net.Util.SystemStringFormat.RenderArray(System.Array,System.Text.StringBuilder)">
  30480. <summary>
  30481. Dump the contents of an array into a string builder
  30482. </summary>
  30483. </member>
  30484. <member name="M:log4net.Util.SystemStringFormat.RenderObject(System.Object,System.Text.StringBuilder)">
  30485. <summary>
  30486. Dump an object to a string
  30487. </summary>
  30488. </member>
  30489. <member name="F:log4net.Util.SystemStringFormat.declaringType">
  30490. <summary>
  30491. The fully qualified type of the SystemStringFormat class.
  30492. </summary>
  30493. <remarks>
  30494. Used by the internal logger to record the Type of the
  30495. log message.
  30496. </remarks>
  30497. </member>
  30498. <member name="T:log4net.Util.ThreadContextProperties">
  30499. <summary>
  30500. Implementation of Properties collection for the <see cref="T:log4net.ThreadContext"/>
  30501. </summary>
  30502. <remarks>
  30503. <para>
  30504. Class implements a collection of properties that is specific to each thread.
  30505. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  30506. </para>
  30507. </remarks>
  30508. <author>Nicko Cadell</author>
  30509. </member>
  30510. <member name="F:log4net.Util.ThreadContextProperties._dictionary">
  30511. <summary>
  30512. Each thread will automatically have its instance.
  30513. </summary>
  30514. </member>
  30515. <member name="M:log4net.Util.ThreadContextProperties.#ctor">
  30516. <summary>
  30517. Internal constructor
  30518. </summary>
  30519. <remarks>
  30520. <para>
  30521. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextProperties"/> class.
  30522. </para>
  30523. </remarks>
  30524. </member>
  30525. <member name="M:log4net.Util.ThreadContextProperties.Remove(System.String)">
  30526. <summary>
  30527. Remove a property
  30528. </summary>
  30529. <param name="key">the key for the entry to remove</param>
  30530. <remarks>
  30531. <para>
  30532. Remove a property
  30533. </para>
  30534. </remarks>
  30535. </member>
  30536. <member name="M:log4net.Util.ThreadContextProperties.GetKeys">
  30537. <summary>
  30538. Get the keys stored in the properties.
  30539. </summary>
  30540. <para>
  30541. Gets the keys stored in the properties.
  30542. </para>
  30543. <returns>a set of the defined keys</returns>
  30544. </member>
  30545. <member name="M:log4net.Util.ThreadContextProperties.Clear">
  30546. <summary>
  30547. Clear all properties
  30548. </summary>
  30549. <remarks>
  30550. <para>
  30551. Clear all properties
  30552. </para>
  30553. </remarks>
  30554. </member>
  30555. <member name="M:log4net.Util.ThreadContextProperties.GetProperties(System.Boolean)">
  30556. <summary>
  30557. Get the <c>PropertiesDictionary</c> for this thread.
  30558. </summary>
  30559. <param name="create">create the dictionary if it does not exist, otherwise return null if does not exist</param>
  30560. <returns>the properties for this thread</returns>
  30561. <remarks>
  30562. <para>
  30563. The collection returned is only to be used on the calling thread. If the
  30564. caller needs to share the collection between different threads then the
  30565. caller must clone the collection before doing so.
  30566. </para>
  30567. </remarks>
  30568. </member>
  30569. <member name="P:log4net.Util.ThreadContextProperties.Item(System.String)">
  30570. <summary>
  30571. Gets or sets the value of a property
  30572. </summary>
  30573. <value>
  30574. The value for the property with the specified key
  30575. </value>
  30576. <remarks>
  30577. <para>
  30578. Gets or sets the value of a property
  30579. </para>
  30580. </remarks>
  30581. </member>
  30582. <member name="T:log4net.Util.ThreadContextStack">
  30583. <summary>
  30584. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  30585. </summary>
  30586. <remarks>
  30587. <para>
  30588. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  30589. </para>
  30590. </remarks>
  30591. <author>Nicko Cadell</author>
  30592. </member>
  30593. <member name="F:log4net.Util.ThreadContextStack.m_stack">
  30594. <summary>
  30595. The stack store.
  30596. </summary>
  30597. </member>
  30598. <member name="M:log4net.Util.ThreadContextStack.#ctor">
  30599. <summary>
  30600. Internal constructor
  30601. </summary>
  30602. <remarks>
  30603. <para>
  30604. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack"/> class.
  30605. </para>
  30606. </remarks>
  30607. </member>
  30608. <member name="M:log4net.Util.ThreadContextStack.Clear">
  30609. <summary>
  30610. Clears all the contextual information held in this stack.
  30611. </summary>
  30612. <remarks>
  30613. <para>
  30614. Clears all the contextual information held in this stack.
  30615. Only call this if you think that this tread is being reused after
  30616. a previous call execution which may not have completed correctly.
  30617. You do not need to use this method if you always guarantee to call
  30618. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  30619. returned from <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  30620. for example by using the <c>using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  30621. syntax.
  30622. </para>
  30623. </remarks>
  30624. </member>
  30625. <member name="M:log4net.Util.ThreadContextStack.Pop">
  30626. <summary>
  30627. Removes the top context from this stack.
  30628. </summary>
  30629. <returns>The message in the context that was removed from the top of this stack.</returns>
  30630. <remarks>
  30631. <para>
  30632. Remove the top context from this stack, and return
  30633. it to the caller. If this stack is empty then an
  30634. empty string (not <see langword="null"/>) is returned.
  30635. </para>
  30636. </remarks>
  30637. </member>
  30638. <member name="M:log4net.Util.ThreadContextStack.Push(System.String)">
  30639. <summary>
  30640. Pushes a new context message into this stack.
  30641. </summary>
  30642. <param name="message">The new context message.</param>
  30643. <returns>
  30644. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  30645. </returns>
  30646. <remarks>
  30647. <para>
  30648. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  30649. is returned that can be used to clean up this stack. This
  30650. can be easily combined with the <c>using</c> keyword to scope the
  30651. context.
  30652. </para>
  30653. </remarks>
  30654. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  30655. <code lang="C#">
  30656. using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
  30657. {
  30658. log.Warn("This should have an ThreadContext Stack message");
  30659. }
  30660. </code>
  30661. </example>
  30662. </member>
  30663. <member name="M:log4net.Util.ThreadContextStack.GetFullMessage">
  30664. <summary>
  30665. Gets the current context information for this stack.
  30666. </summary>
  30667. <returns>The current context information.</returns>
  30668. </member>
  30669. <member name="M:log4net.Util.ThreadContextStack.ToString">
  30670. <summary>
  30671. Gets the current context information for this stack.
  30672. </summary>
  30673. <returns>Gets the current context information</returns>
  30674. <remarks>
  30675. <para>
  30676. Gets the current context information for this stack.
  30677. </para>
  30678. </remarks>
  30679. </member>
  30680. <member name="M:log4net.Util.ThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  30681. <summary>
  30682. Get a portable version of this object
  30683. </summary>
  30684. <returns>the portable instance of this object</returns>
  30685. <remarks>
  30686. <para>
  30687. Get a cross thread portable version of this object
  30688. </para>
  30689. </remarks>
  30690. </member>
  30691. <member name="P:log4net.Util.ThreadContextStack.Count">
  30692. <summary>
  30693. The number of messages in the stack
  30694. </summary>
  30695. <value>
  30696. The current number of messages in the stack
  30697. </value>
  30698. <remarks>
  30699. <para>
  30700. The current number of messages in the stack. That is
  30701. the number of times <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> has been called
  30702. minus the number of times <see cref="M:log4net.Util.ThreadContextStack.Pop"/> has been called.
  30703. </para>
  30704. </remarks>
  30705. </member>
  30706. <member name="P:log4net.Util.ThreadContextStack.InternalStack">
  30707. <summary>
  30708. Gets and sets the internal stack used by this <see cref="T:log4net.Util.ThreadContextStack"/>
  30709. </summary>
  30710. <value>The internal storage stack</value>
  30711. <remarks>
  30712. <para>
  30713. This property is provided only to support backward compatability
  30714. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  30715. be modified.
  30716. </para>
  30717. </remarks>
  30718. </member>
  30719. <member name="T:log4net.Util.ThreadContextStack.StackFrame">
  30720. <summary>
  30721. Inner class used to represent a single context frame in the stack.
  30722. </summary>
  30723. <remarks>
  30724. <para>
  30725. Inner class used to represent a single context frame in the stack.
  30726. </para>
  30727. </remarks>
  30728. </member>
  30729. <member name="M:log4net.Util.ThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.ThreadContextStack.StackFrame)">
  30730. <summary>
  30731. Constructor
  30732. </summary>
  30733. <param name="message">The message for this context.</param>
  30734. <param name="parent">The parent context in the chain.</param>
  30735. <remarks>
  30736. <para>
  30737. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.StackFrame"/> class
  30738. with the specified message and parent context.
  30739. </para>
  30740. </remarks>
  30741. </member>
  30742. <member name="P:log4net.Util.ThreadContextStack.StackFrame.Message">
  30743. <summary>
  30744. Get the message.
  30745. </summary>
  30746. <value>The message.</value>
  30747. <remarks>
  30748. <para>
  30749. Get the message.
  30750. </para>
  30751. </remarks>
  30752. </member>
  30753. <member name="P:log4net.Util.ThreadContextStack.StackFrame.FullMessage">
  30754. <summary>
  30755. Gets the full text of the context down to the root level.
  30756. </summary>
  30757. <value>
  30758. The full text of the context down to the root level.
  30759. </value>
  30760. <remarks>
  30761. <para>
  30762. Gets the full text of the context down to the root level.
  30763. </para>
  30764. </remarks>
  30765. </member>
  30766. <member name="T:log4net.Util.ThreadContextStack.AutoPopStackFrame">
  30767. <summary>
  30768. Struct returned from the <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> method.
  30769. </summary>
  30770. <remarks>
  30771. <para>
  30772. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  30773. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  30774. </para>
  30775. </remarks>
  30776. </member>
  30777. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameStack">
  30778. <summary>
  30779. The ThreadContextStack internal stack
  30780. </summary>
  30781. </member>
  30782. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameDepth">
  30783. <summary>
  30784. The depth to trim the stack to when this instance is disposed
  30785. </summary>
  30786. </member>
  30787. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.#ctor(System.Collections.Stack,System.Int32)">
  30788. <summary>
  30789. Constructor
  30790. </summary>
  30791. <param name="frameStack">The internal stack used by the ThreadContextStack.</param>
  30792. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  30793. <remarks>
  30794. <para>
  30795. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.AutoPopStackFrame"/> class with
  30796. the specified stack and return depth.
  30797. </para>
  30798. </remarks>
  30799. </member>
  30800. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.Dispose">
  30801. <summary>
  30802. Returns the stack to the correct depth.
  30803. </summary>
  30804. <remarks>
  30805. <para>
  30806. Returns the stack to the correct depth.
  30807. </para>
  30808. </remarks>
  30809. </member>
  30810. <member name="T:log4net.Util.ThreadContextStacks">
  30811. <summary>
  30812. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  30813. </summary>
  30814. <remarks>
  30815. <para>
  30816. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  30817. </para>
  30818. </remarks>
  30819. <author>Nicko Cadell</author>
  30820. </member>
  30821. <member name="M:log4net.Util.ThreadContextStacks.#ctor(log4net.Util.ContextPropertiesBase)">
  30822. <summary>
  30823. Internal constructor
  30824. </summary>
  30825. <remarks>
  30826. <para>
  30827. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks"/> class.
  30828. </para>
  30829. </remarks>
  30830. </member>
  30831. <member name="F:log4net.Util.ThreadContextStacks.declaringType">
  30832. <summary>
  30833. The fully qualified type of the ThreadContextStacks class.
  30834. </summary>
  30835. <remarks>
  30836. Used by the internal logger to record the Type of the
  30837. log message.
  30838. </remarks>
  30839. </member>
  30840. <member name="P:log4net.Util.ThreadContextStacks.Item(System.String)">
  30841. <summary>
  30842. Gets the named thread context stack
  30843. </summary>
  30844. <value>
  30845. The named stack
  30846. </value>
  30847. <remarks>
  30848. <para>
  30849. Gets the named thread context stack
  30850. </para>
  30851. </remarks>
  30852. </member>
  30853. <member name="T:log4net.Util.Transform">
  30854. <summary>
  30855. Utility class for transforming strings.
  30856. </summary>
  30857. <remarks>
  30858. <para>
  30859. Utility class for transforming strings.
  30860. </para>
  30861. </remarks>
  30862. <author>Nicko Cadell</author>
  30863. <author>Gert Driesen</author>
  30864. </member>
  30865. <member name="M:log4net.Util.Transform.#ctor">
  30866. <summary>
  30867. Initializes a new instance of the <see cref="T:log4net.Util.Transform"/> class.
  30868. </summary>
  30869. <remarks>
  30870. <para>
  30871. Uses a private access modifier to prevent instantiation of this class.
  30872. </para>
  30873. </remarks>
  30874. </member>
  30875. <member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String,System.String)">
  30876. <summary>
  30877. Write a string to an <see cref="T:System.Xml.XmlWriter"/>
  30878. </summary>
  30879. <param name="writer">the writer to write to</param>
  30880. <param name="textData">the string to write</param>
  30881. <param name="invalidCharReplacement">The string to replace non XML compliant chars with</param>
  30882. <remarks>
  30883. <para>
  30884. The test is escaped either using XML escape entities
  30885. or using CDATA sections.
  30886. </para>
  30887. </remarks>
  30888. </member>
  30889. <member name="M:log4net.Util.Transform.MaskXmlInvalidCharacters(System.String,System.String)">
  30890. <summary>
  30891. Replace invalid XML characters in text string
  30892. </summary>
  30893. <param name="textData">the XML text input string</param>
  30894. <param name="mask">the string to use in place of invalid characters</param>
  30895. <returns>A string that does not contain invalid XML characters.</returns>
  30896. <remarks>
  30897. <para>
  30898. Certain Unicode code points are not allowed in the XML InfoSet, for
  30899. details see: <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a>.
  30900. </para>
  30901. <para>
  30902. This method replaces any illegal characters in the input string
  30903. with the mask string specified.
  30904. </para>
  30905. </remarks>
  30906. </member>
  30907. <member name="M:log4net.Util.Transform.CountSubstrings(System.String,System.String)">
  30908. <summary>
  30909. Count the number of times that the substring occurs in the text
  30910. </summary>
  30911. <param name="text">the text to search</param>
  30912. <param name="substring">the substring to find</param>
  30913. <returns>the number of times the substring occurs in the text</returns>
  30914. <remarks>
  30915. <para>
  30916. The substring is assumed to be non repeating within itself.
  30917. </para>
  30918. </remarks>
  30919. </member>
  30920. <member name="F:log4net.Util.Transform.INVALIDCHARS">
  30921. <summary>
  30922. Characters illegal in XML 1.0
  30923. </summary>
  30924. </member>
  30925. <member name="T:log4net.Util.WindowsSecurityContext">
  30926. <summary>
  30927. Impersonate a Windows Account
  30928. </summary>
  30929. <remarks>
  30930. <para>
  30931. This <see cref="T:log4net.Core.SecurityContext"/> impersonates a Windows account.
  30932. </para>
  30933. <para>
  30934. How the impersonation is done depends on the value of <see cref="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)"/>.
  30935. This allows the context to either impersonate a set of user credentials specified
  30936. using username, domain name and password or to revert to the process credentials.
  30937. </para>
  30938. </remarks>
  30939. </member>
  30940. <member name="M:log4net.Util.WindowsSecurityContext.#ctor">
  30941. <summary>
  30942. Default constructor
  30943. </summary>
  30944. <remarks>
  30945. <para>
  30946. Default constructor
  30947. </para>
  30948. </remarks>
  30949. </member>
  30950. <member name="M:log4net.Util.WindowsSecurityContext.ActivateOptions">
  30951. <summary>
  30952. Initialize the SecurityContext based on the options set.
  30953. </summary>
  30954. <remarks>
  30955. <para>
  30956. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  30957. activation scheme. The <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> method must
  30958. be called on this object after the configuration properties have
  30959. been set. Until <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> is called this
  30960. object is in an undefined state and must not be used.
  30961. </para>
  30962. <para>
  30963. If any of the configuration properties are modified then
  30964. <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> must be called again.
  30965. </para>
  30966. <para>
  30967. The security context will try to Logon the specified user account and
  30968. capture a primary token for impersonation.
  30969. </para>
  30970. </remarks>
  30971. <exception cref="T:System.ArgumentNullException">The required <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>,
  30972. <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> or <see cref="P:log4net.Util.WindowsSecurityContext.Password"/> properties were not specified.</exception>
  30973. </member>
  30974. <member name="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)">
  30975. <summary>
  30976. Impersonate the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
  30977. </summary>
  30978. <param name="state">caller provided state</param>
  30979. <returns>
  30980. An <see cref="T:System.IDisposable"/> instance that will revoke the impersonation of this SecurityContext
  30981. </returns>
  30982. <remarks>
  30983. <para>
  30984. Depending on the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property either
  30985. impersonate a user using credentials supplied or revert
  30986. to the process credentials.
  30987. </para>
  30988. </remarks>
  30989. </member>
  30990. <member name="M:log4net.Util.WindowsSecurityContext.LogonUser(System.String,System.String,System.String)">
  30991. <summary>
  30992. Create a <see cref="T:System.Security.Principal.WindowsIdentity"/> given the userName, domainName and password.
  30993. </summary>
  30994. <param name="userName">the user name</param>
  30995. <param name="domainName">the domain name</param>
  30996. <param name="password">the password</param>
  30997. <returns>the <see cref="T:System.Security.Principal.WindowsIdentity"/> for the account specified</returns>
  30998. <remarks>
  30999. <para>
  31000. Uses the Windows API call LogonUser to get a principal token for the account. This
  31001. token is used to initialize the WindowsIdentity.
  31002. </para>
  31003. </remarks>
  31004. </member>
  31005. <member name="P:log4net.Util.WindowsSecurityContext.Credentials">
  31006. <summary>
  31007. Gets or sets the impersonation mode for this security context
  31008. </summary>
  31009. <value>
  31010. The impersonation mode for this security context
  31011. </value>
  31012. <remarks>
  31013. <para>
  31014. Impersonate either a user with user credentials or
  31015. revert this thread to the credentials of the process.
  31016. The value is one of the <see cref="T:log4net.Util.WindowsSecurityContext.ImpersonationMode"/>
  31017. enum.
  31018. </para>
  31019. <para>
  31020. The default value is <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
  31021. </para>
  31022. <para>
  31023. When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
  31024. the user's credentials are established using the
  31025. <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>, <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.Password"/>
  31026. values.
  31027. </para>
  31028. <para>
  31029. When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process"/>
  31030. no other properties need to be set. If the calling thread is
  31031. impersonating then it will be reverted back to the process credentials.
  31032. </para>
  31033. </remarks>
  31034. </member>
  31035. <member name="P:log4net.Util.WindowsSecurityContext.UserName">
  31036. <summary>
  31037. Gets or sets the Windows username for this security context
  31038. </summary>
  31039. <value>
  31040. The Windows username for this security context
  31041. </value>
  31042. <remarks>
  31043. <para>
  31044. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  31045. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  31046. </para>
  31047. </remarks>
  31048. </member>
  31049. <member name="P:log4net.Util.WindowsSecurityContext.DomainName">
  31050. <summary>
  31051. Gets or sets the Windows domain name for this security context
  31052. </summary>
  31053. <value>
  31054. The Windows domain name for this security context
  31055. </value>
  31056. <remarks>
  31057. <para>
  31058. The default value for <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> is the local machine name
  31059. taken from the <see cref="P:System.Environment.MachineName"/> property.
  31060. </para>
  31061. <para>
  31062. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  31063. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  31064. </para>
  31065. </remarks>
  31066. </member>
  31067. <member name="P:log4net.Util.WindowsSecurityContext.Password">
  31068. <summary>
  31069. 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.
  31070. </summary>
  31071. <value>
  31072. 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.
  31073. </value>
  31074. <remarks>
  31075. <para>
  31076. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  31077. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  31078. </para>
  31079. </remarks>
  31080. </member>
  31081. <member name="T:log4net.Util.WindowsSecurityContext.ImpersonationMode">
  31082. <summary>
  31083. The impersonation modes for the <see cref="T:log4net.Util.WindowsSecurityContext"/>
  31084. </summary>
  31085. <remarks>
  31086. <para>
  31087. See the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property for
  31088. details.
  31089. </para>
  31090. </remarks>
  31091. </member>
  31092. <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User">
  31093. <summary>
  31094. Impersonate a user using the credentials supplied
  31095. </summary>
  31096. </member>
  31097. <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process">
  31098. <summary>
  31099. Revert this the thread to the credentials of the process
  31100. </summary>
  31101. </member>
  31102. <member name="T:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext">
  31103. <summary>
  31104. Adds <see cref="T:System.IDisposable"/> to <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
  31105. </summary>
  31106. <remarks>
  31107. <para>
  31108. Helper class to expose the <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
  31109. through the <see cref="T:System.IDisposable"/> interface.
  31110. </para>
  31111. </remarks>
  31112. </member>
  31113. <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.#ctor(System.Security.Principal.WindowsImpersonationContext)">
  31114. <summary>
  31115. Constructor
  31116. </summary>
  31117. <param name="impersonationContext">the impersonation context being wrapped</param>
  31118. <remarks>
  31119. <para>
  31120. Constructor
  31121. </para>
  31122. </remarks>
  31123. </member>
  31124. <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.Dispose">
  31125. <summary>
  31126. Revert the impersonation
  31127. </summary>
  31128. <remarks>
  31129. <para>
  31130. Revert the impersonation
  31131. </para>
  31132. </remarks>
  31133. </member>
  31134. <member name="T:log4net.GlobalContext">
  31135. <summary>
  31136. The log4net Global Context.
  31137. </summary>
  31138. <remarks>
  31139. <para>
  31140. The <c>GlobalContext</c> provides a location for global debugging
  31141. information to be stored.
  31142. </para>
  31143. <para>
  31144. The global context has a properties map and these properties can
  31145. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  31146. supports selecting and outputing these properties.
  31147. </para>
  31148. <para>
  31149. By default the <c>log4net:HostName</c> property is set to the name of
  31150. the current machine.
  31151. </para>
  31152. </remarks>
  31153. <example>
  31154. <code lang="C#">
  31155. GlobalContext.Properties["hostname"] = Environment.MachineName;
  31156. </code>
  31157. </example>
  31158. <threadsafety static="true" instance="true"/>
  31159. <author>Nicko Cadell</author>
  31160. </member>
  31161. <member name="M:log4net.GlobalContext.#ctor">
  31162. <summary>
  31163. Private Constructor.
  31164. </summary>
  31165. <remarks>
  31166. Uses a private access modifier to prevent instantiation of this class.
  31167. </remarks>
  31168. </member>
  31169. <member name="F:log4net.GlobalContext.s_properties">
  31170. <summary>
  31171. The global context properties instance
  31172. </summary>
  31173. </member>
  31174. <member name="P:log4net.GlobalContext.Properties">
  31175. <summary>
  31176. The global properties map.
  31177. </summary>
  31178. <value>
  31179. The global properties map.
  31180. </value>
  31181. <remarks>
  31182. <para>
  31183. The global properties map.
  31184. </para>
  31185. </remarks>
  31186. </member>
  31187. <member name="T:log4net.AssemblyInfo">
  31188. <summary>
  31189. Provides information about the environment the assembly has
  31190. been built for.
  31191. </summary>
  31192. </member>
  31193. <member name="F:log4net.AssemblyInfo.Version">
  31194. <summary>Version of the assembly</summary>
  31195. </member>
  31196. <member name="F:log4net.AssemblyInfo.TargetFrameworkVersion">
  31197. <summary>Version of the framework targeted</summary>
  31198. </member>
  31199. <member name="F:log4net.AssemblyInfo.TargetFramework">
  31200. <summary>Type of framework targeted</summary>
  31201. </member>
  31202. <member name="F:log4net.AssemblyInfo.ClientProfile">
  31203. <summary>Does it target a client profile?</summary>
  31204. </member>
  31205. <member name="P:log4net.AssemblyInfo.Info">
  31206. <summary>
  31207. Identifies the version and target for this assembly.
  31208. </summary>
  31209. </member>
  31210. <member name="T:log4net.LogicalThreadContext">
  31211. <summary>
  31212. The log4net Logical Thread Context.
  31213. </summary>
  31214. <remarks>
  31215. <para>
  31216. The <c>LogicalThreadContext</c> provides a location for <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> specific debugging
  31217. information to be stored.
  31218. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/> or <see cref="T:log4net.GlobalContext"/>
  31219. properties with the same name.
  31220. </para>
  31221. <para>
  31222. The Logical Thread Context has a properties map and a stack.
  31223. The properties and stack can
  31224. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  31225. supports selecting and outputting these properties.
  31226. </para>
  31227. <para>
  31228. The Logical Thread Context provides a diagnostic context for the current call context.
  31229. This is an instrument for distinguishing interleaved log
  31230. output from different sources. Log output is typically interleaved
  31231. when a server handles multiple clients near-simultaneously.
  31232. </para>
  31233. <para>
  31234. The Logical Thread Context is managed on a per <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> basis.
  31235. </para>
  31236. <para>
  31237. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  31238. <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
  31239. <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  31240. If the calling code does not have this permission then this context will be disabled.
  31241. It will not store any property values set on it.
  31242. </para>
  31243. </remarks>
  31244. <example>Example of using the thread context properties to store a username.
  31245. <code lang="C#">
  31246. LogicalThreadContext.Properties["user"] = userName;
  31247. log.Info("This log message has a LogicalThreadContext Property called 'user'");
  31248. </code>
  31249. </example>
  31250. <example>Example of how to push a message into the context stack
  31251. <code lang="C#">
  31252. using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
  31253. {
  31254. log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
  31255. } // at the end of the using block the message is automatically popped
  31256. </code>
  31257. </example>
  31258. <threadsafety static="true" instance="true"/>
  31259. <author>Nicko Cadell</author>
  31260. </member>
  31261. <member name="M:log4net.LogicalThreadContext.#ctor">
  31262. <summary>
  31263. Private Constructor.
  31264. </summary>
  31265. <remarks>
  31266. <para>
  31267. Uses a private access modifier to prevent instantiation of this class.
  31268. </para>
  31269. </remarks>
  31270. </member>
  31271. <member name="F:log4net.LogicalThreadContext.s_properties">
  31272. <summary>
  31273. The thread context properties instance
  31274. </summary>
  31275. </member>
  31276. <member name="F:log4net.LogicalThreadContext.s_stacks">
  31277. <summary>
  31278. The thread context stacks instance
  31279. </summary>
  31280. </member>
  31281. <member name="P:log4net.LogicalThreadContext.Properties">
  31282. <summary>
  31283. The thread properties map
  31284. </summary>
  31285. <value>
  31286. The thread properties map
  31287. </value>
  31288. <remarks>
  31289. <para>
  31290. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/>
  31291. or <see cref="T:log4net.GlobalContext"/> properties with the same name.
  31292. </para>
  31293. </remarks>
  31294. </member>
  31295. <member name="P:log4net.LogicalThreadContext.Stacks">
  31296. <summary>
  31297. The thread stacks
  31298. </summary>
  31299. <value>
  31300. stack map
  31301. </value>
  31302. <remarks>
  31303. <para>
  31304. The logical thread stacks.
  31305. </para>
  31306. </remarks>
  31307. </member>
  31308. <member name="T:log4net.LogManager">
  31309. <summary>
  31310. This class is used by client applications to request logger instances.
  31311. </summary>
  31312. <remarks>
  31313. <para>
  31314. This class has static methods that are used by a client to request
  31315. a logger instance. The <see cref="M:GetLogger(string)"/> method is
  31316. used to retrieve a logger.
  31317. </para>
  31318. <para>
  31319. See the <see cref="T:log4net.ILog"/> interface for more details.
  31320. </para>
  31321. </remarks>
  31322. <example>Simple example of logging messages
  31323. <code lang="C#">
  31324. ILog log = LogManager.GetLogger("application-log");
  31325. log.Info("Application Start");
  31326. log.Debug("This is a debug message");
  31327. if (log.IsDebugEnabled)
  31328. {
  31329. log.Debug("This is another debug message");
  31330. }
  31331. </code>
  31332. </example>
  31333. <threadsafety static="true" instance="true"/>
  31334. <seealso cref="T:log4net.ILog"/>
  31335. <author>Nicko Cadell</author>
  31336. <author>Gert Driesen</author>
  31337. </member>
  31338. <member name="M:log4net.LogManager.#ctor">
  31339. <summary>
  31340. Initializes a new instance of the <see cref="T:log4net.LogManager"/> class.
  31341. </summary>
  31342. <remarks>
  31343. Uses a private access modifier to prevent instantiation of this class.
  31344. </remarks>
  31345. </member>
  31346. <member name="M:log4net.LogManager.Exists(System.String)">
  31347. <overloads>Returns the named logger if it exists.</overloads>
  31348. <summary>
  31349. Returns the named logger if it exists.
  31350. </summary>
  31351. <remarks>
  31352. <para>
  31353. If the named logger exists (in the default repository) then it
  31354. returns a reference to the logger, otherwise it returns <c>null</c>.
  31355. </para>
  31356. </remarks>
  31357. <param name="name">The fully qualified logger name to look for.</param>
  31358. <returns>The logger found, or <c>null</c> if no logger could be found.</returns>
  31359. </member>
  31360. <member name="M:log4net.LogManager.GetCurrentLoggers">
  31361. <overloads>Get the currently defined loggers.</overloads>
  31362. <summary>
  31363. Returns all the currently defined loggers in the default repository.
  31364. </summary>
  31365. <remarks>
  31366. <para>The root logger is <b>not</b> included in the returned array.</para>
  31367. </remarks>
  31368. <returns>All the defined loggers.</returns>
  31369. </member>
  31370. <member name="M:log4net.LogManager.GetLogger(System.String)">
  31371. <overloads>Get or create a logger.</overloads>
  31372. <summary>
  31373. Retrieves or creates a named logger.
  31374. </summary>
  31375. <remarks>
  31376. <para>
  31377. Retrieves a logger named as the <paramref name="name"/>
  31378. parameter. If the named logger already exists, then the
  31379. existing instance will be returned. Otherwise, a new instance is
  31380. created.
  31381. </para>
  31382. <para>By default, loggers do not have a set level but inherit
  31383. it from the hierarchy. This is one of the central features of
  31384. log4net.
  31385. </para>
  31386. </remarks>
  31387. <param name="name">The name of the logger to retrieve.</param>
  31388. <returns>The logger with the name specified.</returns>
  31389. </member>
  31390. <member name="M:log4net.LogManager.Exists(System.String,System.String)">
  31391. <summary>
  31392. Returns the named logger if it exists.
  31393. </summary>
  31394. <remarks>
  31395. <para>
  31396. If the named logger exists (in the specified repository) then it
  31397. returns a reference to the logger, otherwise it returns
  31398. <c>null</c>.
  31399. </para>
  31400. </remarks>
  31401. <param name="repository">The repository to lookup in.</param>
  31402. <param name="name">The fully qualified logger name to look for.</param>
  31403. <returns>
  31404. The logger found, or <c>null</c> if the logger doesn't exist in the specified
  31405. repository.
  31406. </returns>
  31407. </member>
  31408. <member name="M:log4net.LogManager.Exists(System.Reflection.Assembly,System.String)">
  31409. <summary>
  31410. Returns the named logger if it exists.
  31411. </summary>
  31412. <remarks>
  31413. <para>
  31414. If the named logger exists (in the repository for the specified assembly) then it
  31415. returns a reference to the logger, otherwise it returns
  31416. <c>null</c>.
  31417. </para>
  31418. </remarks>
  31419. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31420. <param name="name">The fully qualified logger name to look for.</param>
  31421. <returns>
  31422. The logger, or <c>null</c> if the logger doesn't exist in the specified
  31423. assembly's repository.
  31424. </returns>
  31425. </member>
  31426. <member name="M:log4net.LogManager.GetCurrentLoggers(System.String)">
  31427. <summary>
  31428. Returns all the currently defined loggers in the specified repository.
  31429. </summary>
  31430. <param name="repository">The repository to lookup in.</param>
  31431. <remarks>
  31432. The root logger is <b>not</b> included in the returned array.
  31433. </remarks>
  31434. <returns>All the defined loggers.</returns>
  31435. </member>
  31436. <member name="M:log4net.LogManager.GetCurrentLoggers(System.Reflection.Assembly)">
  31437. <summary>
  31438. Returns all the currently defined loggers in the specified assembly's repository.
  31439. </summary>
  31440. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31441. <remarks>
  31442. The root logger is <b>not</b> included in the returned array.
  31443. </remarks>
  31444. <returns>All the defined loggers.</returns>
  31445. </member>
  31446. <member name="M:log4net.LogManager.GetLogger(System.String,System.String)">
  31447. <summary>
  31448. Retrieves or creates a named logger.
  31449. </summary>
  31450. <remarks>
  31451. <para>
  31452. Retrieve a logger named as the <paramref name="name"/>
  31453. parameter. If the named logger already exists, then the
  31454. existing instance will be returned. Otherwise, a new instance is
  31455. created.
  31456. </para>
  31457. <para>
  31458. By default, loggers do not have a set level but inherit
  31459. it from the hierarchy. This is one of the central features of
  31460. log4net.
  31461. </para>
  31462. </remarks>
  31463. <param name="repository">The repository to lookup in.</param>
  31464. <param name="name">The name of the logger to retrieve.</param>
  31465. <returns>The logger with the name specified.</returns>
  31466. </member>
  31467. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.String)">
  31468. <summary>
  31469. Retrieves or creates a named logger.
  31470. </summary>
  31471. <remarks>
  31472. <para>
  31473. Retrieve a logger named as the <paramref name="name"/>
  31474. parameter. If the named logger already exists, then the
  31475. existing instance will be returned. Otherwise, a new instance is
  31476. created.
  31477. </para>
  31478. <para>
  31479. By default, loggers do not have a set level but inherit
  31480. it from the hierarchy. This is one of the central features of
  31481. log4net.
  31482. </para>
  31483. </remarks>
  31484. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31485. <param name="name">The name of the logger to retrieve.</param>
  31486. <returns>The logger with the name specified.</returns>
  31487. </member>
  31488. <member name="M:log4net.LogManager.GetLogger(System.Type)">
  31489. <summary>
  31490. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  31491. </summary>
  31492. <remarks>
  31493. Get the logger for the fully qualified name of the type specified.
  31494. </remarks>
  31495. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  31496. <returns>The logger with the name specified.</returns>
  31497. </member>
  31498. <member name="M:log4net.LogManager.GetLogger(System.String,System.Type)">
  31499. <summary>
  31500. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  31501. </summary>
  31502. <remarks>
  31503. Gets the logger for the fully qualified name of the type specified.
  31504. </remarks>
  31505. <param name="repository">The repository to lookup in.</param>
  31506. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  31507. <returns>The logger with the name specified.</returns>
  31508. </member>
  31509. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)">
  31510. <summary>
  31511. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  31512. </summary>
  31513. <remarks>
  31514. Gets the logger for the fully qualified name of the type specified.
  31515. </remarks>
  31516. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31517. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  31518. <returns>The logger with the name specified.</returns>
  31519. </member>
  31520. <member name="M:log4net.LogManager.Shutdown">
  31521. <summary>
  31522. Shuts down the log4net system.
  31523. </summary>
  31524. <remarks>
  31525. <para>
  31526. Calling this method will <b>safely</b> close and remove all
  31527. appenders in all the loggers including root contained in all the
  31528. default repositories.
  31529. </para>
  31530. <para>
  31531. Some appenders need to be closed before the application exists.
  31532. Otherwise, pending logging events might be lost.
  31533. </para>
  31534. <para>The <c>shutdown</c> method is careful to close nested
  31535. appenders before closing regular appenders. This is allows
  31536. configurations where a regular appender is attached to a logger
  31537. and again to a nested appender.
  31538. </para>
  31539. </remarks>
  31540. </member>
  31541. <member name="M:log4net.LogManager.ShutdownRepository">
  31542. <overloads>Shutdown a logger repository.</overloads>
  31543. <summary>
  31544. Shuts down the default repository.
  31545. </summary>
  31546. <remarks>
  31547. <para>
  31548. Calling this method will <b>safely</b> close and remove all
  31549. appenders in all the loggers including root contained in the
  31550. default repository.
  31551. </para>
  31552. <para>Some appenders need to be closed before the application exists.
  31553. Otherwise, pending logging events might be lost.
  31554. </para>
  31555. <para>The <c>shutdown</c> method is careful to close nested
  31556. appenders before closing regular appenders. This is allows
  31557. configurations where a regular appender is attached to a logger
  31558. and again to a nested appender.
  31559. </para>
  31560. </remarks>
  31561. </member>
  31562. <member name="M:log4net.LogManager.ShutdownRepository(System.String)">
  31563. <summary>
  31564. Shuts down the repository for the repository specified.
  31565. </summary>
  31566. <remarks>
  31567. <para>
  31568. Calling this method will <b>safely</b> close and remove all
  31569. appenders in all the loggers including root contained in the
  31570. <paramref name="repository"/> specified.
  31571. </para>
  31572. <para>
  31573. Some appenders need to be closed before the application exists.
  31574. Otherwise, pending logging events might be lost.
  31575. </para>
  31576. <para>The <c>shutdown</c> method is careful to close nested
  31577. appenders before closing regular appenders. This is allows
  31578. configurations where a regular appender is attached to a logger
  31579. and again to a nested appender.
  31580. </para>
  31581. </remarks>
  31582. <param name="repository">The repository to shutdown.</param>
  31583. </member>
  31584. <member name="M:log4net.LogManager.ShutdownRepository(System.Reflection.Assembly)">
  31585. <summary>
  31586. Shuts down the repository specified.
  31587. </summary>
  31588. <remarks>
  31589. <para>
  31590. Calling this method will <b>safely</b> close and remove all
  31591. appenders in all the loggers including root contained in the
  31592. repository. The repository is looked up using
  31593. the <paramref name="repositoryAssembly"/> specified.
  31594. </para>
  31595. <para>
  31596. Some appenders need to be closed before the application exists.
  31597. Otherwise, pending logging events might be lost.
  31598. </para>
  31599. <para>
  31600. The <c>shutdown</c> method is careful to close nested
  31601. appenders before closing regular appenders. This is allows
  31602. configurations where a regular appender is attached to a logger
  31603. and again to a nested appender.
  31604. </para>
  31605. </remarks>
  31606. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31607. </member>
  31608. <member name="M:log4net.LogManager.ResetConfiguration">
  31609. <overloads>Reset the configuration of a repository</overloads>
  31610. <summary>
  31611. Resets all values contained in this repository instance to their defaults.
  31612. </summary>
  31613. <remarks>
  31614. <para>
  31615. Resets all values contained in the repository instance to their
  31616. defaults. This removes all appenders from all loggers, sets
  31617. the level of all non-root loggers to <c>null</c>,
  31618. sets their additivity flag to <c>true</c> and sets the level
  31619. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  31620. message disabling is set to its default "off" value.
  31621. </para>
  31622. </remarks>
  31623. </member>
  31624. <member name="M:log4net.LogManager.ResetConfiguration(System.String)">
  31625. <summary>
  31626. Resets all values contained in this repository instance to their defaults.
  31627. </summary>
  31628. <remarks>
  31629. <para>
  31630. Reset all values contained in the repository instance to their
  31631. defaults. This removes all appenders from all loggers, sets
  31632. the level of all non-root loggers to <c>null</c>,
  31633. sets their additivity flag to <c>true</c> and sets the level
  31634. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  31635. message disabling is set to its default "off" value.
  31636. </para>
  31637. </remarks>
  31638. <param name="repository">The repository to reset.</param>
  31639. </member>
  31640. <member name="M:log4net.LogManager.ResetConfiguration(System.Reflection.Assembly)">
  31641. <summary>
  31642. Resets all values contained in this repository instance to their defaults.
  31643. </summary>
  31644. <remarks>
  31645. <para>
  31646. Reset all values contained in the repository instance to their
  31647. defaults. This removes all appenders from all loggers, sets
  31648. the level of all non-root loggers to <c>null</c>,
  31649. sets their additivity flag to <c>true</c> and sets the level
  31650. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  31651. message disabling is set to its default "off" value.
  31652. </para>
  31653. </remarks>
  31654. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  31655. </member>
  31656. <member name="M:log4net.LogManager.GetLoggerRepository">
  31657. <overloads>Get the logger repository.</overloads>
  31658. <summary>
  31659. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31660. </summary>
  31661. <remarks>
  31662. <para>
  31663. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31664. by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
  31665. </para>
  31666. </remarks>
  31667. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
  31668. </member>
  31669. <member name="M:log4net.LogManager.GetLoggerRepository(System.String)">
  31670. <summary>
  31671. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31672. </summary>
  31673. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  31674. <remarks>
  31675. <para>
  31676. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31677. by the <paramref name="repository"/> argument.
  31678. </para>
  31679. </remarks>
  31680. <param name="repository">The repository to lookup in.</param>
  31681. </member>
  31682. <member name="M:log4net.LogManager.GetLoggerRepository(System.Reflection.Assembly)">
  31683. <summary>
  31684. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31685. </summary>
  31686. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  31687. <remarks>
  31688. <para>
  31689. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31690. by the <paramref name="repositoryAssembly"/> argument.
  31691. </para>
  31692. </remarks>
  31693. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31694. </member>
  31695. <member name="M:log4net.LogManager.GetRepository">
  31696. <overloads>Get a logger repository.</overloads>
  31697. <summary>
  31698. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31699. </summary>
  31700. <remarks>
  31701. <para>
  31702. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31703. by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
  31704. </para>
  31705. </remarks>
  31706. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
  31707. </member>
  31708. <member name="M:log4net.LogManager.GetRepository(System.String)">
  31709. <summary>
  31710. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31711. </summary>
  31712. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  31713. <remarks>
  31714. <para>
  31715. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31716. by the <paramref name="repository"/> argument.
  31717. </para>
  31718. </remarks>
  31719. <param name="repository">The repository to lookup in.</param>
  31720. </member>
  31721. <member name="M:log4net.LogManager.GetRepository(System.Reflection.Assembly)">
  31722. <summary>
  31723. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31724. </summary>
  31725. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  31726. <remarks>
  31727. <para>
  31728. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31729. by the <paramref name="repositoryAssembly"/> argument.
  31730. </para>
  31731. </remarks>
  31732. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31733. </member>
  31734. <member name="M:log4net.LogManager.CreateDomain(System.Type)">
  31735. <overloads>Create a domain</overloads>
  31736. <summary>
  31737. Creates a repository with the specified repository type.
  31738. </summary>
  31739. <remarks>
  31740. <para>
  31741. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  31742. </para>
  31743. <para>
  31744. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  31745. specified such that a call to <see cref="M:GetRepository()"/> will return
  31746. the same repository instance.
  31747. </para>
  31748. </remarks>
  31749. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31750. and has a no arg constructor. An instance of this type will be created to act
  31751. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31752. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31753. </member>
  31754. <member name="M:log4net.LogManager.CreateRepository(System.Type)">
  31755. <overloads>Create a logger repository.</overloads>
  31756. <summary>
  31757. Creates a repository with the specified repository type.
  31758. </summary>
  31759. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31760. and has a no arg constructor. An instance of this type will be created to act
  31761. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31762. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31763. <remarks>
  31764. <para>
  31765. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  31766. specified such that a call to <see cref="M:GetRepository()"/> will return
  31767. the same repository instance.
  31768. </para>
  31769. </remarks>
  31770. </member>
  31771. <member name="M:log4net.LogManager.CreateDomain(System.String)">
  31772. <summary>
  31773. Creates a repository with the specified name.
  31774. </summary>
  31775. <remarks>
  31776. <para>
  31777. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  31778. </para>
  31779. <para>
  31780. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  31781. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  31782. </para>
  31783. <para>
  31784. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  31785. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  31786. </para>
  31787. </remarks>
  31788. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  31789. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31790. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  31791. </member>
  31792. <member name="M:log4net.LogManager.CreateRepository(System.String)">
  31793. <summary>
  31794. Creates a repository with the specified name.
  31795. </summary>
  31796. <remarks>
  31797. <para>
  31798. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  31799. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  31800. </para>
  31801. <para>
  31802. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  31803. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  31804. </para>
  31805. </remarks>
  31806. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  31807. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31808. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  31809. </member>
  31810. <member name="M:log4net.LogManager.CreateDomain(System.String,System.Type)">
  31811. <summary>
  31812. Creates a repository with the specified name and repository type.
  31813. </summary>
  31814. <remarks>
  31815. <para>
  31816. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  31817. </para>
  31818. <para>
  31819. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  31820. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  31821. </para>
  31822. </remarks>
  31823. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  31824. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31825. and has a no arg constructor. An instance of this type will be created to act
  31826. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31827. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31828. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  31829. </member>
  31830. <member name="M:log4net.LogManager.CreateRepository(System.String,System.Type)">
  31831. <summary>
  31832. Creates a repository with the specified name and repository type.
  31833. </summary>
  31834. <remarks>
  31835. <para>
  31836. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  31837. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  31838. </para>
  31839. </remarks>
  31840. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  31841. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31842. and has a no arg constructor. An instance of this type will be created to act
  31843. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31844. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31845. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  31846. </member>
  31847. <member name="M:log4net.LogManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  31848. <summary>
  31849. Creates a repository for the specified assembly and repository type.
  31850. </summary>
  31851. <remarks>
  31852. <para>
  31853. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  31854. </para>
  31855. <para>
  31856. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  31857. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  31858. same assembly specified will return the same repository instance.
  31859. </para>
  31860. </remarks>
  31861. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  31862. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31863. and has a no arg constructor. An instance of this type will be created to act
  31864. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31865. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31866. </member>
  31867. <member name="M:log4net.LogManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  31868. <summary>
  31869. Creates a repository for the specified assembly and repository type.
  31870. </summary>
  31871. <remarks>
  31872. <para>
  31873. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  31874. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  31875. same assembly specified will return the same repository instance.
  31876. </para>
  31877. </remarks>
  31878. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  31879. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31880. and has a no arg constructor. An instance of this type will be created to act
  31881. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31882. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31883. </member>
  31884. <member name="M:log4net.LogManager.GetAllRepositories">
  31885. <summary>
  31886. Gets the list of currently defined repositories.
  31887. </summary>
  31888. <remarks>
  31889. <para>
  31890. Get an array of all the <see cref="T:log4net.Repository.ILoggerRepository"/> objects that have been created.
  31891. </para>
  31892. </remarks>
  31893. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  31894. </member>
  31895. <member name="M:log4net.LogManager.Flush(System.Int32)">
  31896. <summary>
  31897. Flushes logging events buffered in all configured appenders in the default repository.
  31898. </summary>
  31899. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed.</param>
  31900. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  31901. </member>
  31902. <member name="M:log4net.LogManager.WrapLogger(log4net.Core.ILogger)">
  31903. <summary>
  31904. Looks up the wrapper object for the logger specified.
  31905. </summary>
  31906. <param name="logger">The logger to get the wrapper for.</param>
  31907. <returns>The wrapper for the logger specified.</returns>
  31908. </member>
  31909. <member name="M:log4net.LogManager.WrapLoggers(log4net.Core.ILogger[])">
  31910. <summary>
  31911. Looks up the wrapper objects for the loggers specified.
  31912. </summary>
  31913. <param name="loggers">The loggers to get the wrappers for.</param>
  31914. <returns>The wrapper objects for the loggers specified.</returns>
  31915. </member>
  31916. <member name="M:log4net.LogManager.WrapperCreationHandler(log4net.Core.ILogger)">
  31917. <summary>
  31918. Create the <see cref="T:log4net.Core.ILoggerWrapper"/> objects used by
  31919. this manager.
  31920. </summary>
  31921. <param name="logger">The logger to wrap.</param>
  31922. <returns>The wrapper for the logger specified.</returns>
  31923. </member>
  31924. <member name="F:log4net.LogManager.s_wrapperMap">
  31925. <summary>
  31926. The wrapper map to use to hold the <see cref="T:log4net.Core.LogImpl"/> objects.
  31927. </summary>
  31928. </member>
  31929. <member name="T:log4net.MDC">
  31930. <summary>
  31931. Implementation of Mapped Diagnostic Contexts.
  31932. </summary>
  31933. <remarks>
  31934. <note>
  31935. <para>
  31936. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  31937. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  31938. </para>
  31939. </note>
  31940. <para>
  31941. The MDC class is similar to the <see cref="T:log4net.NDC"/> class except that it is
  31942. based on a map instead of a stack. It provides <i>mapped
  31943. diagnostic contexts</i>. A <i>Mapped Diagnostic Context</i>, or
  31944. MDC in short, is an instrument for distinguishing interleaved log
  31945. output from different sources. Log output is typically interleaved
  31946. when a server handles multiple clients near-simultaneously.
  31947. </para>
  31948. <para>
  31949. The MDC is managed on a per thread basis.
  31950. </para>
  31951. </remarks>
  31952. <threadsafety static="true" instance="true"/>
  31953. <author>Nicko Cadell</author>
  31954. <author>Gert Driesen</author>
  31955. </member>
  31956. <member name="M:log4net.MDC.#ctor">
  31957. <summary>
  31958. Initializes a new instance of the <see cref="T:log4net.MDC"/> class.
  31959. </summary>
  31960. <remarks>
  31961. Uses a private access modifier to prevent instantiation of this class.
  31962. </remarks>
  31963. </member>
  31964. <member name="M:log4net.MDC.Get(System.String)">
  31965. <summary>
  31966. Gets the context value identified by the <paramref name="key"/> parameter.
  31967. </summary>
  31968. <param name="key">The key to lookup in the MDC.</param>
  31969. <returns>The string value held for the key, or a <c>null</c> reference if no corresponding value is found.</returns>
  31970. <remarks>
  31971. <note>
  31972. <para>
  31973. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  31974. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  31975. </para>
  31976. </note>
  31977. <para>
  31978. If the <paramref name="key"/> parameter does not look up to a
  31979. previously defined context then <c>null</c> will be returned.
  31980. </para>
  31981. </remarks>
  31982. </member>
  31983. <member name="M:log4net.MDC.Set(System.String,System.String)">
  31984. <summary>
  31985. Add an entry to the MDC
  31986. </summary>
  31987. <param name="key">The key to store the value under.</param>
  31988. <param name="value">The value to store.</param>
  31989. <remarks>
  31990. <note>
  31991. <para>
  31992. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  31993. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  31994. </para>
  31995. </note>
  31996. <para>
  31997. Puts a context value (the <paramref name="value"/> parameter) as identified
  31998. with the <paramref name="key"/> parameter into the current thread's
  31999. context map.
  32000. </para>
  32001. <para>
  32002. If a value is already defined for the <paramref name="key"/>
  32003. specified then the value will be replaced. If the <paramref name="value"/>
  32004. is specified as <c>null</c> then the key value mapping will be removed.
  32005. </para>
  32006. </remarks>
  32007. </member>
  32008. <member name="M:log4net.MDC.Remove(System.String)">
  32009. <summary>
  32010. Removes the key value mapping for the key specified.
  32011. </summary>
  32012. <param name="key">The key to remove.</param>
  32013. <remarks>
  32014. <note>
  32015. <para>
  32016. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  32017. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  32018. </para>
  32019. </note>
  32020. <para>
  32021. Remove the specified entry from this thread's MDC
  32022. </para>
  32023. </remarks>
  32024. </member>
  32025. <member name="M:log4net.MDC.Clear">
  32026. <summary>
  32027. Clear all entries in the MDC
  32028. </summary>
  32029. <remarks>
  32030. <note>
  32031. <para>
  32032. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  32033. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  32034. </para>
  32035. </note>
  32036. <para>
  32037. Remove all the entries from this thread's MDC
  32038. </para>
  32039. </remarks>
  32040. </member>
  32041. <member name="T:log4net.NDC">
  32042. <summary>
  32043. Implementation of Nested Diagnostic Contexts.
  32044. </summary>
  32045. <remarks>
  32046. <note>
  32047. <para>
  32048. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32049. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32050. </para>
  32051. </note>
  32052. <para>
  32053. A Nested Diagnostic Context, or NDC in short, is an instrument
  32054. to distinguish interleaved log output from different sources. Log
  32055. output is typically interleaved when a server handles multiple
  32056. clients near-simultaneously.
  32057. </para>
  32058. <para>
  32059. Interleaved log output can still be meaningful if each log entry
  32060. from different contexts had a distinctive stamp. This is where NDCs
  32061. come into play.
  32062. </para>
  32063. <para>
  32064. Note that NDCs are managed on a per thread basis. The NDC class
  32065. is made up of static methods that operate on the context of the
  32066. calling thread.
  32067. </para>
  32068. </remarks>
  32069. <example>How to push a message into the context
  32070. <code lang="C#">
  32071. using(NDC.Push("my context message"))
  32072. {
  32073. ... all log calls will have 'my context message' included ...
  32074. } // at the end of the using block the message is automatically removed
  32075. </code>
  32076. </example>
  32077. <threadsafety static="true" instance="true"/>
  32078. <author>Nicko Cadell</author>
  32079. <author>Gert Driesen</author>
  32080. </member>
  32081. <member name="M:log4net.NDC.#ctor">
  32082. <summary>
  32083. Initializes a new instance of the <see cref="T:log4net.NDC"/> class.
  32084. </summary>
  32085. <remarks>
  32086. Uses a private access modifier to prevent instantiation of this class.
  32087. </remarks>
  32088. </member>
  32089. <member name="M:log4net.NDC.Clear">
  32090. <summary>
  32091. Clears all the contextual information held on the current thread.
  32092. </summary>
  32093. <remarks>
  32094. <note>
  32095. <para>
  32096. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32097. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32098. </para>
  32099. </note>
  32100. <para>
  32101. Clears the stack of NDC data held on the current thread.
  32102. </para>
  32103. </remarks>
  32104. </member>
  32105. <member name="M:log4net.NDC.CloneStack">
  32106. <summary>
  32107. Creates a clone of the stack of context information.
  32108. </summary>
  32109. <returns>A clone of the context info for this thread.</returns>
  32110. <remarks>
  32111. <note>
  32112. <para>
  32113. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32114. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32115. </para>
  32116. </note>
  32117. <para>
  32118. The results of this method can be passed to the <see cref="M:log4net.NDC.Inherit(System.Collections.Stack)"/>
  32119. method to allow child threads to inherit the context of their
  32120. parent thread.
  32121. </para>
  32122. </remarks>
  32123. </member>
  32124. <member name="M:log4net.NDC.Inherit(System.Collections.Stack)">
  32125. <summary>
  32126. Inherits the contextual information from another thread.
  32127. </summary>
  32128. <param name="stack">The context stack to inherit.</param>
  32129. <remarks>
  32130. <note>
  32131. <para>
  32132. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32133. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32134. </para>
  32135. </note>
  32136. <para>
  32137. This thread will use the context information from the stack
  32138. supplied. This can be used to initialize child threads with
  32139. the same contextual information as their parent threads. These
  32140. contexts will <b>NOT</b> be shared. Any further contexts that
  32141. are pushed onto the stack will not be visible to the other.
  32142. Call <see cref="M:log4net.NDC.CloneStack"/> to obtain a stack to pass to
  32143. this method.
  32144. </para>
  32145. </remarks>
  32146. </member>
  32147. <member name="M:log4net.NDC.Pop">
  32148. <summary>
  32149. Removes the top context from the stack.
  32150. </summary>
  32151. <returns>
  32152. The message in the context that was removed from the top
  32153. of the stack.
  32154. </returns>
  32155. <remarks>
  32156. <note>
  32157. <para>
  32158. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32159. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32160. </para>
  32161. </note>
  32162. <para>
  32163. Remove the top context from the stack, and return
  32164. it to the caller. If the stack is empty then an
  32165. empty string (not <c>null</c>) is returned.
  32166. </para>
  32167. </remarks>
  32168. </member>
  32169. <member name="M:log4net.NDC.Push(System.String)">
  32170. <summary>
  32171. Pushes a new context message.
  32172. </summary>
  32173. <param name="message">The new context message.</param>
  32174. <returns>
  32175. An <see cref="T:System.IDisposable"/> that can be used to clean up
  32176. the context stack.
  32177. </returns>
  32178. <remarks>
  32179. <note>
  32180. <para>
  32181. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32182. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32183. </para>
  32184. </note>
  32185. <para>
  32186. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  32187. is returned that can be used to clean up the context stack. This
  32188. can be easily combined with the <c>using</c> keyword to scope the
  32189. context.
  32190. </para>
  32191. </remarks>
  32192. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  32193. <code lang="C#">
  32194. using(log4net.NDC.Push("NDC_Message"))
  32195. {
  32196. log.Warn("This should have an NDC message");
  32197. }
  32198. </code>
  32199. </example>
  32200. </member>
  32201. <member name="M:log4net.NDC.PushFormat(System.String,System.Object[])">
  32202. <summary>
  32203. Pushes a new context message.
  32204. </summary>
  32205. <param name="messageFormat">The new context message string format.</param>
  32206. <param name="args">Arguments to be passed into messageFormat.</param>
  32207. <returns>
  32208. An <see cref="T:System.IDisposable"/> that can be used to clean up
  32209. the context stack.
  32210. </returns>
  32211. <remarks>
  32212. <note>
  32213. <para>
  32214. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32215. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32216. </para>
  32217. </note>
  32218. <para>
  32219. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  32220. is returned that can be used to clean up the context stack. This
  32221. can be easily combined with the <c>using</c> keyword to scope the
  32222. context.
  32223. </para>
  32224. </remarks>
  32225. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  32226. <code lang="C#">
  32227. var someValue = "ExampleContext"
  32228. using(log4net.NDC.PushFormat("NDC_Message {0}", someValue))
  32229. {
  32230. log.Warn("This should have an NDC message");
  32231. }
  32232. </code>
  32233. </example>
  32234. </member>
  32235. <member name="M:log4net.NDC.Remove">
  32236. <summary>
  32237. Removes the context information for this thread. It is
  32238. not required to call this method.
  32239. </summary>
  32240. <remarks>
  32241. <note>
  32242. <para>
  32243. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32244. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32245. </para>
  32246. </note>
  32247. <para>
  32248. This method is not implemented.
  32249. </para>
  32250. </remarks>
  32251. </member>
  32252. <member name="M:log4net.NDC.SetMaxDepth(System.Int32)">
  32253. <summary>
  32254. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  32255. </summary>
  32256. <param name="maxDepth">The maximum depth of the stack</param>
  32257. <remarks>
  32258. <note>
  32259. <para>
  32260. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32261. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32262. </para>
  32263. </note>
  32264. <para>
  32265. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  32266. This may truncate the head of the stack. This only affects the
  32267. stack in the current thread. Also it does not prevent it from
  32268. growing, it only sets the maximum depth at the time of the
  32269. call. This can be used to return to a known context depth.
  32270. </para>
  32271. </remarks>
  32272. </member>
  32273. <member name="P:log4net.NDC.Depth">
  32274. <summary>
  32275. Gets the current context depth.
  32276. </summary>
  32277. <value>The current context depth.</value>
  32278. <remarks>
  32279. <note>
  32280. <para>
  32281. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32282. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32283. </para>
  32284. </note>
  32285. <para>
  32286. The number of context values pushed onto the context stack.
  32287. </para>
  32288. <para>
  32289. Used to record the current depth of the context. This can then
  32290. be restored using the <see cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/> method.
  32291. </para>
  32292. </remarks>
  32293. <seealso cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/>
  32294. </member>
  32295. <member name="T:log4net.ThreadContext">
  32296. <summary>
  32297. The log4net Thread Context.
  32298. </summary>
  32299. <remarks>
  32300. <para>
  32301. The <c>ThreadContext</c> provides a location for thread specific debugging
  32302. information to be stored.
  32303. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  32304. properties with the same name.
  32305. </para>
  32306. <para>
  32307. The thread context has a properties map and a stack.
  32308. The properties and stack can
  32309. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  32310. supports selecting and outputting these properties.
  32311. </para>
  32312. <para>
  32313. The Thread Context provides a diagnostic context for the current thread.
  32314. This is an instrument for distinguishing interleaved log
  32315. output from different sources. Log output is typically interleaved
  32316. when a server handles multiple clients near-simultaneously.
  32317. </para>
  32318. <para>
  32319. The Thread Context is managed on a per thread basis.
  32320. </para>
  32321. </remarks>
  32322. <example>Example of using the thread context properties to store a username.
  32323. <code lang="C#">
  32324. ThreadContext.Properties["user"] = userName;
  32325. log.Info("This log message has a ThreadContext Property called 'user'");
  32326. </code>
  32327. </example>
  32328. <example>Example of how to push a message into the context stack
  32329. <code lang="C#">
  32330. using(ThreadContext.Stacks["NDC"].Push("my context message"))
  32331. {
  32332. log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
  32333. } // at the end of the using block the message is automatically popped
  32334. </code>
  32335. </example>
  32336. <threadsafety static="true" instance="true"/>
  32337. <author>Nicko Cadell</author>
  32338. </member>
  32339. <member name="M:log4net.ThreadContext.#ctor">
  32340. <summary>
  32341. Private Constructor.
  32342. </summary>
  32343. <remarks>
  32344. <para>
  32345. Uses a private access modifier to prevent instantiation of this class.
  32346. </para>
  32347. </remarks>
  32348. </member>
  32349. <member name="F:log4net.ThreadContext.s_properties">
  32350. <summary>
  32351. The thread context properties instance
  32352. </summary>
  32353. </member>
  32354. <member name="F:log4net.ThreadContext.s_stacks">
  32355. <summary>
  32356. The thread context stacks instance
  32357. </summary>
  32358. </member>
  32359. <member name="P:log4net.ThreadContext.Properties">
  32360. <summary>
  32361. The thread properties map
  32362. </summary>
  32363. <value>
  32364. The thread properties map
  32365. </value>
  32366. <remarks>
  32367. <para>
  32368. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  32369. properties with the same name.
  32370. </para>
  32371. </remarks>
  32372. </member>
  32373. <member name="P:log4net.ThreadContext.Stacks">
  32374. <summary>
  32375. The thread stacks
  32376. </summary>
  32377. <value>
  32378. stack map
  32379. </value>
  32380. <remarks>
  32381. <para>
  32382. The thread local stacks.
  32383. </para>
  32384. </remarks>
  32385. </member>
  32386. </members>
  32387. </doc>