PageRenderTime 121ms CodeModel.GetById 25ms RepoModel.GetById 1ms app.codeStats 1ms

/packages/log4net.1.2.10/lib/2.0/log4net.xml

http://github.com/teamaton/toolbelt
XML | 10430 lines | 10411 code | 19 blank | 0 comment | 0 complexity | c7569dba001b18130ada8afd65de8c70 MD5 | raw file
  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:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.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:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.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:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.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:log4net.Core.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:log4net.Core.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="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize">
  273. <summary>
  274. Initial buffer size
  275. </summary>
  276. </member>
  277. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity">
  278. <summary>
  279. Maximum buffer size before it is recycled
  280. </summary>
  281. </member>
  282. <member name="M:log4net.Appender.AppenderSkeleton.#ctor">
  283. <summary>
  284. Default constructor
  285. </summary>
  286. <remarks>
  287. <para>Empty default constructor</para>
  288. </remarks>
  289. </member>
  290. <member name="M:log4net.Appender.AppenderSkeleton.Finalize">
  291. <summary>
  292. Finalizes this appender by calling the implementation's
  293. <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method.
  294. </summary>
  295. <remarks>
  296. <para>
  297. If this appender has not been closed then the <c>Finalize</c> method
  298. will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>.
  299. </para>
  300. </remarks>
  301. </member>
  302. <member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions">
  303. <summary>
  304. Initialize the appender based on the options set
  305. </summary>
  306. <remarks>
  307. <para>
  308. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  309. activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must
  310. be called on this object after the configuration properties have
  311. been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this
  312. object is in an undefined state and must not be used.
  313. </para>
  314. <para>
  315. If any of the configuration properties are modified then
  316. <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again.
  317. </para>
  318. </remarks>
  319. </member>
  320. <member name="M:log4net.Appender.AppenderSkeleton.Close">
  321. <summary>
  322. Closes the appender and release resources.
  323. </summary>
  324. <remarks>
  325. <para>
  326. Release any resources allocated within the appender such as file handles,
  327. network connections, etc.
  328. </para>
  329. <para>
  330. It is a programming error to append to a closed appender.
  331. </para>
  332. <para>
  333. This method cannot be overridden by subclasses. This method
  334. delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/>
  335. method which must be overridden in the subclass.
  336. </para>
  337. </remarks>
  338. </member>
  339. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)">
  340. <summary>
  341. Performs threshold checks and invokes filters before
  342. delegating actual logging to the subclasses specific
  343. <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> method.
  344. </summary>
  345. <param name="loggingEvent">The event to log.</param>
  346. <remarks>
  347. <para>
  348. This method cannot be overridden by derived classes. A
  349. derived class should override the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> method
  350. which is called by this method.
  351. </para>
  352. <para>
  353. The implementation of this method is as follows:
  354. </para>
  355. <para>
  356. <list type="bullet">
  357. <item>
  358. <description>
  359. Checks that the severity of the <paramref name="loggingEvent"/>
  360. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  361. appender.</description>
  362. </item>
  363. <item>
  364. <description>
  365. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  366. <paramref name="loggingEvent"/>.
  367. </description>
  368. </item>
  369. <item>
  370. <description>
  371. Calls <see cref="M:log4net.Appender.AppenderSkeleton.PreAppendCheck"/> and checks that
  372. it returns <c>true</c>.</description>
  373. </item>
  374. </list>
  375. </para>
  376. <para>
  377. If all of the above steps succeed then the <paramref name="loggingEvent"/>
  378. will be passed to the abstract <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> method.
  379. </para>
  380. </remarks>
  381. </member>
  382. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])">
  383. <summary>
  384. Performs threshold checks and invokes filters before
  385. delegating actual logging to the subclasses specific
  386. <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])"/> method.
  387. </summary>
  388. <param name="loggingEvents">The array of events to log.</param>
  389. <remarks>
  390. <para>
  391. This method cannot be overridden by derived classes. A
  392. derived class should override the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])"/> method
  393. which is called by this method.
  394. </para>
  395. <para>
  396. The implementation of this method is as follows:
  397. </para>
  398. <para>
  399. <list type="bullet">
  400. <item>
  401. <description>
  402. Checks that the severity of the <paramref name="loggingEvent"/>
  403. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  404. appender.</description>
  405. </item>
  406. <item>
  407. <description>
  408. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  409. <paramref name="loggingEvent"/>.
  410. </description>
  411. </item>
  412. <item>
  413. <description>
  414. Calls <see cref="M:log4net.Appender.AppenderSkeleton.PreAppendCheck"/> and checks that
  415. it returns <c>true</c>.</description>
  416. </item>
  417. </list>
  418. </para>
  419. <para>
  420. If all of the above steps succeed then the <paramref name="loggingEvents"/>
  421. will be passed to the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])"/> method.
  422. </para>
  423. </remarks>
  424. </member>
  425. <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)">
  426. <summary>
  427. Test if the logging event should we output by this appender
  428. </summary>
  429. <param name="loggingEvent">the event to test</param>
  430. <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns>
  431. <remarks>
  432. <para>
  433. This method checks the logging event against the threshold level set
  434. on this appender and also against the filters specified on this
  435. appender.
  436. </para>
  437. <para>
  438. The implementation of this method is as follows:
  439. </para>
  440. <para>
  441. <list type="bullet">
  442. <item>
  443. <description>
  444. Checks that the severity of the <paramref name="loggingEvent"/>
  445. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  446. appender.</description>
  447. </item>
  448. <item>
  449. <description>
  450. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  451. <paramref name="loggingEvent"/>.
  452. </description>
  453. </item>
  454. </list>
  455. </para>
  456. </remarks>
  457. </member>
  458. <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
  459. <summary>
  460. Adds a filter to the end of the filter chain.
  461. </summary>
  462. <param name="filter">the filter to add to this appender</param>
  463. <remarks>
  464. <para>
  465. The Filters are organized in a linked list.
  466. </para>
  467. <para>
  468. Setting this property causes the new filter to be pushed onto the
  469. back of the filter chain.
  470. </para>
  471. </remarks>
  472. </member>
  473. <member name="M:log4net.Appender.AppenderSkeleton.ClearFilters">
  474. <summary>
  475. Clears the filter list for this appender.
  476. </summary>
  477. <remarks>
  478. <para>
  479. Clears the filter list for this appender.
  480. </para>
  481. </remarks>
  482. </member>
  483. <member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)">
  484. <summary>
  485. Checks if the message level is below this appender's threshold.
  486. </summary>
  487. <param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param>
  488. <remarks>
  489. <para>
  490. If there is no threshold set, then the return value is always <c>true</c>.
  491. </para>
  492. </remarks>
  493. <returns>
  494. <c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/>
  495. requirements of this appender.
  496. </returns>
  497. </member>
  498. <member name="M:log4net.Appender.AppenderSkeleton.OnClose">
  499. <summary>
  500. Is called when the appender is closed. Derived classes should override
  501. this method if resources need to be released.
  502. </summary>
  503. <remarks>
  504. <para>
  505. Releases any resources allocated within the appender such as file handles,
  506. network connections, etc.
  507. </para>
  508. <para>
  509. It is a programming error to append to a closed appender.
  510. </para>
  511. </remarks>
  512. </member>
  513. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  514. <summary>
  515. Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method
  516. to perform actual logging.
  517. </summary>
  518. <param name="loggingEvent">The event to append.</param>
  519. <remarks>
  520. <para>
  521. A subclass must implement this method to perform
  522. logging of the <paramref name="loggingEvent"/>.
  523. </para>
  524. <para>This method will be called by <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/>
  525. if all the conditions listed for that method are met.
  526. </para>
  527. <para>
  528. To restrict the logging of events in the appender
  529. override the <see cref="M:log4net.Appender.AppenderSkeleton.PreAppendCheck"/> method.
  530. </para>
  531. </remarks>
  532. </member>
  533. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])">
  534. <summary>
  535. Append a bulk array of logging events.
  536. </summary>
  537. <param name="loggingEvents">the array of logging events</param>
  538. <remarks>
  539. <para>
  540. This base class implementation calls the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/>
  541. method for each element in the bulk array.
  542. </para>
  543. <para>
  544. A sub class that can better process a bulk array of events should
  545. override this method in addition to <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/>.
  546. </para>
  547. </remarks>
  548. </member>
  549. <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
  550. <summary>
  551. Called before <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> as a precondition.
  552. </summary>
  553. <remarks>
  554. <para>
  555. This method is called by <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/>
  556. before the call to the abstract <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> method.
  557. </para>
  558. <para>
  559. This method can be overridden in a subclass to extend the checks
  560. made before the event is passed to the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> method.
  561. </para>
  562. <para>
  563. A subclass should ensure that they delegate this call to
  564. this base class if it is overridden.
  565. </para>
  566. </remarks>
  567. <returns><c>true</c> if the call to <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"/> should proceed.</returns>
  568. </member>
  569. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)">
  570. <summary>
  571. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  572. </summary>
  573. <param name="loggingEvent">The event to render.</param>
  574. <returns>The event rendered as a string.</returns>
  575. <remarks>
  576. <para>
  577. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  578. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  579. set to render the <paramref name="loggingEvent"/> to
  580. a string.
  581. </para>
  582. <para>If there is exception data in the logging event and
  583. the layout does not process the exception, this method
  584. will append the exception text to the rendered string.
  585. </para>
  586. <para>
  587. Where possible use the alternative version of this method
  588. <see cref="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)"/>.
  589. That method streams the rendering onto an existing Writer
  590. which can give better performance if the caller already has
  591. a <see cref="T:System.IO.TextWriter"/> open and ready for writing.
  592. </para>
  593. </remarks>
  594. </member>
  595. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  596. <summary>
  597. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  598. </summary>
  599. <param name="loggingEvent">The event to render.</param>
  600. <param name="writer">The TextWriter to write the formatted event to</param>
  601. <remarks>
  602. <para>
  603. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  604. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  605. set to render the <paramref name="loggingEvent"/> to
  606. a string.
  607. </para>
  608. <para>If there is exception data in the logging event and
  609. the layout does not process the exception, this method
  610. will append the exception text to the rendered string.
  611. </para>
  612. <para>
  613. Use this method in preference to <see cref="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)"/>
  614. where possible. If, however, the caller needs to render the event
  615. to a string then <see cref="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)"/> does
  616. provide an efficient mechanism for doing so.
  617. </para>
  618. </remarks>
  619. </member>
  620. <member name="F:log4net.Appender.AppenderSkeleton.m_layout">
  621. <summary>
  622. The layout of this appender.
  623. </summary>
  624. <remarks>
  625. See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information.
  626. </remarks>
  627. </member>
  628. <member name="F:log4net.Appender.AppenderSkeleton.m_name">
  629. <summary>
  630. The name of this appender.
  631. </summary>
  632. <remarks>
  633. See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information.
  634. </remarks>
  635. </member>
  636. <member name="F:log4net.Appender.AppenderSkeleton.m_threshold">
  637. <summary>
  638. The level threshold of this appender.
  639. </summary>
  640. <remarks>
  641. <para>
  642. There is no level threshold filtering by default.
  643. </para>
  644. <para>
  645. See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information.
  646. </para>
  647. </remarks>
  648. </member>
  649. <member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler">
  650. <summary>
  651. It is assumed and enforced that errorHandler is never null.
  652. </summary>
  653. <remarks>
  654. <para>
  655. It is assumed and enforced that errorHandler is never null.
  656. </para>
  657. <para>
  658. See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information.
  659. </para>
  660. </remarks>
  661. </member>
  662. <member name="F:log4net.Appender.AppenderSkeleton.m_headFilter">
  663. <summary>
  664. The first filter in the filter chain.
  665. </summary>
  666. <remarks>
  667. <para>
  668. Set to <c>null</c> initially.
  669. </para>
  670. <para>
  671. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  672. </para>
  673. </remarks>
  674. </member>
  675. <member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter">
  676. <summary>
  677. The last filter in the filter chain.
  678. </summary>
  679. <remarks>
  680. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  681. </remarks>
  682. </member>
  683. <member name="F:log4net.Appender.AppenderSkeleton.m_closed">
  684. <summary>
  685. Flag indicating if this appender is closed.
  686. </summary>
  687. <remarks>
  688. See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information.
  689. </remarks>
  690. </member>
  691. <member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard">
  692. <summary>
  693. The guard prevents an appender from repeatedly calling its own DoAppend method
  694. </summary>
  695. </member>
  696. <member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter">
  697. <summary>
  698. StringWriter used to render events
  699. </summary>
  700. </member>
  701. <member name="P:log4net.Appender.AppenderSkeleton.Threshold">
  702. <summary>
  703. Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender.
  704. </summary>
  705. <value>
  706. The threshold <see cref="T:log4net.Core.Level"/> of the appender.
  707. </value>
  708. <remarks>
  709. <para>
  710. All log events with lower level than the threshold level are ignored
  711. by the appender.
  712. </para>
  713. <para>
  714. In configuration files this option is specified by setting the
  715. value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level
  716. string, such as "DEBUG", "INFO" and so on.
  717. </para>
  718. </remarks>
  719. </member>
  720. <member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler">
  721. <summary>
  722. Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  723. </summary>
  724. <value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value>
  725. <remarks>
  726. <para>
  727. The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default
  728. implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property.
  729. </para>
  730. </remarks>
  731. </member>
  732. <member name="P:log4net.Appender.AppenderSkeleton.FilterHead">
  733. <summary>
  734. The filter chain.
  735. </summary>
  736. <value>The head of the filter chain filter chain.</value>
  737. <remarks>
  738. <para>
  739. Returns the head Filter. The Filters are organized in a linked list
  740. and so all Filters on this Appender are available through the result.
  741. </para>
  742. </remarks>
  743. </member>
  744. <member name="P:log4net.Appender.AppenderSkeleton.Layout">
  745. <summary>
  746. Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender.
  747. </summary>
  748. <value>The layout of the appender.</value>
  749. <remarks>
  750. <para>
  751. See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information.
  752. </para>
  753. </remarks>
  754. <seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/>
  755. </member>
  756. <member name="P:log4net.Appender.AppenderSkeleton.Name">
  757. <summary>
  758. Gets or sets the name of this appender.
  759. </summary>
  760. <value>The name of the appender.</value>
  761. <remarks>
  762. <para>
  763. The name uniquely identifies the appender.
  764. </para>
  765. </remarks>
  766. </member>
  767. <member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout">
  768. <summary>
  769. Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  770. </summary>
  771. <remarks>
  772. <para>
  773. In the rather exceptional case, where the appender
  774. implementation admits a layout but can also work without it,
  775. then the appender should return <c>true</c>.
  776. </para>
  777. <para>
  778. This default implementation always returns <c>true</c>.
  779. </para>
  780. </remarks>
  781. <returns>
  782. <c>true</c> if the appender requires a layout object, otherwise <c>false</c>.
  783. </returns>
  784. </member>
  785. <member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE">
  786. <summary>
  787. The default buffer size.
  788. </summary>
  789. <remarks>
  790. The default size of the cyclic buffer used to store events.
  791. This is set to 512 by default.
  792. </remarks>
  793. </member>
  794. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor">
  795. <summary>
  796. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
  797. </summary>
  798. <remarks>
  799. <para>
  800. Protected default constructor to allow subclassing.
  801. </para>
  802. </remarks>
  803. </member>
  804. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)">
  805. <summary>
  806. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
  807. </summary>
  808. <param name="eventMustBeFixed">the events passed through this appender must be
  809. fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param>
  810. <remarks>
  811. <para>
  812. Protected constructor to allow subclassing.
  813. </para>
  814. <para>
  815. The <paramref name="eventMustBeFixed"/> should be set if the subclass
  816. expects the events delivered to be fixed even if the
  817. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs.
  818. </para>
  819. </remarks>
  820. </member>
  821. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush">
  822. <summary>
  823. Flush the currently buffered events
  824. </summary>
  825. <remarks>
  826. <para>
  827. Flushes any events that have been buffered.
  828. </para>
  829. <para>
  830. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  831. of the buffer will NOT be flushed to the appender.
  832. </para>
  833. </remarks>
  834. </member>
  835. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)">
  836. <summary>
  837. Flush the currently buffered events
  838. </summary>
  839. <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param>
  840. <remarks>
  841. <para>
  842. Flushes events that have been buffered. If <paramref name="flushLossyBuffer"/> is
  843. <c>false</c> then events will only be flushed if this buffer is non-lossy mode.
  844. </para>
  845. <para>
  846. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  847. of the buffer will only be flushed if <paramref name="flushLossyBuffer"/> is <c>true</c>.
  848. In this case the contents of the buffer will be tested against the
  849. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered
  850. events will be discarded.
  851. </para>
  852. <para>
  853. If <paramref name="flushLossyBuffer"/> is <c>true</c> then the buffer will always
  854. be emptied by calling this method.
  855. </para>
  856. </remarks>
  857. </member>
  858. <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
  859. <summary>
  860. Initialize the appender based on the options set
  861. </summary>
  862. <remarks>
  863. <para>
  864. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  865. activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must
  866. be called on this object after the configuration properties have
  867. been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this
  868. object is in an undefined state and must not be used.
  869. </para>
  870. <para>
  871. If any of the configuration properties are modified then
  872. <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again.
  873. </para>
  874. </remarks>
  875. </member>
  876. <member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose">
  877. <summary>
  878. Close this appender instance.
  879. </summary>
  880. <remarks>
  881. <para>
  882. Close this appender instance. If this appender is marked
  883. as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
  884. the buffer must be sent when the appender is closed.
  885. </para>
  886. </remarks>
  887. </member>
  888. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  889. <summary>
  890. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  891. </summary>
  892. <param name="loggingEvent">the event to log</param>
  893. <remarks>
  894. <para>
  895. Stores the <paramref name="loggingEvent"/> in the cyclic buffer.
  896. </para>
  897. <para>
  898. The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>
  899. method) if one of the following conditions is met:
  900. </para>
  901. <list type="bullet">
  902. <item>
  903. <description>The cyclic buffer is full and this appender is
  904. marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description>
  905. </item>
  906. <item>
  907. <description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and
  908. it is triggered for the <paramref name="loggingEvent"/>
  909. specified.</description>
  910. </item>
  911. </list>
  912. <para>
  913. Before the event is stored in the buffer it is fixed
  914. (see <see cref="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)"/>) to ensure that
  915. any data referenced by the event will be valid when the buffer
  916. is processed.
  917. </para>
  918. </remarks>
  919. </member>
  920. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)">
  921. <summary>
  922. Sends the contents of the buffer.
  923. </summary>
  924. <param name="firstLoggingEvent">The first logging event.</param>
  925. <param name="buffer">The buffer containing the events that need to be send.</param>
  926. <remarks>
  927. <para>
  928. The subclass must override <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>.
  929. </para>
  930. </remarks>
  931. </member>
  932. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])">
  933. <summary>
  934. Sends the events.
  935. </summary>
  936. <param name="events">The events that need to be send.</param>
  937. <remarks>
  938. <para>
  939. The subclass must override this method to process the buffered events.
  940. </para>
  941. </remarks>
  942. </member>
  943. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
  944. <summary>
  945. The size of the cyclic buffer used to hold the logging events.
  946. </summary>
  947. <remarks>
  948. Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default.
  949. </remarks>
  950. </member>
  951. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb">
  952. <summary>
  953. The cyclic buffer used to store the logging events.
  954. </summary>
  955. </member>
  956. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator">
  957. <summary>
  958. The triggering event evaluator that causes the buffer to be sent immediately.
  959. </summary>
  960. <remarks>
  961. The object that is used to determine if an event causes the entire
  962. buffer to be sent immediately. This field can be <c>null</c>, which
  963. indicates that event triggering is not to be done. The evaluator
  964. can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender
  965. has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to
  966. <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set.
  967. </remarks>
  968. </member>
  969. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy">
  970. <summary>
  971. Indicates if the appender should overwrite events in the cyclic buffer
  972. when it becomes full, or if the buffer should be flushed when the
  973. buffer is full.
  974. </summary>
  975. <remarks>
  976. If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must
  977. be set.
  978. </remarks>
  979. </member>
  980. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator">
  981. <summary>
  982. The triggering event evaluator filters discarded events.
  983. </summary>
  984. <remarks>
  985. The object that is used to determine if an event that is discarded should
  986. really be discarded or if it should be sent to the appenders.
  987. This field can be <c>null</c>, which indicates that all discarded events will
  988. be discarded.
  989. </remarks>
  990. </member>
  991. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags">
  992. <summary>
  993. Value indicating which fields in the event should be fixed
  994. </summary>
  995. <remarks>
  996. By default all fields are fixed
  997. </remarks>
  998. </member>
  999. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed">
  1000. <summary>
  1001. The events delivered to the subclass must be fixed.
  1002. </summary>
  1003. </member>
  1004. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy">
  1005. <summary>
  1006. Gets or sets a value that indicates whether the appender is lossy.
  1007. </summary>
  1008. <value>
  1009. <c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>.
  1010. </value>
  1011. <remarks>
  1012. <para>
  1013. This appender uses a buffer to store logging events before
  1014. delivering them. A triggering event causes the whole buffer
  1015. to be send to the remote sink. If the buffer overruns before
  1016. a triggering event then logging events could be lost. Set
  1017. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events
  1018. from being lost.
  1019. </para>
  1020. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  1021. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  1022. </remarks>
  1023. </member>
  1024. <member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize">
  1025. <summary>
  1026. Gets or sets the size of the cyclic buffer used to hold the
  1027. logging events.
  1028. </summary>
  1029. <value>
  1030. The size of the cyclic buffer used to hold the logging events.
  1031. </value>
  1032. <remarks>
  1033. <para>
  1034. The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer
  1035. representing the maximum number of logging events to collect in
  1036. a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached,
  1037. oldest events are deleted as new events are added to the
  1038. buffer. By default the size of the cyclic buffer is 512 events.
  1039. </para>
  1040. <para>
  1041. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than
  1042. or equal to 1 then no buffering will occur. The logging event
  1043. will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>
  1044. and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will
  1045. be buffered.
  1046. </para>
  1047. </remarks>
  1048. </member>
  1049. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator">
  1050. <summary>
  1051. Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the
  1052. buffer to be sent immediately.
  1053. </summary>
  1054. <value>
  1055. The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be
  1056. sent immediately.
  1057. </value>
  1058. <remarks>
  1059. <para>
  1060. The evaluator will be called for each event that is appended to this
  1061. appender. If the evaluator triggers then the current buffer will
  1062. immediately be sent (see <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>).
  1063. </para>
  1064. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  1065. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  1066. </remarks>
  1067. </member>
  1068. <member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator">
  1069. <summary>
  1070. Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  1071. </summary>
  1072. <value>
  1073. The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  1074. </value>
  1075. <remarks>
  1076. <para>
  1077. The evaluator will be called for each event that is discarded from this
  1078. appender. If the evaluator triggers then the current buffer will immediately
  1079. be sent (see <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>).
  1080. </para>
  1081. </remarks>
  1082. </member>
  1083. <member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData">
  1084. <summary>
  1085. Gets or sets a value indicating if only part of the logging event data
  1086. should be fixed.
  1087. </summary>
  1088. <value>
  1089. <c>true</c> if the appender should only fix part of the logging event
  1090. data, otherwise <c>false</c>. The default is <c>false</c>.
  1091. </value>
  1092. <remarks>
  1093. <para>
  1094. Setting this property to <c>true</c> will cause only part of the
  1095. event data to be fixed and serialized. This will improve performance.
  1096. </para>
  1097. <para>
  1098. See <see cref="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)"/> for more information.
  1099. </para>
  1100. </remarks>
  1101. </member>
  1102. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix">
  1103. <summary>
  1104. Gets or sets a the fields that will be fixed in the event
  1105. </summary>
  1106. <value>
  1107. The event fields that will be fixed before the event is buffered
  1108. </value>
  1109. <remarks>
  1110. <para>
  1111. The logging event needs to have certain thread specific values
  1112. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  1113. for details.
  1114. </para>
  1115. </remarks>
  1116. <seealso cref="P:log4net.Core.LoggingEvent.Fix"/>
  1117. </member>
  1118. <member name="M:log4net.Appender.AdoNetAppender.#ctor">
  1119. <summary>
  1120. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppender"/> class.
  1121. </summary>
  1122. <remarks>
  1123. Public default constructor to initialize a new instance of this class.
  1124. </remarks>
  1125. </member>
  1126. <member name="M:log4net.Appender.AdoNetAppender.ActivateOptions">
  1127. <summary>
  1128. Initialize the appender based on the options set
  1129. </summary>
  1130. <remarks>
  1131. <para>
  1132. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  1133. activation scheme. The <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> method must
  1134. be called on this object after the configuration properties have
  1135. been set. Until <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> is called this
  1136. object is in an undefined state and must not be used.
  1137. </para>
  1138. <para>
  1139. If any of the configuration properties are modified then
  1140. <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> must be called again.
  1141. </para>
  1142. </remarks>
  1143. </member>
  1144. <member name="M:log4net.Appender.AdoNetAppender.OnClose">
  1145. <summary>
  1146. Override the parent method to close the database
  1147. </summary>
  1148. <remarks>
  1149. <para>
  1150. Closes the database command and database connection.
  1151. </para>
  1152. </remarks>
  1153. </member>
  1154. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  1155. <summary>
  1156. Inserts the events into the database.
  1157. </summary>
  1158. <param name="events">The events to insert into the database.</param>
  1159. <remarks>
  1160. <para>
  1161. Insert all the events specified in the <paramref name="events"/>
  1162. array into the database.
  1163. </para>
  1164. </remarks>
  1165. </member>
  1166. <member name="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)">
  1167. <summary>
  1168. Adds a parameter to the command.
  1169. </summary>
  1170. <param name="parameter">The parameter to add to the command.</param>
  1171. <remarks>
  1172. <para>
  1173. Adds a parameter to the ordered list of command parameters.
  1174. </para>
  1175. </remarks>
  1176. </member>
  1177. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(System.Data.IDbTransaction,log4net.Core.LoggingEvent[])">
  1178. <summary>
  1179. Writes the events to the database using the transaction specified.
  1180. </summary>
  1181. <param name="dbTran">The transaction that the events will be executed under.</param>
  1182. <param name="events">The array of events to insert into the database.</param>
  1183. <remarks>
  1184. <para>
  1185. The transaction argument can be <c>null</c> if the appender has been
  1186. configured not to use transactions. See <see cref="P:log4net.Appender.AdoNetAppender.UseTransactions"/>
  1187. property for more information.
  1188. </para>
  1189. </remarks>
  1190. </member>
  1191. <member name="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)">
  1192. <summary>
  1193. Formats the log message into database statement text.
  1194. </summary>
  1195. <param name="logEvent">The event being logged.</param>
  1196. <remarks>
  1197. This method can be overridden by subclasses to provide
  1198. more control over the format of the database statement.
  1199. </remarks>
  1200. <returns>
  1201. Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>.
  1202. </returns>
  1203. </member>
  1204. <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection">
  1205. <summary>
  1206. Connects to the database.
  1207. </summary>
  1208. </member>
  1209. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType">
  1210. <summary>
  1211. Retrieves the class type of the ADO.NET provider.
  1212. </summary>
  1213. <remarks>
  1214. <para>
  1215. Gets the Type of the ADO.NET provider to use to connect to the
  1216. database. This method resolves the type specified in the
  1217. <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property.
  1218. </para>
  1219. <para>
  1220. Subclasses can override this method to return a different type
  1221. if necessary.
  1222. </para>
  1223. </remarks>
  1224. <returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns>
  1225. </member>
  1226. <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseCommand">
  1227. <summary>
  1228. Prepares the database command and initialize the parameters.
  1229. </summary>
  1230. </member>
  1231. <member name="F:log4net.Appender.AdoNetAppender.m_usePreparedCommand">
  1232. <summary>
  1233. Flag to indicate if we are using a command object
  1234. </summary>
  1235. <remarks>
  1236. <para>
  1237. Set to <c>true</c> when the appender is to use a prepared
  1238. statement or stored procedure to insert into the database.
  1239. </para>
  1240. </remarks>
  1241. </member>
  1242. <member name="F:log4net.Appender.AdoNetAppender.m_parameters">
  1243. <summary>
  1244. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  1245. </summary>
  1246. <remarks>
  1247. <para>
  1248. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  1249. </para>
  1250. </remarks>
  1251. </member>
  1252. <member name="F:log4net.Appender.AdoNetAppender.m_securityContext">
  1253. <summary>
  1254. The security context to use for privileged calls
  1255. </summary>
  1256. </member>
  1257. <member name="F:log4net.Appender.AdoNetAppender.m_dbConnection">
  1258. <summary>
  1259. The <see cref="T:System.Data.IDbConnection"/> that will be used
  1260. to insert logging events into a database.
  1261. </summary>
  1262. </member>
  1263. <member name="F:log4net.Appender.AdoNetAppender.m_dbCommand">
  1264. <summary>
  1265. The database command.
  1266. </summary>
  1267. </member>
  1268. <member name="F:log4net.Appender.AdoNetAppender.m_connectionString">
  1269. <summary>
  1270. Database connection string.
  1271. </summary>
  1272. </member>
  1273. <member name="F:log4net.Appender.AdoNetAppender.m_connectionType">
  1274. <summary>
  1275. String type name of the <see cref="T:System.Data.IDbConnection"/> type name.
  1276. </summary>
  1277. </member>
  1278. <member name="F:log4net.Appender.AdoNetAppender.m_commandText">
  1279. <summary>
  1280. The text of the command.
  1281. </summary>
  1282. </member>
  1283. <member name="F:log4net.Appender.AdoNetAppender.m_commandType">
  1284. <summary>
  1285. The command type.
  1286. </summary>
  1287. </member>
  1288. <member name="F:log4net.Appender.AdoNetAppender.m_useTransactions">
  1289. <summary>
  1290. Indicates whether to use transactions when writing to the database.
  1291. </summary>
  1292. </member>
  1293. <member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError">
  1294. <summary>
  1295. Indicates whether to use transactions when writing to the database.
  1296. </summary>
  1297. </member>
  1298. <member name="P:log4net.Appender.AdoNetAppender.ConnectionString">
  1299. <summary>
  1300. Gets or sets the database connection string that is used to connect to
  1301. the database.
  1302. </summary>
  1303. <value>
  1304. The database connection string used to connect to the database.
  1305. </value>
  1306. <remarks>
  1307. <para>
  1308. The connections string is specific to the connection type.
  1309. See <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> for more information.
  1310. </para>
  1311. </remarks>
  1312. <example>Connection string for MS Access via ODBC:
  1313. <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>
  1314. </example>
  1315. <example>Another connection string for MS Access via ODBC:
  1316. <code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"</code>
  1317. </example>
  1318. <example>Connection string for MS Access via OLE DB:
  1319. <code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"</code>
  1320. </example>
  1321. </member>
  1322. <member name="P:log4net.Appender.AdoNetAppender.ConnectionType">
  1323. <summary>
  1324. Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection
  1325. that should be created.
  1326. </summary>
  1327. <value>
  1328. The type name of the <see cref="T:System.Data.IDbConnection"/> connection.
  1329. </value>
  1330. <remarks>
  1331. <para>
  1332. The type name of the ADO.NET provider to use.
  1333. </para>
  1334. <para>
  1335. The default is to use the OLE DB provider.
  1336. </para>
  1337. </remarks>
  1338. <example>Use the OLE DB Provider. This is the default value.
  1339. <code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1340. </example>
  1341. <example>Use the MS SQL Server Provider.
  1342. <code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1343. </example>
  1344. <example>Use the ODBC Provider.
  1345. <code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code>
  1346. This is an optional package that you can download from
  1347. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  1348. search for <b>ODBC .NET Data Provider</b>.
  1349. </example>
  1350. <example>Use the Oracle Provider.
  1351. <code>System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1352. This is an optional package that you can download from
  1353. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  1354. search for <b>.NET Managed Provider for Oracle</b>.
  1355. </example>
  1356. </member>
  1357. <member name="P:log4net.Appender.AdoNetAppender.CommandText">
  1358. <summary>
  1359. Gets or sets the command text that is used to insert logging events
  1360. into the database.
  1361. </summary>
  1362. <value>
  1363. The command text used to insert logging events into the database.
  1364. </value>
  1365. <remarks>
  1366. <para>
  1367. Either the text of the prepared statement or the
  1368. name of the stored procedure to execute to write into
  1369. the database.
  1370. </para>
  1371. <para>
  1372. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property determines if
  1373. this text is a prepared statement or a stored procedure.
  1374. </para>
  1375. </remarks>
  1376. </member>
  1377. <member name="P:log4net.Appender.AdoNetAppender.CommandType">
  1378. <summary>
  1379. Gets or sets the command type to execute.
  1380. </summary>
  1381. <value>
  1382. The command type to execute.
  1383. </value>
  1384. <remarks>
  1385. <para>
  1386. This value may be either <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify
  1387. that the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> is a prepared statement to execute,
  1388. or <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify that the
  1389. <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property is the name of a stored procedure
  1390. to execute.
  1391. </para>
  1392. <para>
  1393. The default value is <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>).
  1394. </para>
  1395. </remarks>
  1396. </member>
  1397. <member name="P:log4net.Appender.AdoNetAppender.UseTransactions">
  1398. <summary>
  1399. Should transactions be used to insert logging events in the database.
  1400. </summary>
  1401. <value>
  1402. <c>true</c> if transactions should be used to insert logging events in
  1403. the database, otherwise <c>false</c>. The default value is <c>true</c>.
  1404. </value>
  1405. <remarks>
  1406. <para>
  1407. Gets or sets a value that indicates whether transactions should be used
  1408. to insert logging events in the database.
  1409. </para>
  1410. <para>
  1411. When set a single transaction will be used to insert the buffered events
  1412. into the database. Otherwise each event will be inserted without using
  1413. an explicit transaction.
  1414. </para>
  1415. </remarks>
  1416. </member>
  1417. <member name="P:log4net.Appender.AdoNetAppender.SecurityContext">
  1418. <summary>
  1419. Gets or sets the <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  1420. </summary>
  1421. <value>
  1422. The <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  1423. </value>
  1424. <remarks>
  1425. <para>
  1426. Unless a <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> specified here for this appender
  1427. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  1428. security context to use. The default behavior is to use the security context
  1429. of the current thread.
  1430. </para>
  1431. </remarks>
  1432. </member>
  1433. <member name="P:log4net.Appender.AdoNetAppender.ReconnectOnError">
  1434. <summary>
  1435. Should this appender try to reconnect to the database on error.
  1436. </summary>
  1437. <value>
  1438. <c>true</c> if the appender should try to reconnect to the database after an
  1439. error has occurred, otherwise <c>false</c>. The default value is <c>false</c>,
  1440. i.e. not to try to reconnect.
  1441. </value>
  1442. <remarks>
  1443. <para>
  1444. The default behaviour is for the appender not to try to reconnect to the
  1445. database if an error occurs. Subsequent logging events are discarded.
  1446. </para>
  1447. <para>
  1448. To force the appender to attempt to reconnect to the database set this
  1449. property to <c>true</c>.
  1450. </para>
  1451. <note>
  1452. When the appender attempts to connect to the database there may be a
  1453. delay of up to the connection timeout specified in the connection string.
  1454. This delay will block the calling application's thread.
  1455. Until the connection can be reestablished this potential delay may occur multiple times.
  1456. </note>
  1457. </remarks>
  1458. </member>
  1459. <member name="P:log4net.Appender.AdoNetAppender.Connection">
  1460. <summary>
  1461. Gets or sets the underlying <see cref="T:System.Data.IDbConnection"/>.
  1462. </summary>
  1463. <value>
  1464. The underlying <see cref="T:System.Data.IDbConnection"/>.
  1465. </value>
  1466. <remarks>
  1467. <see cref="T:log4net.Appender.AdoNetAppender"/> creates a <see cref="T:System.Data.IDbConnection"/> to insert
  1468. logging events into a database. Classes deriving from <see cref="T:log4net.Appender.AdoNetAppender"/>
  1469. can use this property to get or set this <see cref="T:System.Data.IDbConnection"/>. Use the
  1470. underlying <see cref="T:System.Data.IDbConnection"/> returned from <see cref="P:log4net.Appender.AdoNetAppender.Connection"/> if
  1471. you require access beyond that which <see cref="T:log4net.Appender.AdoNetAppender"/> provides.
  1472. </remarks>
  1473. </member>
  1474. <member name="T:log4net.Appender.AdoNetAppenderParameter">
  1475. <summary>
  1476. Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>.
  1477. </summary>
  1478. <remarks>
  1479. <para>
  1480. This class provides the basic database parameter properties
  1481. as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface.
  1482. </para>
  1483. <para>This type can be subclassed to provide database specific
  1484. functionality. The two methods that are called externally are
  1485. <see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>.
  1486. </para>
  1487. </remarks>
  1488. </member>
  1489. <member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor">
  1490. <summary>
  1491. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> class.
  1492. </summary>
  1493. <remarks>
  1494. Default constructor for the AdoNetAppenderParameter class.
  1495. </remarks>
  1496. </member>
  1497. <member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)">
  1498. <summary>
  1499. Prepare the specified database command object.
  1500. </summary>
  1501. <param name="command">The command to prepare.</param>
  1502. <remarks>
  1503. <para>
  1504. Prepares the database command object by adding
  1505. this parameter to its collection of parameters.
  1506. </para>
  1507. </remarks>
  1508. </member>
  1509. <member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)">
  1510. <summary>
  1511. Renders the logging event and set the parameter value in the command.
  1512. </summary>
  1513. <param name="command">The command containing the parameter.</param>
  1514. <param name="loggingEvent">The event to be rendered.</param>
  1515. <remarks>
  1516. <para>
  1517. Renders the logging event using this parameters layout
  1518. object. Sets the value of the parameter on the command object.
  1519. </para>
  1520. </remarks>
  1521. </member>
  1522. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName">
  1523. <summary>
  1524. The name of this parameter.
  1525. </summary>
  1526. </member>
  1527. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType">
  1528. <summary>
  1529. The database type for this parameter.
  1530. </summary>
  1531. </member>
  1532. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType">
  1533. <summary>
  1534. Flag to infer type rather than use the DbType
  1535. </summary>
  1536. </member>
  1537. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision">
  1538. <summary>
  1539. The precision for this parameter.
  1540. </summary>
  1541. </member>
  1542. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale">
  1543. <summary>
  1544. The scale for this parameter.
  1545. </summary>
  1546. </member>
  1547. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_size">
  1548. <summary>
  1549. The size for this parameter.
  1550. </summary>
  1551. </member>
  1552. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout">
  1553. <summary>
  1554. The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the
  1555. logging event into an object for this parameter.
  1556. </summary>
  1557. </member>
  1558. <member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName">
  1559. <summary>
  1560. Gets or sets the name of this parameter.
  1561. </summary>
  1562. <value>
  1563. The name of this parameter.
  1564. </value>
  1565. <remarks>
  1566. <para>
  1567. The name of this parameter. The parameter name
  1568. must match up to a named parameter to the SQL stored procedure
  1569. or prepared statement.
  1570. </para>
  1571. </remarks>
  1572. </member>
  1573. <member name="P:log4net.Appender.AdoNetAppenderParameter.DbType">
  1574. <summary>
  1575. Gets or sets the database type for this parameter.
  1576. </summary>
  1577. <value>
  1578. The database type for this parameter.
  1579. </value>
  1580. <remarks>
  1581. <para>
  1582. The database type for this parameter. This property should
  1583. be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/>
  1584. enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>.
  1585. </para>
  1586. <para>
  1587. This property is optional. If not specified the ADO.NET provider
  1588. will attempt to infer the type from the value.
  1589. </para>
  1590. </remarks>
  1591. <seealso cref="P:System.Data.IDataParameter.DbType"/>
  1592. </member>
  1593. <member name="P:log4net.Appender.AdoNetAppenderParameter.Precision">
  1594. <summary>
  1595. Gets or sets the precision for this parameter.
  1596. </summary>
  1597. <value>
  1598. The precision for this parameter.
  1599. </value>
  1600. <remarks>
  1601. <para>
  1602. The maximum number of digits used to represent the Value.
  1603. </para>
  1604. <para>
  1605. This property is optional. If not specified the ADO.NET provider
  1606. will attempt to infer the precision from the value.
  1607. </para>
  1608. </remarks>
  1609. <seealso cref="P:System.Data.IDbDataParameter.Precision"/>
  1610. </member>
  1611. <member name="P:log4net.Appender.AdoNetAppenderParameter.Scale">
  1612. <summary>
  1613. Gets or sets the scale for this parameter.
  1614. </summary>
  1615. <value>
  1616. The scale for this parameter.
  1617. </value>
  1618. <remarks>
  1619. <para>
  1620. The number of decimal places to which Value is resolved.
  1621. </para>
  1622. <para>
  1623. This property is optional. If not specified the ADO.NET provider
  1624. will attempt to infer the scale from the value.
  1625. </para>
  1626. </remarks>
  1627. <seealso cref="P:System.Data.IDbDataParameter.Scale"/>
  1628. </member>
  1629. <member name="P:log4net.Appender.AdoNetAppenderParameter.Size">
  1630. <summary>
  1631. Gets or sets the size for this parameter.
  1632. </summary>
  1633. <value>
  1634. The size for this parameter.
  1635. </value>
  1636. <remarks>
  1637. <para>
  1638. The maximum size, in bytes, of the data within the column.
  1639. </para>
  1640. <para>
  1641. This property is optional. If not specified the ADO.NET provider
  1642. will attempt to infer the size from the value.
  1643. </para>
  1644. </remarks>
  1645. <seealso cref="P:System.Data.IDbDataParameter.Size"/>
  1646. </member>
  1647. <member name="P:log4net.Appender.AdoNetAppenderParameter.Layout">
  1648. <summary>
  1649. Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to
  1650. render the logging event into an object for this
  1651. parameter.
  1652. </summary>
  1653. <value>
  1654. The <see cref="T:log4net.Layout.IRawLayout"/> used to render the
  1655. logging event into an object for this parameter.
  1656. </value>
  1657. <remarks>
  1658. <para>
  1659. The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this
  1660. parameter.
  1661. </para>
  1662. <para>
  1663. The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt
  1664. any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/>
  1665. for use in the property.
  1666. </para>
  1667. </remarks>
  1668. </member>
  1669. <member name="T:log4net.Appender.AnsiColorTerminalAppender">
  1670. <summary>
  1671. Appends logging events to the terminal using ANSI color escape sequences.
  1672. </summary>
  1673. <remarks>
  1674. <para>
  1675. AnsiColorTerminalAppender appends log events to the standard output stream
  1676. or the error output stream using a layout specified by the
  1677. user. It also allows the color of a specific level of message to be set.
  1678. </para>
  1679. <note>
  1680. This appender expects the terminal to understand the VT100 control set
  1681. in order to interpret the color codes. If the terminal or console does not
  1682. understand the control codes the behavior is not defined.
  1683. </note>
  1684. <para>
  1685. By default, all output is written to the console's standard output stream.
  1686. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the
  1687. error stream.
  1688. </para>
  1689. <para>
  1690. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  1691. <c>System.Console.Error</c> that is set at the time the event is appended.
  1692. Therefore it is possible to programmatically redirect the output of this appender
  1693. (for example NUnit does this to capture program output). While this is the desired
  1694. behavior of this appender it may have security implications in your application.
  1695. </para>
  1696. <para>
  1697. When configuring the ANSI colored terminal appender, a mapping should be
  1698. specified to map a logging level to a color. For example:
  1699. </para>
  1700. <code lang="XML" escaped="true">
  1701. <mapping>
  1702. <level value="ERROR"/>
  1703. <foreColor value="White"/>
  1704. <backColor value="Red"/>
  1705. <attributes value="Bright,Underscore"/>
  1706. </mapping>
  1707. <mapping>
  1708. <level value="DEBUG"/>
  1709. <backColor value="Green"/>
  1710. </mapping>
  1711. </code>
  1712. <para>
  1713. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  1714. of the following values:
  1715. <list type="bullet">
  1716. <item><term>Blue</term><description></description></item>
  1717. <item><term>Green</term><description></description></item>
  1718. <item><term>Red</term><description></description></item>
  1719. <item><term>White</term><description></description></item>
  1720. <item><term>Yellow</term><description></description></item>
  1721. <item><term>Purple</term><description></description></item>
  1722. <item><term>Cyan</term><description></description></item>
  1723. </list>
  1724. These color values cannot be combined together to make new colors.
  1725. </para>
  1726. <para>
  1727. The attributes can be any combination of the following:
  1728. <list type="bullet">
  1729. <item><term>Bright</term><description>foreground is brighter</description></item>
  1730. <item><term>Dim</term><description>foreground is dimmer</description></item>
  1731. <item><term>Underscore</term><description>message is underlined</description></item>
  1732. <item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item>
  1733. <item><term>Reverse</term><description>foreground and background are reversed</description></item>
  1734. <item><term>Hidden</term><description>output is hidden</description></item>
  1735. <item><term>Strikethrough</term><description>message has a line through it</description></item>
  1736. </list>
  1737. While any of these attributes may be combined together not all combinations
  1738. work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes
  1739. no sense.
  1740. </para>
  1741. </remarks>
  1742. <author>Patrick Wagstrom</author>
  1743. <author>Nicko Cadell</author>
  1744. </member>
  1745. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut">
  1746. <summary>
  1747. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1748. standard output stream.
  1749. </summary>
  1750. <remarks>
  1751. <para>
  1752. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1753. standard output stream.
  1754. </para>
  1755. </remarks>
  1756. </member>
  1757. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError">
  1758. <summary>
  1759. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1760. standard error output stream.
  1761. </summary>
  1762. <remarks>
  1763. <para>
  1764. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1765. standard error output stream.
  1766. </para>
  1767. </remarks>
  1768. </member>
  1769. <member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes">
  1770. <summary>
  1771. Ansi code to reset terminal
  1772. </summary>
  1773. </member>
  1774. <member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor">
  1775. <summary>
  1776. Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class.
  1777. </summary>
  1778. <remarks>
  1779. The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class is set up to write
  1780. to the standard output stream.
  1781. </remarks>
  1782. </member>
  1783. <member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)">
  1784. <summary>
  1785. Add a mapping of level to color
  1786. </summary>
  1787. <param name="mapping">The mapping to add</param>
  1788. <remarks>
  1789. <para>
  1790. Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender.
  1791. Each mapping defines the foreground and background colours
  1792. for a level.
  1793. </para>
  1794. </remarks>
  1795. </member>
  1796. <member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)">
  1797. <summary>
  1798. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  1799. </summary>
  1800. <param name="loggingEvent">The event to log.</param>
  1801. <remarks>
  1802. <para>
  1803. Writes the event to the console.
  1804. </para>
  1805. <para>
  1806. The format of the output will depend on the appender's layout.
  1807. </para>
  1808. </remarks>
  1809. </member>
  1810. <member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions">
  1811. <summary>
  1812. Initialize the options for this appender
  1813. </summary>
  1814. <remarks>
  1815. <para>
  1816. Initialize the level to color mappings set on this appender.
  1817. </para>
  1818. </remarks>
  1819. </member>
  1820. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream">
  1821. <summary>
  1822. Flag to write output to the error stream rather than the standard output stream
  1823. </summary>
  1824. </member>
  1825. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping">
  1826. <summary>
  1827. Mapping from level object to color value
  1828. </summary>
  1829. </member>
  1830. <member name="P:log4net.Appender.AnsiColorTerminalAppender.Target">
  1831. <summary>
  1832. Target is the value of the console output stream.
  1833. </summary>
  1834. <value>
  1835. Target is the value of the console output stream.
  1836. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  1837. </value>
  1838. <remarks>
  1839. <para>
  1840. Target is the value of the console output stream.
  1841. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  1842. </para>
  1843. </remarks>
  1844. </member>
  1845. <member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout">
  1846. <summary>
  1847. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  1848. </summary>
  1849. <value><c>true</c></value>
  1850. <remarks>
  1851. <para>
  1852. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  1853. </para>
  1854. </remarks>
  1855. </member>
  1856. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes">
  1857. <summary>
  1858. The enum of possible display attributes
  1859. </summary>
  1860. <remarks>
  1861. <para>
  1862. The following flags can be combined together to
  1863. form the ANSI color attributes.
  1864. </para>
  1865. </remarks>
  1866. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
  1867. </member>
  1868. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright">
  1869. <summary>
  1870. text is bright
  1871. </summary>
  1872. </member>
  1873. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim">
  1874. <summary>
  1875. text is dim
  1876. </summary>
  1877. </member>
  1878. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore">
  1879. <summary>
  1880. text is underlined
  1881. </summary>
  1882. </member>
  1883. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink">
  1884. <summary>
  1885. text is blinking
  1886. </summary>
  1887. <remarks>
  1888. Not all terminals support this attribute
  1889. </remarks>
  1890. </member>
  1891. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse">
  1892. <summary>
  1893. text and background colors are reversed
  1894. </summary>
  1895. </member>
  1896. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden">
  1897. <summary>
  1898. text is hidden
  1899. </summary>
  1900. </member>
  1901. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough">
  1902. <summary>
  1903. text is displayed with a strikethrough
  1904. </summary>
  1905. </member>
  1906. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor">
  1907. <summary>
  1908. The enum of possible foreground or background color values for
  1909. use with the color mapping method
  1910. </summary>
  1911. <remarks>
  1912. <para>
  1913. The output can be in one for the following ANSI colors.
  1914. </para>
  1915. </remarks>
  1916. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
  1917. </member>
  1918. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black">
  1919. <summary>
  1920. color is black
  1921. </summary>
  1922. </member>
  1923. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red">
  1924. <summary>
  1925. color is red
  1926. </summary>
  1927. </member>
  1928. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green">
  1929. <summary>
  1930. color is green
  1931. </summary>
  1932. </member>
  1933. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow">
  1934. <summary>
  1935. color is yellow
  1936. </summary>
  1937. </member>
  1938. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue">
  1939. <summary>
  1940. color is blue
  1941. </summary>
  1942. </member>
  1943. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta">
  1944. <summary>
  1945. color is magenta
  1946. </summary>
  1947. </member>
  1948. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan">
  1949. <summary>
  1950. color is cyan
  1951. </summary>
  1952. </member>
  1953. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White">
  1954. <summary>
  1955. color is white
  1956. </summary>
  1957. </member>
  1958. <member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors">
  1959. <summary>
  1960. A class to act as a mapping between the level that a logging call is made at and
  1961. the color it should be displayed as.
  1962. </summary>
  1963. <remarks>
  1964. <para>
  1965. Defines the mapping between a level and the color it should be displayed in.
  1966. </para>
  1967. </remarks>
  1968. </member>
  1969. <member name="T:log4net.Util.LevelMappingEntry">
  1970. <summary>
  1971. An entry in the <see cref="T:log4net.Util.LevelMapping"/>
  1972. </summary>
  1973. <remarks>
  1974. <para>
  1975. This is an abstract base class for types that are stored in the
  1976. <see cref="T:log4net.Util.LevelMapping"/> object.
  1977. </para>
  1978. </remarks>
  1979. <author>Nicko Cadell</author>
  1980. </member>
  1981. <member name="M:log4net.Util.LevelMappingEntry.#ctor">
  1982. <summary>
  1983. Default protected constructor
  1984. </summary>
  1985. <remarks>
  1986. <para>
  1987. Default protected constructor
  1988. </para>
  1989. </remarks>
  1990. </member>
  1991. <member name="M:log4net.Util.LevelMappingEntry.ActivateOptions">
  1992. <summary>
  1993. Initialize any options defined on this entry
  1994. </summary>
  1995. <remarks>
  1996. <para>
  1997. Should be overridden by any classes that need to initialise based on their options
  1998. </para>
  1999. </remarks>
  2000. </member>
  2001. <member name="P:log4net.Util.LevelMappingEntry.Level">
  2002. <summary>
  2003. The level that is the key for this mapping
  2004. </summary>
  2005. <value>
  2006. The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping
  2007. </value>
  2008. <remarks>
  2009. <para>
  2010. Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this
  2011. mapping subclass.
  2012. </para>
  2013. </remarks>
  2014. </member>
  2015. <member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions">
  2016. <summary>
  2017. Initialize the options for the object
  2018. </summary>
  2019. <remarks>
  2020. <para>
  2021. Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together
  2022. and append the attributes.
  2023. </para>
  2024. </remarks>
  2025. </member>
  2026. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor">
  2027. <summary>
  2028. The mapped foreground color for the specified level
  2029. </summary>
  2030. <remarks>
  2031. <para>
  2032. Required property.
  2033. The mapped foreground color for the specified level
  2034. </para>
  2035. </remarks>
  2036. </member>
  2037. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor">
  2038. <summary>
  2039. The mapped background color for the specified level
  2040. </summary>
  2041. <remarks>
  2042. <para>
  2043. Required property.
  2044. The mapped background color for the specified level
  2045. </para>
  2046. </remarks>
  2047. </member>
  2048. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes">
  2049. <summary>
  2050. The color attributes for the specified level
  2051. </summary>
  2052. <remarks>
  2053. <para>
  2054. Required property.
  2055. The color attributes for the specified level
  2056. </para>
  2057. </remarks>
  2058. </member>
  2059. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor">
  2060. <summary>
  2061. The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and
  2062. <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color.
  2063. </summary>
  2064. </member>
  2065. <member name="T:log4net.Appender.AppenderCollection">
  2066. <summary>
  2067. A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects.
  2068. </summary>
  2069. <author>Nicko Cadell</author>
  2070. </member>
  2071. <member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)">
  2072. <summary>
  2073. Creates a read-only wrapper for a <c>AppenderCollection</c> instance.
  2074. </summary>
  2075. <param name="list">list to create a readonly wrapper arround</param>
  2076. <returns>
  2077. An <c>AppenderCollection</c> wrapper that is read-only.
  2078. </returns>
  2079. </member>
  2080. <member name="F:log4net.Appender.AppenderCollection.EmptyCollection">
  2081. <summary>
  2082. An empty readonly static AppenderCollection
  2083. </summary>
  2084. </member>
  2085. <member name="M:log4net.Appender.AppenderCollection.#ctor">
  2086. <summary>
  2087. Initializes a new instance of the <c>AppenderCollection</c> class
  2088. that is empty and has the default initial capacity.
  2089. </summary>
  2090. </member>
  2091. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)">
  2092. <summary>
  2093. Initializes a new instance of the <c>AppenderCollection</c> class
  2094. that has the specified initial capacity.
  2095. </summary>
  2096. <param name="capacity">
  2097. The number of elements that the new <c>AppenderCollection</c> is initially capable of storing.
  2098. </param>
  2099. </member>
  2100. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)">
  2101. <summary>
  2102. Initializes a new instance of the <c>AppenderCollection</c> class
  2103. that contains elements copied from the specified <c>AppenderCollection</c>.
  2104. </summary>
  2105. <param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param>
  2106. </member>
  2107. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])">
  2108. <summary>
  2109. Initializes a new instance of the <c>AppenderCollection</c> class
  2110. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array.
  2111. </summary>
  2112. <param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param>
  2113. </member>
  2114. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)">
  2115. <summary>
  2116. Initializes a new instance of the <c>AppenderCollection</c> class
  2117. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection.
  2118. </summary>
  2119. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param>
  2120. </member>
  2121. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)">
  2122. <summary>
  2123. Allow subclasses to avoid our default constructors
  2124. </summary>
  2125. <param name="tag"></param>
  2126. <exclude/>
  2127. </member>
  2128. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])">
  2129. <summary>
  2130. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  2131. <see cref="T:log4net.Appender.IAppender"/> array.
  2132. </summary>
  2133. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  2134. </member>
  2135. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)">
  2136. <summary>
  2137. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  2138. <see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array.
  2139. </summary>
  2140. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  2141. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  2142. </member>
  2143. <member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)">
  2144. <summary>
  2145. Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>.
  2146. </summary>
  2147. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param>
  2148. <returns>The index at which the value has been added.</returns>
  2149. </member>
  2150. <member name="M:log4net.Appender.AppenderCollection.Clear">
  2151. <summary>
  2152. Removes all elements from the <c>AppenderCollection</c>.
  2153. </summary>
  2154. </member>
  2155. <member name="M:log4net.Appender.AppenderCollection.Clone">
  2156. <summary>
  2157. Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>.
  2158. </summary>
  2159. <returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns>
  2160. </member>
  2161. <member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)">
  2162. <summary>
  2163. Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>.
  2164. </summary>
  2165. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param>
  2166. <returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns>
  2167. </member>
  2168. <member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)">
  2169. <summary>
  2170. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/>
  2171. in the <c>AppenderCollection</c>.
  2172. </summary>
  2173. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param>
  2174. <returns>
  2175. The zero-based index of the first occurrence of <paramref name="item"/>
  2176. in the entire <c>AppenderCollection</c>, if found; otherwise, -1.
  2177. </returns>
  2178. </member>
  2179. <member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)">
  2180. <summary>
  2181. Inserts an element into the <c>AppenderCollection</c> at the specified index.
  2182. </summary>
  2183. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  2184. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param>
  2185. <exception cref="T:System.ArgumentOutOfRangeException">
  2186. <para><paramref name="index"/> is less than zero</para>
  2187. <para>-or-</para>
  2188. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2189. </exception>
  2190. </member>
  2191. <member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)">
  2192. <summary>
  2193. Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>.
  2194. </summary>
  2195. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param>
  2196. <exception cref="T:System.ArgumentException">
  2197. The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>.
  2198. </exception>
  2199. </member>
  2200. <member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)">
  2201. <summary>
  2202. Removes the element at the specified index of the <c>AppenderCollection</c>.
  2203. </summary>
  2204. <param name="index">The zero-based index of the element to remove.</param>
  2205. <exception cref="T:System.ArgumentOutOfRangeException">
  2206. <para><paramref name="index"/> is less than zero</para>
  2207. <para>-or-</para>
  2208. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2209. </exception>
  2210. </member>
  2211. <member name="M:log4net.Appender.AppenderCollection.GetEnumerator">
  2212. <summary>
  2213. Returns an enumerator that can iterate through the <c>AppenderCollection</c>.
  2214. </summary>
  2215. <returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns>
  2216. </member>
  2217. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)">
  2218. <summary>
  2219. Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>.
  2220. </summary>
  2221. <param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param>
  2222. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2223. </member>
  2224. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])">
  2225. <summary>
  2226. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>.
  2227. </summary>
  2228. <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>
  2229. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2230. </member>
  2231. <member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)">
  2232. <summary>
  2233. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>.
  2234. </summary>
  2235. <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>
  2236. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2237. </member>
  2238. <member name="M:log4net.Appender.AppenderCollection.TrimToSize">
  2239. <summary>
  2240. Sets the capacity to the actual number of elements.
  2241. </summary>
  2242. </member>
  2243. <member name="M:log4net.Appender.AppenderCollection.ToArray">
  2244. <summary>
  2245. Return the collection elements as an array
  2246. </summary>
  2247. <returns>the array</returns>
  2248. </member>
  2249. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)">
  2250. <exception cref="T:System.ArgumentOutOfRangeException">
  2251. <para><paramref name="index"/> is less than zero</para>
  2252. <para>-or-</para>
  2253. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2254. </exception>
  2255. </member>
  2256. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)">
  2257. <exception cref="T:System.ArgumentOutOfRangeException">
  2258. <para><paramref name="index"/> is less than zero</para>
  2259. <para>-or-</para>
  2260. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2261. </exception>
  2262. </member>
  2263. <member name="P:log4net.Appender.AppenderCollection.Count">
  2264. <summary>
  2265. Gets the number of elements actually contained in the <c>AppenderCollection</c>.
  2266. </summary>
  2267. </member>
  2268. <member name="P:log4net.Appender.AppenderCollection.IsSynchronized">
  2269. <summary>
  2270. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  2271. </summary>
  2272. <returns>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</returns>
  2273. </member>
  2274. <member name="P:log4net.Appender.AppenderCollection.SyncRoot">
  2275. <summary>
  2276. Gets an object that can be used to synchronize access to the collection.
  2277. </summary>
  2278. </member>
  2279. <member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)">
  2280. <summary>
  2281. Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index.
  2282. </summary>
  2283. <param name="index">The zero-based index of the element to get or set.</param>
  2284. <exception cref="T:System.ArgumentOutOfRangeException">
  2285. <para><paramref name="index"/> is less than zero</para>
  2286. <para>-or-</para>
  2287. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2288. </exception>
  2289. </member>
  2290. <member name="P:log4net.Appender.AppenderCollection.IsFixedSize">
  2291. <summary>
  2292. Gets a value indicating whether the collection has a fixed size.
  2293. </summary>
  2294. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  2295. </member>
  2296. <member name="P:log4net.Appender.AppenderCollection.IsReadOnly">
  2297. <summary>
  2298. Gets a value indicating whether the IList is read-only.
  2299. </summary>
  2300. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  2301. </member>
  2302. <member name="P:log4net.Appender.AppenderCollection.Capacity">
  2303. <summary>
  2304. Gets or sets the number of elements the <c>AppenderCollection</c> can contain.
  2305. </summary>
  2306. </member>
  2307. <member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator">
  2308. <summary>
  2309. Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  2310. </summary>
  2311. <exclude/>
  2312. </member>
  2313. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext">
  2314. <summary>
  2315. Advances the enumerator to the next element in the collection.
  2316. </summary>
  2317. <returns>
  2318. <c>true</c> if the enumerator was successfully advanced to the next element;
  2319. <c>false</c> if the enumerator has passed the end of the collection.
  2320. </returns>
  2321. <exception cref="T:System.InvalidOperationException">
  2322. The collection was modified after the enumerator was created.
  2323. </exception>
  2324. </member>
  2325. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset">
  2326. <summary>
  2327. Sets the enumerator to its initial position, before the first element in the collection.
  2328. </summary>
  2329. </member>
  2330. <member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current">
  2331. <summary>
  2332. Gets the current element in the collection.
  2333. </summary>
  2334. </member>
  2335. <member name="T:log4net.Appender.AppenderCollection.Tag">
  2336. <summary>
  2337. Type visible only to our subclasses
  2338. Used to access protected constructor
  2339. </summary>
  2340. <exclude/>
  2341. </member>
  2342. <member name="F:log4net.Appender.AppenderCollection.Tag.Default">
  2343. <summary>
  2344. A value
  2345. </summary>
  2346. </member>
  2347. <member name="T:log4net.Appender.AppenderCollection.Enumerator">
  2348. <summary>
  2349. Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  2350. </summary>
  2351. <exclude/>
  2352. </member>
  2353. <member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)">
  2354. <summary>
  2355. Initializes a new instance of the <c>Enumerator</c> class.
  2356. </summary>
  2357. <param name="tc"></param>
  2358. </member>
  2359. <member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext">
  2360. <summary>
  2361. Advances the enumerator to the next element in the collection.
  2362. </summary>
  2363. <returns>
  2364. <c>true</c> if the enumerator was successfully advanced to the next element;
  2365. <c>false</c> if the enumerator has passed the end of the collection.
  2366. </returns>
  2367. <exception cref="T:System.InvalidOperationException">
  2368. The collection was modified after the enumerator was created.
  2369. </exception>
  2370. </member>
  2371. <member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset">
  2372. <summary>
  2373. Sets the enumerator to its initial position, before the first element in the collection.
  2374. </summary>
  2375. </member>
  2376. <member name="P:log4net.Appender.AppenderCollection.Enumerator.Current">
  2377. <summary>
  2378. Gets the current element in the collection.
  2379. </summary>
  2380. </member>
  2381. <member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection">
  2382. <exclude/>
  2383. </member>
  2384. <member name="T:log4net.Appender.AspNetTraceAppender">
  2385. <summary>
  2386. <para>
  2387. Appends log events to the ASP.NET <see cref="T:System.Web.TraceContext"/> system.
  2388. </para>
  2389. </summary>
  2390. <remarks>
  2391. <para>
  2392. Diagnostic information and tracing messages that you specify are appended to the output
  2393. of the page that is sent to the requesting browser. Optionally, you can view this information
  2394. from a separate trace viewer (Trace.axd) that displays trace information for every page in a
  2395. given application.
  2396. </para>
  2397. <para>
  2398. Trace statements are processed and displayed only when tracing is enabled. You can control
  2399. whether tracing is displayed to a page, to the trace viewer, or both.
  2400. </para>
  2401. <para>
  2402. The logging event is passed to the <see cref="M:System.Web.TraceContext.Write(System.String)"/> or
  2403. <see cref="M:System.Web.TraceContext.Warn(System.String)"/> method depending on the level of the logging event.
  2404. </para>
  2405. </remarks>
  2406. <author>Nicko Cadell</author>
  2407. <author>Gert Driesen</author>
  2408. </member>
  2409. <member name="M:log4net.Appender.AspNetTraceAppender.#ctor">
  2410. <summary>
  2411. Initializes a new instance of the <see cref="T:log4net.Appender.AspNetTraceAppender"/> class.
  2412. </summary>
  2413. <remarks>
  2414. <para>
  2415. Default constructor.
  2416. </para>
  2417. </remarks>
  2418. </member>
  2419. <member name="M:log4net.Appender.AspNetTraceAppender.Append(log4net.Core.LoggingEvent)">
  2420. <summary>
  2421. Write the logging event to the ASP.NET trace
  2422. </summary>
  2423. <param name="loggingEvent">the event to log</param>
  2424. <remarks>
  2425. <para>
  2426. Write the logging event to the ASP.NET trace
  2427. <c>HttpContext.Current.Trace</c>
  2428. (<see cref="T:System.Web.TraceContext"/>).
  2429. </para>
  2430. </remarks>
  2431. </member>
  2432. <member name="P:log4net.Appender.AspNetTraceAppender.RequiresLayout">
  2433. <summary>
  2434. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2435. </summary>
  2436. <value><c>true</c></value>
  2437. <remarks>
  2438. <para>
  2439. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2440. </para>
  2441. </remarks>
  2442. </member>
  2443. <member name="T:log4net.Appender.BufferingForwardingAppender">
  2444. <summary>
  2445. Buffers events and then forwards them to attached appenders.
  2446. </summary>
  2447. <remarks>
  2448. <para>
  2449. The events are buffered in this appender until conditions are
  2450. met to allow the appender to deliver the events to the attached
  2451. appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the
  2452. conditions that cause the buffer to be sent.
  2453. </para>
  2454. <para>The forwarding appender can be used to specify different
  2455. thresholds and filters for the same appender at different locations
  2456. within the hierarchy.
  2457. </para>
  2458. </remarks>
  2459. <author>Nicko Cadell</author>
  2460. <author>Gert Driesen</author>
  2461. </member>
  2462. <member name="T:log4net.Core.IAppenderAttachable">
  2463. <summary>
  2464. Interface for attaching appenders to objects.
  2465. </summary>
  2466. <remarks>
  2467. <para>
  2468. Interface for attaching, removing and retrieving appenders.
  2469. </para>
  2470. </remarks>
  2471. <author>Nicko Cadell</author>
  2472. <author>Gert Driesen</author>
  2473. </member>
  2474. <member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)">
  2475. <summary>
  2476. Attaches an appender.
  2477. </summary>
  2478. <param name="appender">The appender to add.</param>
  2479. <remarks>
  2480. <para>
  2481. Add the specified appender. The implementation may
  2482. choose to allow or deny duplicate appenders.
  2483. </para>
  2484. </remarks>
  2485. </member>
  2486. <member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)">
  2487. <summary>
  2488. Gets an attached appender with the specified name.
  2489. </summary>
  2490. <param name="name">The name of the appender to get.</param>
  2491. <returns>
  2492. The appender with the name specified, or <c>null</c> if no appender with the
  2493. specified name is found.
  2494. </returns>
  2495. <remarks>
  2496. <para>
  2497. Returns an attached appender with the <paramref name="name"/> specified.
  2498. If no appender with the specified name is found <c>null</c> will be
  2499. returned.
  2500. </para>
  2501. </remarks>
  2502. </member>
  2503. <member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders">
  2504. <summary>
  2505. Removes all attached appenders.
  2506. </summary>
  2507. <remarks>
  2508. <para>
  2509. Removes and closes all attached appenders
  2510. </para>
  2511. </remarks>
  2512. </member>
  2513. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)">
  2514. <summary>
  2515. Removes the specified appender from the list of attached appenders.
  2516. </summary>
  2517. <param name="appender">The appender to remove.</param>
  2518. <returns>The appender removed from the list</returns>
  2519. <remarks>
  2520. <para>
  2521. The appender removed is not closed.
  2522. If you are discarding the appender you must call
  2523. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2524. </para>
  2525. </remarks>
  2526. </member>
  2527. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)">
  2528. <summary>
  2529. Removes the appender with the specified name from the list of appenders.
  2530. </summary>
  2531. <param name="name">The name of the appender to remove.</param>
  2532. <returns>The appender removed from the list</returns>
  2533. <remarks>
  2534. <para>
  2535. The appender removed is not closed.
  2536. If you are discarding the appender you must call
  2537. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2538. </para>
  2539. </remarks>
  2540. </member>
  2541. <member name="P:log4net.Core.IAppenderAttachable.Appenders">
  2542. <summary>
  2543. Gets all attached appenders.
  2544. </summary>
  2545. <value>
  2546. A collection of attached appenders.
  2547. </value>
  2548. <remarks>
  2549. <para>
  2550. Gets a collection of attached appenders.
  2551. If there are no attached appenders the
  2552. implementation should return an empty
  2553. collection rather than <c>null</c>.
  2554. </para>
  2555. </remarks>
  2556. </member>
  2557. <member name="M:log4net.Appender.BufferingForwardingAppender.#ctor">
  2558. <summary>
  2559. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender"/> class.
  2560. </summary>
  2561. <remarks>
  2562. <para>
  2563. Default constructor.
  2564. </para>
  2565. </remarks>
  2566. </member>
  2567. <member name="M:log4net.Appender.BufferingForwardingAppender.OnClose">
  2568. <summary>
  2569. Closes the appender and releases resources.
  2570. </summary>
  2571. <remarks>
  2572. <para>
  2573. Releases any resources allocated within the appender such as file handles,
  2574. network connections, etc.
  2575. </para>
  2576. <para>
  2577. It is a programming error to append to a closed appender.
  2578. </para>
  2579. </remarks>
  2580. </member>
  2581. <member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  2582. <summary>
  2583. Send the events.
  2584. </summary>
  2585. <param name="events">The events that need to be send.</param>
  2586. <remarks>
  2587. <para>
  2588. Forwards the events to the attached appenders.
  2589. </para>
  2590. </remarks>
  2591. </member>
  2592. <member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  2593. <summary>
  2594. Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
  2595. instance.
  2596. </summary>
  2597. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
  2598. <remarks>
  2599. <para>
  2600. If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
  2601. appenders, then it won't be added again.
  2602. </para>
  2603. </remarks>
  2604. </member>
  2605. <member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)">
  2606. <summary>
  2607. Looks for the appender with the specified name.
  2608. </summary>
  2609. <param name="name">The name of the appender to lookup.</param>
  2610. <returns>
  2611. The appender with the specified name, or <c>null</c>.
  2612. </returns>
  2613. <remarks>
  2614. <para>
  2615. Get the named appender attached to this buffering appender.
  2616. </para>
  2617. </remarks>
  2618. </member>
  2619. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders">
  2620. <summary>
  2621. Removes all previously added appenders from this appender.
  2622. </summary>
  2623. <remarks>
  2624. <para>
  2625. This is useful when re-reading configuration information.
  2626. </para>
  2627. </remarks>
  2628. </member>
  2629. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  2630. <summary>
  2631. Removes the specified appender from the list of appenders.
  2632. </summary>
  2633. <param name="appender">The appender to remove.</param>
  2634. <returns>The appender removed from the list</returns>
  2635. <remarks>
  2636. The appender removed is not closed.
  2637. If you are discarding the appender you must call
  2638. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2639. </remarks>
  2640. </member>
  2641. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)">
  2642. <summary>
  2643. Removes the appender with the specified name from the list of appenders.
  2644. </summary>
  2645. <param name="name">The name of the appender to remove.</param>
  2646. <returns>The appender removed from the list</returns>
  2647. <remarks>
  2648. The appender removed is not closed.
  2649. If you are discarding the appender you must call
  2650. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2651. </remarks>
  2652. </member>
  2653. <member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl">
  2654. <summary>
  2655. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  2656. </summary>
  2657. </member>
  2658. <member name="P:log4net.Appender.BufferingForwardingAppender.Appenders">
  2659. <summary>
  2660. Gets the appenders contained in this appender as an
  2661. <see cref="T:System.Collections.ICollection"/>.
  2662. </summary>
  2663. <remarks>
  2664. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  2665. is returned.
  2666. </remarks>
  2667. <returns>
  2668. A collection of the appenders in this appender.
  2669. </returns>
  2670. </member>
  2671. <member name="T:log4net.Appender.ColoredConsoleAppender">
  2672. <summary>
  2673. Appends logging events to the console.
  2674. </summary>
  2675. <remarks>
  2676. <para>
  2677. ColoredConsoleAppender appends log events to the standard output stream
  2678. or the error output stream using a layout specified by the
  2679. user. It also allows the color of a specific type of message to be set.
  2680. </para>
  2681. <para>
  2682. By default, all output is written to the console's standard output stream.
  2683. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> property can be set to direct the output to the
  2684. error stream.
  2685. </para>
  2686. <para>
  2687. NOTE: This appender writes directly to the application's attached console
  2688. not to the <c>System.Console.Out</c> or <c>System.Console.Error</c> <c>TextWriter</c>.
  2689. The <c>System.Console.Out</c> and <c>System.Console.Error</c> streams can be
  2690. programmatically redirected (for example NUnit does this to capture program output).
  2691. This appender will ignore these redirections because it needs to use Win32
  2692. API calls to colorize the output. To respect these redirections the <see cref="T:log4net.Appender.ConsoleAppender"/>
  2693. must be used.
  2694. </para>
  2695. <para>
  2696. When configuring the colored console appender, mapping should be
  2697. specified to map a logging level to a color. For example:
  2698. </para>
  2699. <code lang="XML" escaped="true">
  2700. <mapping>
  2701. <level value="ERROR"/>
  2702. <foreColor value="White"/>
  2703. <backColor value="Red, HighIntensity"/>
  2704. </mapping>
  2705. <mapping>
  2706. <level value="DEBUG"/>
  2707. <backColor value="Green"/>
  2708. </mapping>
  2709. </code>
  2710. <para>
  2711. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  2712. combination of the following values:
  2713. <list type="bullet">
  2714. <item><term>Blue</term><description></description></item>
  2715. <item><term>Green</term><description></description></item>
  2716. <item><term>Red</term><description></description></item>
  2717. <item><term>White</term><description></description></item>
  2718. <item><term>Yellow</term><description></description></item>
  2719. <item><term>Purple</term><description></description></item>
  2720. <item><term>Cyan</term><description></description></item>
  2721. <item><term>HighIntensity</term><description></description></item>
  2722. </list>
  2723. </para>
  2724. </remarks>
  2725. <author>Rick Hobbs</author>
  2726. <author>Nicko Cadell</author>
  2727. </member>
  2728. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleOut">
  2729. <summary>
  2730. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2731. standard output stream.
  2732. </summary>
  2733. <remarks>
  2734. <para>
  2735. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2736. standard output stream.
  2737. </para>
  2738. </remarks>
  2739. </member>
  2740. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleError">
  2741. <summary>
  2742. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2743. standard error output stream.
  2744. </summary>
  2745. <remarks>
  2746. <para>
  2747. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2748. standard error output stream.
  2749. </para>
  2750. </remarks>
  2751. </member>
  2752. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor">
  2753. <summary>
  2754. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class.
  2755. </summary>
  2756. <remarks>
  2757. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
  2758. to the standard output stream.
  2759. </remarks>
  2760. </member>
  2761. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout)">
  2762. <summary>
  2763. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
  2764. with the specified layout.
  2765. </summary>
  2766. <param name="layout">the layout to use for this appender</param>
  2767. <remarks>
  2768. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
  2769. to the standard output stream.
  2770. </remarks>
  2771. </member>
  2772. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  2773. <summary>
  2774. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
  2775. with the specified layout.
  2776. </summary>
  2777. <param name="layout">the layout to use for this appender</param>
  2778. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  2779. <remarks>
  2780. When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
  2781. the standard error output stream. Otherwise, output is written to the standard
  2782. output stream.
  2783. </remarks>
  2784. </member>
  2785. <member name="M:log4net.Appender.ColoredConsoleAppender.AddMapping(log4net.Appender.ColoredConsoleAppender.LevelColors)">
  2786. <summary>
  2787. Add a mapping of level to color - done by the config file
  2788. </summary>
  2789. <param name="mapping">The mapping to add</param>
  2790. <remarks>
  2791. <para>
  2792. Add a <see cref="T:log4net.Appender.ColoredConsoleAppender.LevelColors"/> mapping to this appender.
  2793. Each mapping defines the foreground and background colors
  2794. for a level.
  2795. </para>
  2796. </remarks>
  2797. </member>
  2798. <member name="M:log4net.Appender.ColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  2799. <summary>
  2800. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  2801. </summary>
  2802. <param name="loggingEvent">The event to log.</param>
  2803. <remarks>
  2804. <para>
  2805. Writes the event to the console.
  2806. </para>
  2807. <para>
  2808. The format of the output will depend on the appender's layout.
  2809. </para>
  2810. </remarks>
  2811. </member>
  2812. <member name="M:log4net.Appender.ColoredConsoleAppender.ActivateOptions">
  2813. <summary>
  2814. Initialize the options for this appender
  2815. </summary>
  2816. <remarks>
  2817. <para>
  2818. Initialize the level to color mappings set on this appender.
  2819. </para>
  2820. </remarks>
  2821. </member>
  2822. <member name="F:log4net.Appender.ColoredConsoleAppender.m_writeToErrorStream">
  2823. <summary>
  2824. Flag to write output to the error stream rather than the standard output stream
  2825. </summary>
  2826. </member>
  2827. <member name="F:log4net.Appender.ColoredConsoleAppender.m_levelMapping">
  2828. <summary>
  2829. Mapping from level object to color value
  2830. </summary>
  2831. </member>
  2832. <member name="F:log4net.Appender.ColoredConsoleAppender.m_consoleOutputWriter">
  2833. <summary>
  2834. The console output stream writer to write to
  2835. </summary>
  2836. <remarks>
  2837. <para>
  2838. This writer is not thread safe.
  2839. </para>
  2840. </remarks>
  2841. </member>
  2842. <member name="P:log4net.Appender.ColoredConsoleAppender.Target">
  2843. <summary>
  2844. Target is the value of the console output stream.
  2845. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2846. </summary>
  2847. <value>
  2848. Target is the value of the console output stream.
  2849. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2850. </value>
  2851. <remarks>
  2852. <para>
  2853. Target is the value of the console output stream.
  2854. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2855. </para>
  2856. </remarks>
  2857. </member>
  2858. <member name="P:log4net.Appender.ColoredConsoleAppender.RequiresLayout">
  2859. <summary>
  2860. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2861. </summary>
  2862. <value><c>true</c></value>
  2863. <remarks>
  2864. <para>
  2865. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2866. </para>
  2867. </remarks>
  2868. </member>
  2869. <member name="T:log4net.Appender.ColoredConsoleAppender.Colors">
  2870. <summary>
  2871. The enum of possible color values for use with the color mapping method
  2872. </summary>
  2873. <remarks>
  2874. <para>
  2875. The following flags can be combined together to
  2876. form the colors.
  2877. </para>
  2878. </remarks>
  2879. <seealso cref="T:log4net.Appender.ColoredConsoleAppender"/>
  2880. </member>
  2881. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Blue">
  2882. <summary>
  2883. color is blue
  2884. </summary>
  2885. </member>
  2886. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Green">
  2887. <summary>
  2888. color is green
  2889. </summary>
  2890. </member>
  2891. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Red">
  2892. <summary>
  2893. color is red
  2894. </summary>
  2895. </member>
  2896. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.White">
  2897. <summary>
  2898. color is white
  2899. </summary>
  2900. </member>
  2901. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Yellow">
  2902. <summary>
  2903. color is yellow
  2904. </summary>
  2905. </member>
  2906. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Purple">
  2907. <summary>
  2908. color is purple
  2909. </summary>
  2910. </member>
  2911. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Cyan">
  2912. <summary>
  2913. color is cyan
  2914. </summary>
  2915. </member>
  2916. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.HighIntensity">
  2917. <summary>
  2918. color is intensified
  2919. </summary>
  2920. </member>
  2921. <member name="T:log4net.Appender.ColoredConsoleAppender.LevelColors">
  2922. <summary>
  2923. A class to act as a mapping between the level that a logging call is made at and
  2924. the color it should be displayed as.
  2925. </summary>
  2926. <remarks>
  2927. <para>
  2928. Defines the mapping between a level and the color it should be displayed in.
  2929. </para>
  2930. </remarks>
  2931. </member>
  2932. <member name="M:log4net.Appender.ColoredConsoleAppender.LevelColors.ActivateOptions">
  2933. <summary>
  2934. Initialize the options for the object
  2935. </summary>
  2936. <remarks>
  2937. <para>
  2938. Combine the <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> together.
  2939. </para>
  2940. </remarks>
  2941. </member>
  2942. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor">
  2943. <summary>
  2944. The mapped foreground color for the specified level
  2945. </summary>
  2946. <remarks>
  2947. <para>
  2948. Required property.
  2949. The mapped foreground color for the specified level.
  2950. </para>
  2951. </remarks>
  2952. </member>
  2953. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor">
  2954. <summary>
  2955. The mapped background color for the specified level
  2956. </summary>
  2957. <remarks>
  2958. <para>
  2959. Required property.
  2960. The mapped background color for the specified level.
  2961. </para>
  2962. </remarks>
  2963. </member>
  2964. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.CombinedColor">
  2965. <summary>
  2966. The combined <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> suitable for
  2967. setting the console color.
  2968. </summary>
  2969. </member>
  2970. <member name="T:log4net.Appender.ConsoleAppender">
  2971. <summary>
  2972. Appends logging events to the console.
  2973. </summary>
  2974. <remarks>
  2975. <para>
  2976. ConsoleAppender appends log events to the standard output stream
  2977. or the error output stream using a layout specified by the
  2978. user.
  2979. </para>
  2980. <para>
  2981. By default, all output is written to the console's standard output stream.
  2982. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
  2983. error stream.
  2984. </para>
  2985. <para>
  2986. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  2987. <c>System.Console.Error</c> that is set at the time the event is appended.
  2988. Therefore it is possible to programmatically redirect the output of this appender
  2989. (for example NUnit does this to capture program output). While this is the desired
  2990. behavior of this appender it may have security implications in your application.
  2991. </para>
  2992. </remarks>
  2993. <author>Nicko Cadell</author>
  2994. <author>Gert Driesen</author>
  2995. </member>
  2996. <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
  2997. <summary>
  2998. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2999. standard output stream.
  3000. </summary>
  3001. <remarks>
  3002. <para>
  3003. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3004. standard output stream.
  3005. </para>
  3006. </remarks>
  3007. </member>
  3008. <member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
  3009. <summary>
  3010. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3011. standard error output stream.
  3012. </summary>
  3013. <remarks>
  3014. <para>
  3015. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3016. standard error output stream.
  3017. </para>
  3018. </remarks>
  3019. </member>
  3020. <member name="M:log4net.Appender.ConsoleAppender.#ctor">
  3021. <summary>
  3022. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class.
  3023. </summary>
  3024. <remarks>
  3025. The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
  3026. to the standard output stream.
  3027. </remarks>
  3028. </member>
  3029. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
  3030. <summary>
  3031. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
  3032. with the specified layout.
  3033. </summary>
  3034. <param name="layout">the layout to use for this appender</param>
  3035. <remarks>
  3036. The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
  3037. to the standard output stream.
  3038. </remarks>
  3039. </member>
  3040. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  3041. <summary>
  3042. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
  3043. with the specified layout.
  3044. </summary>
  3045. <param name="layout">the layout to use for this appender</param>
  3046. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  3047. <remarks>
  3048. When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
  3049. the standard error output stream. Otherwise, output is written to the standard
  3050. output stream.
  3051. </remarks>
  3052. </member>
  3053. <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
  3054. <summary>
  3055. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  3056. </summary>
  3057. <param name="loggingEvent">The event to log.</param>
  3058. <remarks>
  3059. <para>
  3060. Writes the event to the console.
  3061. </para>
  3062. <para>
  3063. The format of the output will depend on the appender's layout.
  3064. </para>
  3065. </remarks>
  3066. </member>
  3067. <member name="P:log4net.Appender.ConsoleAppender.Target">
  3068. <summary>
  3069. Target is the value of the console output stream.
  3070. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3071. </summary>
  3072. <value>
  3073. Target is the value of the console output stream.
  3074. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3075. </value>
  3076. <remarks>
  3077. <para>
  3078. Target is the value of the console output stream.
  3079. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3080. </para>
  3081. </remarks>
  3082. </member>
  3083. <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
  3084. <summary>
  3085. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3086. </summary>
  3087. <value><c>true</c></value>
  3088. <remarks>
  3089. <para>
  3090. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3091. </para>
  3092. </remarks>
  3093. </member>
  3094. <member name="T:log4net.Appender.DebugAppender">
  3095. <summary>
  3096. Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
  3097. </summary>
  3098. <remarks>
  3099. <para>
  3100. The application configuration file can be used to control what listeners
  3101. are actually used. See the MSDN documentation for the
  3102. <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
  3103. debug system.
  3104. </para>
  3105. <para>
  3106. Events are written using the <see cref="M:System.Diagnostics.Debug.Write(System.String,System.String)"/>
  3107. method. The event's logger name is passed as the value for the category name to the Write method.
  3108. </para>
  3109. </remarks>
  3110. <author>Nicko Cadell</author>
  3111. </member>
  3112. <member name="M:log4net.Appender.DebugAppender.#ctor">
  3113. <summary>
  3114. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>.
  3115. </summary>
  3116. <remarks>
  3117. <para>
  3118. Default constructor.
  3119. </para>
  3120. </remarks>
  3121. </member>
  3122. <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
  3123. <summary>
  3124. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>
  3125. with a specified layout.
  3126. </summary>
  3127. <param name="layout">The layout to use with this appender.</param>
  3128. <remarks>
  3129. <para>
  3130. Obsolete constructor.
  3131. </para>
  3132. </remarks>
  3133. </member>
  3134. <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
  3135. <summary>
  3136. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  3137. </summary>
  3138. <param name="loggingEvent">The event to log.</param>
  3139. <remarks>
  3140. <para>
  3141. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  3142. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/>
  3143. is called.
  3144. </para>
  3145. </remarks>
  3146. </member>
  3147. <member name="F:log4net.Appender.DebugAppender.m_immediateFlush">
  3148. <summary>
  3149. Immediate flush means that the underlying writer or output stream
  3150. will be flushed at the end of each append operation.
  3151. </summary>
  3152. <remarks>
  3153. <para>
  3154. Immediate flush is slower but ensures that each append request is
  3155. actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to
  3156. <c>false</c>, then there is a good chance that the last few
  3157. logs events are not actually written to persistent media if and
  3158. when the application crashes.
  3159. </para>
  3160. <para>
  3161. The default value is <c>true</c>.</para>
  3162. </remarks>
  3163. </member>
  3164. <member name="P:log4net.Appender.DebugAppender.ImmediateFlush">
  3165. <summary>
  3166. Gets or sets a value that indicates whether the appender will
  3167. flush at the end of each write.
  3168. </summary>
  3169. <remarks>
  3170. <para>The default behavior is to flush at the end of each
  3171. write. If the option is set to<c>false</c>, then the underlying
  3172. stream can defer writing to physical medium to a later time.
  3173. </para>
  3174. <para>
  3175. Avoiding the flush operation at the end of each append results
  3176. in a performance gain of 10 to 20 percent. However, there is safety
  3177. trade-off involved in skipping flushing. Indeed, when flushing is
  3178. skipped, then it is likely that the last few log events will not
  3179. be recorded on disk when the application exits. This is a high
  3180. price to pay even for a 20% performance gain.
  3181. </para>
  3182. </remarks>
  3183. </member>
  3184. <member name="P:log4net.Appender.DebugAppender.RequiresLayout">
  3185. <summary>
  3186. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3187. </summary>
  3188. <value><c>true</c></value>
  3189. <remarks>
  3190. <para>
  3191. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3192. </para>
  3193. </remarks>
  3194. </member>
  3195. <member name="T:log4net.Appender.EventLogAppender">
  3196. <summary>
  3197. Writes events to the system event log.
  3198. </summary>
  3199. <remarks>
  3200. <para>
  3201. The <c>EventID</c> of the event log entry can be
  3202. set using the <c>EventLogEventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3203. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3204. </para>
  3205. <para>
  3206. There is a limit of 32K characters for an event log message
  3207. </para>
  3208. <para>
  3209. When configuring the EventLogAppender a mapping can be
  3210. specified to map a logging level to an event log entry type. For example:
  3211. </para>
  3212. <code lang="XML">
  3213. &lt;mapping&gt;
  3214. &lt;level value="ERROR" /&gt;
  3215. &lt;eventLogEntryType value="Error" /&gt;
  3216. &lt;/mapping&gt;
  3217. &lt;mapping&gt;
  3218. &lt;level value="DEBUG" /&gt;
  3219. &lt;eventLogEntryType value="Information" /&gt;
  3220. &lt;/mapping&gt;
  3221. </code>
  3222. <para>
  3223. The Level is the standard log4net logging level and eventLogEntryType can be any value
  3224. from the <see cref="T:System.Diagnostics.EventLogEntryType"/> enum, i.e.:
  3225. <list type="bullet">
  3226. <item><term>Error</term><description>an error event</description></item>
  3227. <item><term>Warning</term><description>a warning event</description></item>
  3228. <item><term>Information</term><description>an informational event</description></item>
  3229. </list>
  3230. </para>
  3231. </remarks>
  3232. <author>Aspi Havewala</author>
  3233. <author>Douglas de la Torre</author>
  3234. <author>Nicko Cadell</author>
  3235. <author>Gert Driesen</author>
  3236. <author>Thomas Voss</author>
  3237. </member>
  3238. <member name="M:log4net.Appender.EventLogAppender.#ctor">
  3239. <summary>
  3240. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class.
  3241. </summary>
  3242. <remarks>
  3243. <para>
  3244. Default constructor.
  3245. </para>
  3246. </remarks>
  3247. </member>
  3248. <member name="M:log4net.Appender.EventLogAppender.#ctor(log4net.Layout.ILayout)">
  3249. <summary>
  3250. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class
  3251. with the specified <see cref="T:log4net.Layout.ILayout"/>.
  3252. </summary>
  3253. <param name="layout">The <see cref="T:log4net.Layout.ILayout"/> to use with this appender.</param>
  3254. <remarks>
  3255. <para>
  3256. Obsolete constructor.
  3257. </para>
  3258. </remarks>
  3259. </member>
  3260. <member name="M:log4net.Appender.EventLogAppender.AddMapping(log4net.Appender.EventLogAppender.Level2EventLogEntryType)">
  3261. <summary>
  3262. Add a mapping of level to <see cref="T:System.Diagnostics.EventLogEntryType"/> - done by the config file
  3263. </summary>
  3264. <param name="mapping">The mapping to add</param>
  3265. <remarks>
  3266. <para>
  3267. Add a <see cref="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"/> mapping to this appender.
  3268. Each mapping defines the event log entry type for a level.
  3269. </para>
  3270. </remarks>
  3271. </member>
  3272. <member name="M:log4net.Appender.EventLogAppender.ActivateOptions">
  3273. <summary>
  3274. Initialize the appender based on the options set
  3275. </summary>
  3276. <remarks>
  3277. <para>
  3278. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3279. activation scheme. The <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> method must
  3280. be called on this object after the configuration properties have
  3281. been set. Until <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> is called this
  3282. object is in an undefined state and must not be used.
  3283. </para>
  3284. <para>
  3285. If any of the configuration properties are modified then
  3286. <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> must be called again.
  3287. </para>
  3288. </remarks>
  3289. </member>
  3290. <member name="M:log4net.Appender.EventLogAppender.CreateEventSource(System.String,System.String,System.String)">
  3291. <summary>
  3292. Create an event log source
  3293. </summary>
  3294. <remarks>
  3295. Uses different API calls under NET_2_0
  3296. </remarks>
  3297. </member>
  3298. <member name="M:log4net.Appender.EventLogAppender.Append(log4net.Core.LoggingEvent)">
  3299. <summary>
  3300. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/>
  3301. method.
  3302. </summary>
  3303. <param name="loggingEvent">the event to log</param>
  3304. <remarks>
  3305. <para>Writes the event to the system event log using the
  3306. <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>.</para>
  3307. <para>If the event has an <c>EventID</c> property (see <see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3308. set then this integer will be used as the event log event id.</para>
  3309. <para>
  3310. There is a limit of 32K characters for an event log message
  3311. </para>
  3312. </remarks>
  3313. </member>
  3314. <member name="M:log4net.Appender.EventLogAppender.GetEntryType(log4net.Core.Level)">
  3315. <summary>
  3316. Get the equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="p"/>
  3317. </summary>
  3318. <param name="level">the Level to convert to an EventLogEntryType</param>
  3319. <returns>The equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="p"/></returns>
  3320. <remarks>
  3321. Because there are fewer applicable <see cref="T:System.Diagnostics.EventLogEntryType"/>
  3322. values to use in logging levels than there are in the
  3323. <see cref="T:log4net.Core.Level"/> this is a one way mapping. There is
  3324. a loss of information during the conversion.
  3325. </remarks>
  3326. </member>
  3327. <member name="F:log4net.Appender.EventLogAppender.m_logName">
  3328. <summary>
  3329. The log name is the section in the event logs where the messages
  3330. are stored.
  3331. </summary>
  3332. </member>
  3333. <member name="F:log4net.Appender.EventLogAppender.m_applicationName">
  3334. <summary>
  3335. Name of the application to use when logging. This appears in the
  3336. application column of the event log named by <see cref="F:log4net.Appender.EventLogAppender.m_logName"/>.
  3337. </summary>
  3338. </member>
  3339. <member name="F:log4net.Appender.EventLogAppender.m_machineName">
  3340. <summary>
  3341. The name of the machine which holds the event log. This is
  3342. currently only allowed to be '.' i.e. the current machine.
  3343. </summary>
  3344. </member>
  3345. <member name="F:log4net.Appender.EventLogAppender.m_levelMapping">
  3346. <summary>
  3347. Mapping from level object to EventLogEntryType
  3348. </summary>
  3349. </member>
  3350. <member name="F:log4net.Appender.EventLogAppender.m_securityContext">
  3351. <summary>
  3352. The security context to use for privileged calls
  3353. </summary>
  3354. </member>
  3355. <member name="P:log4net.Appender.EventLogAppender.LogName">
  3356. <summary>
  3357. The name of the log where messages will be stored.
  3358. </summary>
  3359. <value>
  3360. The string name of the log where messages will be stored.
  3361. </value>
  3362. <remarks>
  3363. <para>This is the name of the log as it appears in the Event Viewer
  3364. tree. The default value is to log into the <c>Application</c>
  3365. log, this is where most applications write their events. However
  3366. if you need a separate log for your application (or applications)
  3367. then you should set the <see cref="P:log4net.Appender.EventLogAppender.LogName"/> appropriately.</para>
  3368. <para>This should not be used to distinguish your event log messages
  3369. from those of other applications, the <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>
  3370. property should be used to distinguish events. This property should be
  3371. used to group together events into a single log.
  3372. </para>
  3373. </remarks>
  3374. </member>
  3375. <member name="P:log4net.Appender.EventLogAppender.ApplicationName">
  3376. <summary>
  3377. Property used to set the Application name. This appears in the
  3378. event logs when logging.
  3379. </summary>
  3380. <value>
  3381. The string used to distinguish events from different sources.
  3382. </value>
  3383. <remarks>
  3384. Sets the event log source property.
  3385. </remarks>
  3386. </member>
  3387. <member name="P:log4net.Appender.EventLogAppender.MachineName">
  3388. <summary>
  3389. This property is used to return the name of the computer to use
  3390. when accessing the event logs. Currently, this is the current
  3391. computer, denoted by a dot "."
  3392. </summary>
  3393. <value>
  3394. The string name of the machine holding the event log that
  3395. will be logged into.
  3396. </value>
  3397. <remarks>
  3398. This property cannot be changed. It is currently set to '.'
  3399. i.e. the local machine. This may be changed in future.
  3400. </remarks>
  3401. </member>
  3402. <member name="P:log4net.Appender.EventLogAppender.SecurityContext">
  3403. <summary>
  3404. Gets or sets the <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3405. </summary>
  3406. <value>
  3407. The <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3408. </value>
  3409. <remarks>
  3410. <para>
  3411. The system security context used to write to the EventLog.
  3412. </para>
  3413. <para>
  3414. Unless a <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> specified here for this appender
  3415. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  3416. security context to use. The default behavior is to use the security context
  3417. of the current thread.
  3418. </para>
  3419. </remarks>
  3420. </member>
  3421. <member name="P:log4net.Appender.EventLogAppender.RequiresLayout">
  3422. <summary>
  3423. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3424. </summary>
  3425. <value><c>true</c></value>
  3426. <remarks>
  3427. <para>
  3428. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3429. </para>
  3430. </remarks>
  3431. </member>
  3432. <member name="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType">
  3433. <summary>
  3434. A class to act as a mapping between the level that a logging call is made at and
  3435. the color it should be displayed as.
  3436. </summary>
  3437. <remarks>
  3438. <para>
  3439. Defines the mapping between a level and its event log entry type.
  3440. </para>
  3441. </remarks>
  3442. </member>
  3443. <member name="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType">
  3444. <summary>
  3445. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3446. </summary>
  3447. <remarks>
  3448. <para>
  3449. Required property.
  3450. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3451. </para>
  3452. </remarks>
  3453. </member>
  3454. <member name="T:log4net.Appender.FileAppender">
  3455. <summary>
  3456. Appends logging events to a file.
  3457. </summary>
  3458. <remarks>
  3459. <para>
  3460. Logging events are sent to the file specified by
  3461. the <see cref="P:log4net.Appender.FileAppender.File"/> property.
  3462. </para>
  3463. <para>
  3464. The file can be opened in either append or overwrite mode
  3465. by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property.
  3466. If the file path is relative it is taken as relative from
  3467. the application base directory. The file encoding can be
  3468. specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property.
  3469. </para>
  3470. <para>
  3471. The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  3472. values will be written each time the file is opened and closed
  3473. respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/>
  3474. then the file may contain multiple copies of the header and footer.
  3475. </para>
  3476. <para>
  3477. This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/>
  3478. is called. This will typically be during configuration.
  3479. If the file cannot be opened for writing the appender will attempt
  3480. to open the file again each time a message is logged to the appender.
  3481. If the file cannot be opened for writing when a message is logged then
  3482. the message will be discarded by this appender.
  3483. </para>
  3484. <para>
  3485. The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via
  3486. the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property.
  3487. The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>
  3488. is to obtain an exclusive write lock on the file until this appender is closed.
  3489. The alternative model, <see cref="T:log4net.Appender.FileAppender.MinimalLock"/>, only holds a
  3490. write lock while the appender is writing a logging event.
  3491. </para>
  3492. </remarks>
  3493. <author>Nicko Cadell</author>
  3494. <author>Gert Driesen</author>
  3495. <author>Rodrigo B. de Oliveira</author>
  3496. <author>Douglas de la Torre</author>
  3497. <author>Niall Daley</author>
  3498. </member>
  3499. <member name="T:log4net.Appender.TextWriterAppender">
  3500. <summary>
  3501. Sends logging events to a <see cref="T:System.IO.TextWriter"/>.
  3502. </summary>
  3503. <remarks>
  3504. <para>
  3505. An Appender that writes to a <see cref="T:System.IO.TextWriter"/>.
  3506. </para>
  3507. <para>
  3508. This appender may be used stand alone if initialized with an appropriate
  3509. writer, however it is typically used as a base class for an appender that
  3510. can open a <see cref="T:System.IO.TextWriter"/> to write to.
  3511. </para>
  3512. </remarks>
  3513. <author>Nicko Cadell</author>
  3514. <author>Gert Driesen</author>
  3515. <author>Douglas de la Torre</author>
  3516. </member>
  3517. <member name="M:log4net.Appender.TextWriterAppender.#ctor">
  3518. <summary>
  3519. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class.
  3520. </summary>
  3521. <remarks>
  3522. <para>
  3523. Default constructor.
  3524. </para>
  3525. </remarks>
  3526. </member>
  3527. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)">
  3528. <summary>
  3529. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and
  3530. sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized
  3531. with the specified <see cref="T:System.IO.Stream"/>.
  3532. </summary>
  3533. <param name="layout">The layout to use with this appender.</param>
  3534. <param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param>
  3535. <remarks>
  3536. <para>
  3537. Obsolete constructor.
  3538. </para>
  3539. </remarks>
  3540. </member>
  3541. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)">
  3542. <summary>
  3543. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and sets
  3544. the output destination to the specified <see cref="T:System.IO.StreamWriter"/>.
  3545. </summary>
  3546. <param name="layout">The layout to use with this appender</param>
  3547. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to output to</param>
  3548. <remarks>
  3549. The <see cref="T:System.IO.TextWriter"/> must have been previously opened.
  3550. </remarks>
  3551. <remarks>
  3552. <para>
  3553. Obsolete constructor.
  3554. </para>
  3555. </remarks>
  3556. </member>
  3557. <member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck">
  3558. <summary>
  3559. This method determines if there is a sense in attempting to append.
  3560. </summary>
  3561. <remarks>
  3562. <para>
  3563. This method checked if an output target has been set and if a
  3564. layout has been set.
  3565. </para>
  3566. </remarks>
  3567. <returns><c>false</c> if any of the preconditions fail.</returns>
  3568. </member>
  3569. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)">
  3570. <summary>
  3571. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/>
  3572. method.
  3573. </summary>
  3574. <param name="loggingEvent">The event to log.</param>
  3575. <remarks>
  3576. <para>
  3577. Writes a log statement to the output stream if the output stream exists
  3578. and is writable.
  3579. </para>
  3580. <para>
  3581. The format of the output will depend on the appender's layout.
  3582. </para>
  3583. </remarks>
  3584. </member>
  3585. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])">
  3586. <summary>
  3587. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])"/>
  3588. method.
  3589. </summary>
  3590. <param name="loggingEvents">The array of events to log.</param>
  3591. <remarks>
  3592. <para>
  3593. This method writes all the bulk logged events to the output writer
  3594. before flushing the stream.
  3595. </para>
  3596. </remarks>
  3597. </member>
  3598. <member name="M:log4net.Appender.TextWriterAppender.OnClose">
  3599. <summary>
  3600. Close this appender instance. The underlying stream or writer is also closed.
  3601. </summary>
  3602. <remarks>
  3603. Closed appenders cannot be reused.
  3604. </remarks>
  3605. </member>
  3606. <member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter">
  3607. <summary>
  3608. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3609. </summary>
  3610. <remarks>
  3611. <para>
  3612. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3613. </para>
  3614. </remarks>
  3615. </member>
  3616. <member name="M:log4net.Appender.TextWriterAppender.CloseWriter">
  3617. <summary>
  3618. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3619. </summary>
  3620. <remarks>
  3621. <para>
  3622. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3623. </para>
  3624. </remarks>
  3625. </member>
  3626. <member name="M:log4net.Appender.TextWriterAppender.Reset">
  3627. <summary>
  3628. Clears internal references to the underlying <see cref="T:System.IO.TextWriter"/>
  3629. and other variables.
  3630. </summary>
  3631. <remarks>
  3632. <para>
  3633. Subclasses can override this method for an alternate closing behavior.
  3634. </para>
  3635. </remarks>
  3636. </member>
  3637. <member name="M:log4net.Appender.TextWriterAppender.WriteFooter">
  3638. <summary>
  3639. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3640. </summary>
  3641. <remarks>
  3642. <para>
  3643. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3644. </para>
  3645. </remarks>
  3646. </member>
  3647. <member name="M:log4net.Appender.TextWriterAppender.WriteHeader">
  3648. <summary>
  3649. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3650. </summary>
  3651. <remarks>
  3652. <para>
  3653. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3654. </para>
  3655. </remarks>
  3656. </member>
  3657. <member name="M:log4net.Appender.TextWriterAppender.PrepareWriter">
  3658. <summary>
  3659. Called to allow a subclass to lazily initialize the writer
  3660. </summary>
  3661. <remarks>
  3662. <para>
  3663. This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or
  3664. <see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to
  3665. attempt to initialize the writer multiple times.
  3666. </para>
  3667. </remarks>
  3668. </member>
  3669. <member name="F:log4net.Appender.TextWriterAppender.m_qtw">
  3670. <summary>
  3671. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  3672. will be written to.
  3673. </summary>
  3674. </member>
  3675. <member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush">
  3676. <summary>
  3677. Immediate flush means that the underlying <see cref="T:System.IO.TextWriter"/>
  3678. or output stream will be flushed at the end of each append operation.
  3679. </summary>
  3680. <remarks>
  3681. <para>
  3682. Immediate flush is slower but ensures that each append request is
  3683. actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to
  3684. <c>false</c>, then there is a good chance that the last few
  3685. logging events are not actually persisted if and when the application
  3686. crashes.
  3687. </para>
  3688. <para>
  3689. The default value is <c>true</c>.
  3690. </para>
  3691. </remarks>
  3692. </member>
  3693. <member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush">
  3694. <summary>
  3695. Gets or set whether the appender will flush at the end
  3696. of each append operation.
  3697. </summary>
  3698. <value>
  3699. <para>
  3700. The default behavior is to flush at the end of each
  3701. append operation.
  3702. </para>
  3703. <para>
  3704. If this option is set to <c>false</c>, then the underlying
  3705. stream can defer persisting the logging event to a later
  3706. time.
  3707. </para>
  3708. </value>
  3709. <remarks>
  3710. Avoiding the flush operation at the end of each append results in
  3711. a performance gain of 10 to 20 percent. However, there is safety
  3712. trade-off involved in skipping flushing. Indeed, when flushing is
  3713. skipped, then it is likely that the last few log events will not
  3714. be recorded on disk when the application exits. This is a high
  3715. price to pay even for a 20% performance gain.
  3716. </remarks>
  3717. </member>
  3718. <member name="P:log4net.Appender.TextWriterAppender.Writer">
  3719. <summary>
  3720. Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go.
  3721. </summary>
  3722. <remarks>
  3723. <para>
  3724. The specified <see cref="T:System.IO.TextWriter"/> must be open and writable.
  3725. </para>
  3726. <para>
  3727. The <see cref="T:System.IO.TextWriter"/> will be closed when the appender
  3728. instance is closed.
  3729. </para>
  3730. <para>
  3731. <b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail.
  3732. </para>
  3733. </remarks>
  3734. </member>
  3735. <member name="P:log4net.Appender.TextWriterAppender.ErrorHandler">
  3736. <summary>
  3737. Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying
  3738. <see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender.
  3739. </summary>
  3740. <value>
  3741. The <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  3742. </value>
  3743. </member>
  3744. <member name="P:log4net.Appender.TextWriterAppender.RequiresLayout">
  3745. <summary>
  3746. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3747. </summary>
  3748. <value><c>true</c></value>
  3749. <remarks>
  3750. <para>
  3751. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3752. </para>
  3753. </remarks>
  3754. </member>
  3755. <member name="P:log4net.Appender.TextWriterAppender.QuietWriter">
  3756. <summary>
  3757. Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  3758. will be written to.
  3759. </summary>
  3760. <value>
  3761. The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written.
  3762. </value>
  3763. <remarks>
  3764. <para>
  3765. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  3766. will be written to.
  3767. </para>
  3768. </remarks>
  3769. </member>
  3770. <member name="M:log4net.Appender.FileAppender.#ctor">
  3771. <summary>
  3772. Default constructor
  3773. </summary>
  3774. <remarks>
  3775. <para>
  3776. Default constructor
  3777. </para>
  3778. </remarks>
  3779. </member>
  3780. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)">
  3781. <summary>
  3782. Construct a new appender using the layout, file and append mode.
  3783. </summary>
  3784. <param name="layout">the layout to use with this appender</param>
  3785. <param name="filename">the full path to the file to write to</param>
  3786. <param name="append">flag to indicate if the file should be appended to</param>
  3787. <remarks>
  3788. <para>
  3789. Obsolete constructor.
  3790. </para>
  3791. </remarks>
  3792. </member>
  3793. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)">
  3794. <summary>
  3795. Construct a new appender using the layout and file specified.
  3796. The file will be appended to.
  3797. </summary>
  3798. <param name="layout">the layout to use with this appender</param>
  3799. <param name="filename">the full path to the file to write to</param>
  3800. <remarks>
  3801. <para>
  3802. Obsolete constructor.
  3803. </para>
  3804. </remarks>
  3805. </member>
  3806. <member name="M:log4net.Appender.FileAppender.ActivateOptions">
  3807. <summary>
  3808. Activate the options on the file appender.
  3809. </summary>
  3810. <remarks>
  3811. <para>
  3812. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3813. activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must
  3814. be called on this object after the configuration properties have
  3815. been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this
  3816. object is in an undefined state and must not be used.
  3817. </para>
  3818. <para>
  3819. If any of the configuration properties are modified then
  3820. <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again.
  3821. </para>
  3822. <para>
  3823. This will cause the file to be opened.
  3824. </para>
  3825. </remarks>
  3826. </member>
  3827. <member name="M:log4net.Appender.FileAppender.Reset">
  3828. <summary>
  3829. Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>.
  3830. </summary>
  3831. <remarks>
  3832. <para>
  3833. Resets the filename and the file stream.
  3834. </para>
  3835. </remarks>
  3836. </member>
  3837. <member name="M:log4net.Appender.FileAppender.PrepareWriter">
  3838. <summary>
  3839. Called to initialize the file writer
  3840. </summary>
  3841. <remarks>
  3842. <para>
  3843. Will be called for each logged message until the file is
  3844. successfully opened.
  3845. </para>
  3846. </remarks>
  3847. </member>
  3848. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)">
  3849. <summary>
  3850. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/>
  3851. method.
  3852. </summary>
  3853. <param name="loggingEvent">The event to log.</param>
  3854. <remarks>
  3855. <para>
  3856. Writes a log statement to the output stream if the output stream exists
  3857. and is writable.
  3858. </para>
  3859. <para>
  3860. The format of the output will depend on the appender's layout.
  3861. </para>
  3862. </remarks>
  3863. </member>
  3864. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])">
  3865. <summary>
  3866. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])"/>
  3867. method.
  3868. </summary>
  3869. <param name="loggingEvents">The array of events to log.</param>
  3870. <remarks>
  3871. <para>
  3872. Acquires the output file locks once before writing all the events to
  3873. the stream.
  3874. </para>
  3875. </remarks>
  3876. </member>
  3877. <member name="M:log4net.Appender.FileAppender.WriteFooter">
  3878. <summary>
  3879. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3880. </summary>
  3881. <remarks>
  3882. <para>
  3883. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3884. </para>
  3885. </remarks>
  3886. </member>
  3887. <member name="M:log4net.Appender.FileAppender.WriteHeader">
  3888. <summary>
  3889. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3890. </summary>
  3891. <remarks>
  3892. <para>
  3893. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3894. </para>
  3895. </remarks>
  3896. </member>
  3897. <member name="M:log4net.Appender.FileAppender.CloseWriter">
  3898. <summary>
  3899. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3900. </summary>
  3901. <remarks>
  3902. <para>
  3903. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3904. </para>
  3905. </remarks>
  3906. </member>
  3907. <member name="M:log4net.Appender.FileAppender.CloseFile">
  3908. <summary>
  3909. Closes the previously opened file.
  3910. </summary>
  3911. <remarks>
  3912. <para>
  3913. Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then
  3914. closes the file.
  3915. </para>
  3916. </remarks>
  3917. </member>
  3918. <member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)">
  3919. <summary>
  3920. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  3921. </summary>
  3922. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  3923. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  3924. <remarks>
  3925. <para>
  3926. Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception.
  3927. Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>.
  3928. </para>
  3929. </remarks>
  3930. </member>
  3931. <member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)">
  3932. <summary>
  3933. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  3934. </summary>
  3935. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  3936. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  3937. <remarks>
  3938. <para>
  3939. If there was already an opened file, then the previous file
  3940. is closed first.
  3941. </para>
  3942. <para>
  3943. This method will ensure that the directory structure
  3944. for the <paramref name="fileName"/> specified exists.
  3945. </para>
  3946. </remarks>
  3947. </member>
  3948. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)">
  3949. <summary>
  3950. Sets the quiet writer used for file output
  3951. </summary>
  3952. <param name="fileStream">the file stream that has been opened for writing</param>
  3953. <remarks>
  3954. <para>
  3955. This implementation of <see cref="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/>
  3956. over the <paramref name="fileStream"/> and passes it to the
  3957. <see cref="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)"/> method.
  3958. </para>
  3959. <para>
  3960. This method can be overridden by sub classes that want to wrap the
  3961. <see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output
  3962. data using a <c>System.Security.Cryptography.CryptoStream</c>.
  3963. </para>
  3964. </remarks>
  3965. </member>
  3966. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)">
  3967. <summary>
  3968. Sets the quiet writer being used.
  3969. </summary>
  3970. <param name="writer">the writer over the file stream that has been opened for writing</param>
  3971. <remarks>
  3972. <para>
  3973. This method can be overridden by sub classes that want to
  3974. wrap the <see cref="T:System.IO.TextWriter"/> in some way.
  3975. </para>
  3976. </remarks>
  3977. </member>
  3978. <member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)">
  3979. <summary>
  3980. Convert a path into a fully qualified path.
  3981. </summary>
  3982. <param name="path">The path to convert.</param>
  3983. <returns>The fully qualified path.</returns>
  3984. <remarks>
  3985. <para>
  3986. Converts the path specified to a fully
  3987. qualified path. If the path is relative it is
  3988. taken as relative from the application base
  3989. directory.
  3990. </para>
  3991. </remarks>
  3992. </member>
  3993. <member name="F:log4net.Appender.FileAppender.m_appendToFile">
  3994. <summary>
  3995. Flag to indicate if we should append to the file
  3996. or overwrite the file. The default is to append.
  3997. </summary>
  3998. </member>
  3999. <member name="F:log4net.Appender.FileAppender.m_fileName">
  4000. <summary>
  4001. The name of the log file.
  4002. </summary>
  4003. </member>
  4004. <member name="F:log4net.Appender.FileAppender.m_encoding">
  4005. <summary>
  4006. The encoding to use for the file stream.
  4007. </summary>
  4008. </member>
  4009. <member name="F:log4net.Appender.FileAppender.m_securityContext">
  4010. <summary>
  4011. The security context to use for privileged calls
  4012. </summary>
  4013. </member>
  4014. <member name="F:log4net.Appender.FileAppender.m_stream">
  4015. <summary>
  4016. The stream to log to. Has added locking semantics
  4017. </summary>
  4018. </member>
  4019. <member name="F:log4net.Appender.FileAppender.m_lockingModel">
  4020. <summary>
  4021. The locking model to use
  4022. </summary>
  4023. </member>
  4024. <member name="P:log4net.Appender.FileAppender.File">
  4025. <summary>
  4026. Gets or sets the path to the file that logging will be written to.
  4027. </summary>
  4028. <value>
  4029. The path to the file that logging will be written to.
  4030. </value>
  4031. <remarks>
  4032. <para>
  4033. If the path is relative it is taken as relative from
  4034. the application base directory.
  4035. </para>
  4036. </remarks>
  4037. </member>
  4038. <member name="P:log4net.Appender.FileAppender.AppendToFile">
  4039. <summary>
  4040. Gets or sets a flag that indicates whether the file should be
  4041. appended to or overwritten.
  4042. </summary>
  4043. <value>
  4044. Indicates whether the file should be appended to or overwritten.
  4045. </value>
  4046. <remarks>
  4047. <para>
  4048. If the value is set to false then the file will be overwritten, if
  4049. it is set to true then the file will be appended to.
  4050. </para>
  4051. The default value is true.
  4052. </remarks>
  4053. </member>
  4054. <member name="P:log4net.Appender.FileAppender.Encoding">
  4055. <summary>
  4056. Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  4057. </summary>
  4058. <value>
  4059. The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  4060. </value>
  4061. <remarks>
  4062. <para>
  4063. The default encoding set is <see cref="P:System.Text.Encoding.Default"/>
  4064. which is the encoding for the system's current ANSI code page.
  4065. </para>
  4066. </remarks>
  4067. </member>
  4068. <member name="P:log4net.Appender.FileAppender.SecurityContext">
  4069. <summary>
  4070. Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  4071. </summary>
  4072. <value>
  4073. The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  4074. </value>
  4075. <remarks>
  4076. <para>
  4077. Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender
  4078. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  4079. security context to use. The default behavior is to use the security context
  4080. of the current thread.
  4081. </para>
  4082. </remarks>
  4083. </member>
  4084. <member name="P:log4net.Appender.FileAppender.LockingModel">
  4085. <summary>
  4086. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  4087. </summary>
  4088. <value>
  4089. The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file.
  4090. </value>
  4091. <remarks>
  4092. <para>
  4093. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  4094. </para>
  4095. <para>
  4096. There are two built in locking models, <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> and <see cref="T:log4net.Appender.FileAppender.MinimalLock"/>.
  4097. The former locks the file from the start of logging to the end and the
  4098. later lock only for the minimal amount of time when logging each message.
  4099. </para>
  4100. <para>
  4101. The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>.
  4102. </para>
  4103. </remarks>
  4104. </member>
  4105. <member name="T:log4net.Appender.FileAppender.LockingStream">
  4106. <summary>
  4107. Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/>
  4108. to manage access to an underlying resource.
  4109. </summary>
  4110. </member>
  4111. <member name="M:log4net.Appender.FileAppender.LockingStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
  4112. <summary>
  4113. True asynchronous writes are not supported, the implementation forces a synchronous write.
  4114. </summary>
  4115. </member>
  4116. <member name="T:log4net.Core.LogException">
  4117. <summary>
  4118. Exception base type for log4net.
  4119. </summary>
  4120. <remarks>
  4121. <para>
  4122. This type extends <see cref="T:System.ApplicationException"/>. It
  4123. does not add any new functionality but does differentiate the
  4124. type of exception being thrown.
  4125. </para>
  4126. </remarks>
  4127. <author>Nicko Cadell</author>
  4128. <author>Gert Driesen</author>
  4129. </member>
  4130. <member name="M:log4net.Core.LogException.#ctor">
  4131. <summary>
  4132. Constructor
  4133. </summary>
  4134. <remarks>
  4135. <para>
  4136. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class.
  4137. </para>
  4138. </remarks>
  4139. </member>
  4140. <member name="M:log4net.Core.LogException.#ctor(System.String)">
  4141. <summary>
  4142. Constructor
  4143. </summary>
  4144. <param name="message">A message to include with the exception.</param>
  4145. <remarks>
  4146. <para>
  4147. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class with
  4148. the specified message.
  4149. </para>
  4150. </remarks>
  4151. </member>
  4152. <member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)">
  4153. <summary>
  4154. Constructor
  4155. </summary>
  4156. <param name="message">A message to include with the exception.</param>
  4157. <param name="innerException">A nested exception to include.</param>
  4158. <remarks>
  4159. <para>
  4160. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
  4161. with the specified message and inner exception.
  4162. </para>
  4163. </remarks>
  4164. </member>
  4165. <member name="M:log4net.Core.LogException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4166. <summary>
  4167. Serialization constructor
  4168. </summary>
  4169. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
  4170. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  4171. <remarks>
  4172. <para>
  4173. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
  4174. with serialized data.
  4175. </para>
  4176. </remarks>
  4177. </member>
  4178. <member name="T:log4net.Appender.FileAppender.LockingModelBase">
  4179. <summary>
  4180. Locking model base class
  4181. </summary>
  4182. <remarks>
  4183. <para>
  4184. Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers.
  4185. </para>
  4186. </remarks>
  4187. </member>
  4188. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4189. <summary>
  4190. Open the output file
  4191. </summary>
  4192. <param name="filename">The filename to use</param>
  4193. <param name="append">Whether to append to the file, or overwrite</param>
  4194. <param name="encoding">The encoding to use</param>
  4195. <remarks>
  4196. <para>
  4197. Open the file specified and prepare for logging.
  4198. No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called.
  4199. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>,
  4200. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>.
  4201. </para>
  4202. </remarks>
  4203. </member>
  4204. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile">
  4205. <summary>
  4206. Close the file
  4207. </summary>
  4208. <remarks>
  4209. <para>
  4210. Close the file. No further writes will be made.
  4211. </para>
  4212. </remarks>
  4213. </member>
  4214. <member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock">
  4215. <summary>
  4216. Acquire the lock on the file
  4217. </summary>
  4218. <returns>A stream that is ready to be written to.</returns>
  4219. <remarks>
  4220. <para>
  4221. Acquire the lock on the file in preparation for writing to it.
  4222. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/>
  4223. must be called to release the lock on the output file.
  4224. </para>
  4225. </remarks>
  4226. </member>
  4227. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock">
  4228. <summary>
  4229. Release the lock on the file
  4230. </summary>
  4231. <remarks>
  4232. <para>
  4233. Release the lock on the file. No further writes will be made to the
  4234. stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again.
  4235. </para>
  4236. </remarks>
  4237. </member>
  4238. <member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender">
  4239. <summary>
  4240. Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  4241. </summary>
  4242. <value>
  4243. The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  4244. </value>
  4245. <remarks>
  4246. <para>
  4247. The file appender this locking model is attached to and working on
  4248. behalf of.
  4249. </para>
  4250. <para>
  4251. The file appender is used to locate the security context and the error handler to use.
  4252. </para>
  4253. <para>
  4254. 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
  4255. called.
  4256. </para>
  4257. </remarks>
  4258. </member>
  4259. <member name="T:log4net.Appender.FileAppender.ExclusiveLock">
  4260. <summary>
  4261. Hold an exclusive lock on the output file
  4262. </summary>
  4263. <remarks>
  4264. <para>
  4265. Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called.
  4266. Maintains an exclusive lock on the file during this time.
  4267. </para>
  4268. </remarks>
  4269. </member>
  4270. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4271. <summary>
  4272. Open the file specified and prepare for logging.
  4273. </summary>
  4274. <param name="filename">The filename to use</param>
  4275. <param name="append">Whether to append to the file, or overwrite</param>
  4276. <param name="encoding">The encoding to use</param>
  4277. <remarks>
  4278. <para>
  4279. Open the file specified and prepare for logging.
  4280. No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called.
  4281. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>,
  4282. <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>.
  4283. </para>
  4284. </remarks>
  4285. </member>
  4286. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile">
  4287. <summary>
  4288. Close the file
  4289. </summary>
  4290. <remarks>
  4291. <para>
  4292. Close the file. No further writes will be made.
  4293. </para>
  4294. </remarks>
  4295. </member>
  4296. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock">
  4297. <summary>
  4298. Acquire the lock on the file
  4299. </summary>
  4300. <returns>A stream that is ready to be written to.</returns>
  4301. <remarks>
  4302. <para>
  4303. Does nothing. The lock is already taken
  4304. </para>
  4305. </remarks>
  4306. </member>
  4307. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock">
  4308. <summary>
  4309. Release the lock on the file
  4310. </summary>
  4311. <remarks>
  4312. <para>
  4313. Does nothing. The lock will be released when the file is closed.
  4314. </para>
  4315. </remarks>
  4316. </member>
  4317. <member name="T:log4net.Appender.FileAppender.MinimalLock">
  4318. <summary>
  4319. Acquires the file lock for each write
  4320. </summary>
  4321. <remarks>
  4322. <para>
  4323. Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle,
  4324. thus holding the lock for the minimal amount of time. This method of locking
  4325. is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows
  4326. other processes to move/delete the log file whilst logging continues.
  4327. </para>
  4328. </remarks>
  4329. </member>
  4330. <member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4331. <summary>
  4332. Prepares to open the file when the first message is logged.
  4333. </summary>
  4334. <param name="filename">The filename to use</param>
  4335. <param name="append">Whether to append to the file, or overwrite</param>
  4336. <param name="encoding">The encoding to use</param>
  4337. <remarks>
  4338. <para>
  4339. Open the file specified and prepare for logging.
  4340. No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called.
  4341. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>,
  4342. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>.
  4343. </para>
  4344. </remarks>
  4345. </member>
  4346. <member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile">
  4347. <summary>
  4348. Close the file
  4349. </summary>
  4350. <remarks>
  4351. <para>
  4352. Close the file. No further writes will be made.
  4353. </para>
  4354. </remarks>
  4355. </member>
  4356. <member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock">
  4357. <summary>
  4358. Acquire the lock on the file
  4359. </summary>
  4360. <returns>A stream that is ready to be written to.</returns>
  4361. <remarks>
  4362. <para>
  4363. Acquire the lock on the file in preparation for writing to it.
  4364. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/>
  4365. must be called to release the lock on the output file.
  4366. </para>
  4367. </remarks>
  4368. </member>
  4369. <member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock">
  4370. <summary>
  4371. Release the lock on the file
  4372. </summary>
  4373. <remarks>
  4374. <para>
  4375. Release the lock on the file. No further writes will be made to the
  4376. stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again.
  4377. </para>
  4378. </remarks>
  4379. </member>
  4380. <member name="T:log4net.Appender.ForwardingAppender">
  4381. <summary>
  4382. This appender forwards logging events to attached appenders.
  4383. </summary>
  4384. <remarks>
  4385. <para>
  4386. The forwarding appender can be used to specify different thresholds
  4387. and filters for the same appender at different locations within the hierarchy.
  4388. </para>
  4389. </remarks>
  4390. <author>Nicko Cadell</author>
  4391. <author>Gert Driesen</author>
  4392. </member>
  4393. <member name="M:log4net.Appender.ForwardingAppender.#ctor">
  4394. <summary>
  4395. Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender"/> class.
  4396. </summary>
  4397. <remarks>
  4398. <para>
  4399. Default constructor.
  4400. </para>
  4401. </remarks>
  4402. </member>
  4403. <member name="M:log4net.Appender.ForwardingAppender.OnClose">
  4404. <summary>
  4405. Closes the appender and releases resources.
  4406. </summary>
  4407. <remarks>
  4408. <para>
  4409. Releases any resources allocated within the appender such as file handles,
  4410. network connections, etc.
  4411. </para>
  4412. <para>
  4413. It is a programming error to append to a closed appender.
  4414. </para>
  4415. </remarks>
  4416. </member>
  4417. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)">
  4418. <summary>
  4419. Forward the logging event to the attached appenders
  4420. </summary>
  4421. <param name="loggingEvent">The event to log.</param>
  4422. <remarks>
  4423. <para>
  4424. Delivers the logging event to all the attached appenders.
  4425. </para>
  4426. </remarks>
  4427. </member>
  4428. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])">
  4429. <summary>
  4430. Forward the logging events to the attached appenders
  4431. </summary>
  4432. <param name="loggingEvents">The array of events to log.</param>
  4433. <remarks>
  4434. <para>
  4435. Delivers the logging events to all the attached appenders.
  4436. </para>
  4437. </remarks>
  4438. </member>
  4439. <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  4440. <summary>
  4441. Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
  4442. instance.
  4443. </summary>
  4444. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
  4445. <remarks>
  4446. <para>
  4447. If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
  4448. appenders, then it won't be added again.
  4449. </para>
  4450. </remarks>
  4451. </member>
  4452. <member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)">
  4453. <summary>
  4454. Looks for the appender with the specified name.
  4455. </summary>
  4456. <param name="name">The name of the appender to lookup.</param>
  4457. <returns>
  4458. The appender with the specified name, or <c>null</c>.
  4459. </returns>
  4460. <remarks>
  4461. <para>
  4462. Get the named appender attached to this appender.
  4463. </para>
  4464. </remarks>
  4465. </member>
  4466. <member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders">
  4467. <summary>
  4468. Removes all previously added appenders from this appender.
  4469. </summary>
  4470. <remarks>
  4471. <para>
  4472. This is useful when re-reading configuration information.
  4473. </para>
  4474. </remarks>
  4475. </member>
  4476. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  4477. <summary>
  4478. Removes the specified appender from the list of appenders.
  4479. </summary>
  4480. <param name="appender">The appender to remove.</param>
  4481. <returns>The appender removed from the list</returns>
  4482. <remarks>
  4483. The appender removed is not closed.
  4484. If you are discarding the appender you must call
  4485. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4486. </remarks>
  4487. </member>
  4488. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)">
  4489. <summary>
  4490. Removes the appender with the specified name from the list of appenders.
  4491. </summary>
  4492. <param name="name">The name of the appender to remove.</param>
  4493. <returns>The appender removed from the list</returns>
  4494. <remarks>
  4495. The appender removed is not closed.
  4496. If you are discarding the appender you must call
  4497. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4498. </remarks>
  4499. </member>
  4500. <member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl">
  4501. <summary>
  4502. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  4503. </summary>
  4504. </member>
  4505. <member name="P:log4net.Appender.ForwardingAppender.Appenders">
  4506. <summary>
  4507. Gets the appenders contained in this appender as an
  4508. <see cref="T:System.Collections.ICollection"/>.
  4509. </summary>
  4510. <remarks>
  4511. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  4512. is returned.
  4513. </remarks>
  4514. <returns>
  4515. A collection of the appenders in this appender.
  4516. </returns>
  4517. </member>
  4518. <member name="T:log4net.Appender.LocalSyslogAppender">
  4519. <summary>
  4520. Logs events to a local syslog service.
  4521. </summary>
  4522. <remarks>
  4523. <note>
  4524. This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>.
  4525. If these functions are not available on the local system then this appender will not work!
  4526. </note>
  4527. <para>
  4528. The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and
  4529. POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service.
  4530. </para>
  4531. <para>
  4532. This appender talks to a local syslog service. If you need to log to a remote syslog
  4533. daemon and you cannot configure your local syslog service to do this you may be
  4534. able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP.
  4535. </para>
  4536. <para>
  4537. Syslog messages must have a facility and and a severity. The severity
  4538. is derived from the Level of the logging event.
  4539. The facility must be chosen from the set of defined syslog
  4540. <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  4541. and cannot be extended.
  4542. </para>
  4543. <para>
  4544. An identifier is specified with each log message. This can be specified
  4545. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  4546. as the tag) must not contain white space. The default value for the
  4547. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  4548. </para>
  4549. </remarks>
  4550. <author>Rob Lyon</author>
  4551. <author>Nicko Cadell</author>
  4552. </member>
  4553. <member name="M:log4net.Appender.LocalSyslogAppender.#ctor">
  4554. <summary>
  4555. Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class.
  4556. </summary>
  4557. <remarks>
  4558. This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class is set up to write
  4559. to a local syslog service.
  4560. </remarks>
  4561. </member>
  4562. <member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)">
  4563. <summary>
  4564. Add a mapping of level to severity
  4565. </summary>
  4566. <param name="mapping">The mapping to add</param>
  4567. <remarks>
  4568. <para>
  4569. Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender.
  4570. </para>
  4571. </remarks>
  4572. </member>
  4573. <member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions">
  4574. <summary>
  4575. Initialize the appender based on the options set.
  4576. </summary>
  4577. <remarks>
  4578. <para>
  4579. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  4580. activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must
  4581. be called on this object after the configuration properties have
  4582. been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this
  4583. object is in an undefined state and must not be used.
  4584. </para>
  4585. <para>
  4586. If any of the configuration properties are modified then
  4587. <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again.
  4588. </para>
  4589. </remarks>
  4590. </member>
  4591. <member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)">
  4592. <summary>
  4593. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  4594. </summary>
  4595. <param name="loggingEvent">The event to log.</param>
  4596. <remarks>
  4597. <para>
  4598. Writes the event to a remote syslog daemon.
  4599. </para>
  4600. <para>
  4601. The format of the output will depend on the appender's layout.
  4602. </para>
  4603. </remarks>
  4604. </member>
  4605. <member name="M:log4net.Appender.LocalSyslogAppender.OnClose">
  4606. <summary>
  4607. Close the syslog when the appender is closed
  4608. </summary>
  4609. <remarks>
  4610. <para>
  4611. Close the syslog when the appender is closed
  4612. </para>
  4613. </remarks>
  4614. </member>
  4615. <member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)">
  4616. <summary>
  4617. Translates a log4net level to a syslog severity.
  4618. </summary>
  4619. <param name="level">A log4net level.</param>
  4620. <returns>A syslog severity.</returns>
  4621. <remarks>
  4622. <para>
  4623. Translates a log4net level to a syslog severity.
  4624. </para>
  4625. </remarks>
  4626. </member>
  4627. <member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)">
  4628. <summary>
  4629. Generate a syslog priority.
  4630. </summary>
  4631. <param name="facility">The syslog facility.</param>
  4632. <param name="severity">The syslog severity.</param>
  4633. <returns>A syslog priority.</returns>
  4634. </member>
  4635. <member name="F:log4net.Appender.LocalSyslogAppender.m_facility">
  4636. <summary>
  4637. The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  4638. </summary>
  4639. </member>
  4640. <member name="F:log4net.Appender.LocalSyslogAppender.m_identity">
  4641. <summary>
  4642. The message identity
  4643. </summary>
  4644. </member>
  4645. <member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity">
  4646. <summary>
  4647. Marshaled handle to the identity string. We have to hold on to the
  4648. string as the <c>openlog</c> and <c>syslog</c> APIs just hold the
  4649. pointer to the ident and dereference it for each log message.
  4650. </summary>
  4651. </member>
  4652. <member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping">
  4653. <summary>
  4654. Mapping from level object to syslog severity
  4655. </summary>
  4656. </member>
  4657. <member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)">
  4658. <summary>
  4659. Open connection to system logger.
  4660. </summary>
  4661. </member>
  4662. <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)">
  4663. <summary>
  4664. Generate a log message.
  4665. </summary>
  4666. <remarks>
  4667. <para>
  4668. The libc syslog method takes a format string and a variable argument list similar
  4669. to the classic printf function. As this type of vararg list is not supported
  4670. by C# we need to specify the arguments explicitly. Here we have specified the
  4671. format string with a single message argument. The caller must set the format
  4672. string to <c>"%s"</c>.
  4673. </para>
  4674. </remarks>
  4675. </member>
  4676. <member name="M:log4net.Appender.LocalSyslogAppender.closelog">
  4677. <summary>
  4678. Close descriptor used to write to system logger.
  4679. </summary>
  4680. </member>
  4681. <member name="P:log4net.Appender.LocalSyslogAppender.Identity">
  4682. <summary>
  4683. Message identity
  4684. </summary>
  4685. <remarks>
  4686. <para>
  4687. An identifier is specified with each log message. This can be specified
  4688. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  4689. as the tag) must not contain white space. The default value for the
  4690. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  4691. </para>
  4692. </remarks>
  4693. </member>
  4694. <member name="P:log4net.Appender.LocalSyslogAppender.Facility">
  4695. <summary>
  4696. Syslog facility
  4697. </summary>
  4698. <remarks>
  4699. Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of
  4700. facilities is predefined and cannot be extended. The default value
  4701. is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  4702. </remarks>
  4703. </member>
  4704. <member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout">
  4705. <summary>
  4706. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  4707. </summary>
  4708. <value><c>true</c></value>
  4709. <remarks>
  4710. <para>
  4711. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  4712. </para>
  4713. </remarks>
  4714. </member>
  4715. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity">
  4716. <summary>
  4717. syslog severities
  4718. </summary>
  4719. <remarks>
  4720. <para>
  4721. The log4net Level maps to a syslog severity using the
  4722. <see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/>
  4723. class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>.
  4724. </para>
  4725. </remarks>
  4726. </member>
  4727. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency">
  4728. <summary>
  4729. system is unusable
  4730. </summary>
  4731. </member>
  4732. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert">
  4733. <summary>
  4734. action must be taken immediately
  4735. </summary>
  4736. </member>
  4737. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical">
  4738. <summary>
  4739. critical conditions
  4740. </summary>
  4741. </member>
  4742. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error">
  4743. <summary>
  4744. error conditions
  4745. </summary>
  4746. </member>
  4747. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning">
  4748. <summary>
  4749. warning conditions
  4750. </summary>
  4751. </member>
  4752. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice">
  4753. <summary>
  4754. normal but significant condition
  4755. </summary>
  4756. </member>
  4757. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational">
  4758. <summary>
  4759. informational
  4760. </summary>
  4761. </member>
  4762. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug">
  4763. <summary>
  4764. debug-level messages
  4765. </summary>
  4766. </member>
  4767. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility">
  4768. <summary>
  4769. syslog facilities
  4770. </summary>
  4771. <remarks>
  4772. <para>
  4773. The syslog facility defines which subsystem the logging comes from.
  4774. This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property.
  4775. </para>
  4776. </remarks>
  4777. </member>
  4778. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel">
  4779. <summary>
  4780. kernel messages
  4781. </summary>
  4782. </member>
  4783. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User">
  4784. <summary>
  4785. random user-level messages
  4786. </summary>
  4787. </member>
  4788. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail">
  4789. <summary>
  4790. mail system
  4791. </summary>
  4792. </member>
  4793. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons">
  4794. <summary>
  4795. system daemons
  4796. </summary>
  4797. </member>
  4798. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization">
  4799. <summary>
  4800. security/authorization messages
  4801. </summary>
  4802. </member>
  4803. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog">
  4804. <summary>
  4805. messages generated internally by syslogd
  4806. </summary>
  4807. </member>
  4808. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer">
  4809. <summary>
  4810. line printer subsystem
  4811. </summary>
  4812. </member>
  4813. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News">
  4814. <summary>
  4815. network news subsystem
  4816. </summary>
  4817. </member>
  4818. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp">
  4819. <summary>
  4820. UUCP subsystem
  4821. </summary>
  4822. </member>
  4823. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock">
  4824. <summary>
  4825. clock (cron/at) daemon
  4826. </summary>
  4827. </member>
  4828. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2">
  4829. <summary>
  4830. security/authorization messages (private)
  4831. </summary>
  4832. </member>
  4833. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp">
  4834. <summary>
  4835. ftp daemon
  4836. </summary>
  4837. </member>
  4838. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp">
  4839. <summary>
  4840. NTP subsystem
  4841. </summary>
  4842. </member>
  4843. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit">
  4844. <summary>
  4845. log audit
  4846. </summary>
  4847. </member>
  4848. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert">
  4849. <summary>
  4850. log alert
  4851. </summary>
  4852. </member>
  4853. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2">
  4854. <summary>
  4855. clock daemon
  4856. </summary>
  4857. </member>
  4858. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0">
  4859. <summary>
  4860. reserved for local use
  4861. </summary>
  4862. </member>
  4863. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1">
  4864. <summary>
  4865. reserved for local use
  4866. </summary>
  4867. </member>
  4868. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2">
  4869. <summary>
  4870. reserved for local use
  4871. </summary>
  4872. </member>
  4873. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3">
  4874. <summary>
  4875. reserved for local use
  4876. </summary>
  4877. </member>
  4878. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4">
  4879. <summary>
  4880. reserved for local use
  4881. </summary>
  4882. </member>
  4883. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5">
  4884. <summary>
  4885. reserved for local use
  4886. </summary>
  4887. </member>
  4888. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6">
  4889. <summary>
  4890. reserved for local use
  4891. </summary>
  4892. </member>
  4893. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7">
  4894. <summary>
  4895. reserved for local use
  4896. </summary>
  4897. </member>
  4898. <member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity">
  4899. <summary>
  4900. A class to act as a mapping between the level that a logging call is made at and
  4901. the syslog severity that is should be logged at.
  4902. </summary>
  4903. <remarks>
  4904. <para>
  4905. A class to act as a mapping between the level that a logging call is made at and
  4906. the syslog severity that is should be logged at.
  4907. </para>
  4908. </remarks>
  4909. </member>
  4910. <member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity">
  4911. <summary>
  4912. The mapped syslog severity for the specified level
  4913. </summary>
  4914. <remarks>
  4915. <para>
  4916. Required property.
  4917. The mapped syslog severity for the specified level
  4918. </para>
  4919. </remarks>
  4920. </member>
  4921. <member name="T:log4net.Appender.MemoryAppender">
  4922. <summary>
  4923. Stores logging events in an array.
  4924. </summary>
  4925. <remarks>
  4926. <para>
  4927. The memory appender stores all the logging events
  4928. that are appended in an in-memory array.
  4929. </para>
  4930. <para>
  4931. Use the <see cref="M:log4net.Appender.MemoryAppender.GetEvents"/> method to get
  4932. the current list of events that have been appended.
  4933. </para>
  4934. <para>
  4935. Use the <see cref="M:log4net.Appender.MemoryAppender.Clear"/> method to clear the
  4936. current list of events.
  4937. </para>
  4938. </remarks>
  4939. <author>Julian Biddle</author>
  4940. <author>Nicko Cadell</author>
  4941. <author>Gert Driesen</author>
  4942. </member>
  4943. <member name="M:log4net.Appender.MemoryAppender.#ctor">
  4944. <summary>
  4945. Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender"/> class.
  4946. </summary>
  4947. <remarks>
  4948. <para>
  4949. Default constructor.
  4950. </para>
  4951. </remarks>
  4952. </member>
  4953. <member name="M:log4net.Appender.MemoryAppender.GetEvents">
  4954. <summary>
  4955. Gets the events that have been logged.
  4956. </summary>
  4957. <returns>The events that have been logged</returns>
  4958. <remarks>
  4959. <para>
  4960. Gets the events that have been logged.
  4961. </para>
  4962. </remarks>
  4963. </member>
  4964. <member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)">
  4965. <summary>
  4966. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  4967. </summary>
  4968. <param name="loggingEvent">the event to log</param>
  4969. <remarks>
  4970. <para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
  4971. </remarks>
  4972. </member>
  4973. <member name="M:log4net.Appender.MemoryAppender.Clear">
  4974. <summary>
  4975. Clear the list of events
  4976. </summary>
  4977. <remarks>
  4978. Clear the list of events
  4979. </remarks>
  4980. </member>
  4981. <member name="F:log4net.Appender.MemoryAppender.m_eventsList">
  4982. <summary>
  4983. The list of events that have been appended.
  4984. </summary>
  4985. </member>
  4986. <member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
  4987. <summary>
  4988. Value indicating which fields in the event should be fixed
  4989. </summary>
  4990. <remarks>
  4991. By default all fields are fixed
  4992. </remarks>
  4993. </member>
  4994. <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
  4995. <summary>
  4996. Gets or sets a value indicating whether only part of the logging event
  4997. data should be fixed.
  4998. </summary>
  4999. <value>
  5000. <c>true</c> if the appender should only fix part of the logging event
  5001. data, otherwise <c>false</c>. The default is <c>false</c>.
  5002. </value>
  5003. <remarks>
  5004. <para>
  5005. Setting this property to <c>true</c> will cause only part of the event
  5006. data to be fixed and stored in the appender, hereby improving performance.
  5007. </para>
  5008. <para>
  5009. See <see cref="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)"/> for more information.
  5010. </para>
  5011. </remarks>
  5012. </member>
  5013. <member name="P:log4net.Appender.MemoryAppender.Fix">
  5014. <summary>
  5015. Gets or sets the fields that will be fixed in the event
  5016. </summary>
  5017. <remarks>
  5018. <para>
  5019. The logging event needs to have certain thread specific values
  5020. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  5021. for details.
  5022. </para>
  5023. </remarks>
  5024. </member>
  5025. <member name="T:log4net.Appender.NetSendAppender">
  5026. <summary>
  5027. Logs entries by sending network messages using the
  5028. <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/> native function.
  5029. </summary>
  5030. <remarks>
  5031. <para>
  5032. You can send messages only to names that are active
  5033. on the network. If you send the message to a user name,
  5034. that user must be logged on and running the Messenger
  5035. service to receive the message.
  5036. </para>
  5037. <para>
  5038. The receiver will get a top most window displaying the
  5039. messages one at a time, therefore this appender should
  5040. not be used to deliver a high volume of messages.
  5041. </para>
  5042. <para>
  5043. The following table lists some possible uses for this appender :
  5044. </para>
  5045. <para>
  5046. <list type="table">
  5047. <listheader>
  5048. <term>Action</term>
  5049. <description>Property Value(s)</description>
  5050. </listheader>
  5051. <item>
  5052. <term>Send a message to a user account on the local machine</term>
  5053. <description>
  5054. <para>
  5055. <paramref name="Server"/> = &lt;name of the local machine&gt;
  5056. </para>
  5057. <para>
  5058. <paramref name="Recipient"/> = &lt;user name&gt;
  5059. </para>
  5060. </description>
  5061. </item>
  5062. <item>
  5063. <term>Send a message to a user account on a remote machine</term>
  5064. <description>
  5065. <para>
  5066. <paramref name="Server"/> = &lt;name of the remote machine&gt;
  5067. </para>
  5068. <para>
  5069. <paramref name="Recipient"/> = &lt;user name&gt;
  5070. </para>
  5071. </description>
  5072. </item>
  5073. <item>
  5074. <term>Send a message to a domain user account</term>
  5075. <description>
  5076. <para>
  5077. <paramref name="Server"/> = &lt;name of a domain controller | uninitialized&gt;
  5078. </para>
  5079. <para>
  5080. <paramref name="Recipient"/> = &lt;user name&gt;
  5081. </para>
  5082. </description>
  5083. </item>
  5084. <item>
  5085. <term>Send a message to all the names in a workgroup or domain</term>
  5086. <description>
  5087. <para>
  5088. <paramref name="Recipient"/> = &lt;workgroup name | domain name&gt;*
  5089. </para>
  5090. </description>
  5091. </item>
  5092. <item>
  5093. <term>Send a message from the local machine to a remote machine</term>
  5094. <description>
  5095. <para>
  5096. <paramref name="Server"/> = &lt;name of the local machine | uninitialized&gt;
  5097. </para>
  5098. <para>
  5099. <paramref name="Recipient"/> = &lt;name of the remote machine&gt;
  5100. </para>
  5101. </description>
  5102. </item>
  5103. </list>
  5104. </para>
  5105. <para>
  5106. <b>Note :</b> security restrictions apply for sending
  5107. network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/>
  5108. for more information.
  5109. </para>
  5110. </remarks>
  5111. <example>
  5112. <para>
  5113. An example configuration section to log information
  5114. using this appender from the local machine, named
  5115. LOCAL_PC, to machine OPERATOR_PC :
  5116. </para>
  5117. <code lang="XML" escaped="true">
  5118. <appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender">
  5119. <server value="LOCAL_PC"/>
  5120. <recipient value="OPERATOR_PC"/>
  5121. <layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n"/>
  5122. </appender>
  5123. </code>
  5124. </example>
  5125. <author>Nicko Cadell</author>
  5126. <author>Gert Driesen</author>
  5127. </member>
  5128. <member name="F:log4net.Appender.NetSendAppender.m_server">
  5129. <summary>
  5130. The DNS or NetBIOS name of the server on which the function is to execute.
  5131. </summary>
  5132. </member>
  5133. <member name="F:log4net.Appender.NetSendAppender.m_sender">
  5134. <summary>
  5135. The sender of the network message.
  5136. </summary>
  5137. </member>
  5138. <member name="F:log4net.Appender.NetSendAppender.m_recipient">
  5139. <summary>
  5140. The message alias to which the message should be sent.
  5141. </summary>
  5142. </member>
  5143. <member name="F:log4net.Appender.NetSendAppender.m_securityContext">
  5144. <summary>
  5145. The security context to use for privileged calls
  5146. </summary>
  5147. </member>
  5148. <member name="M:log4net.Appender.NetSendAppender.#ctor">
  5149. <summary>
  5150. Initializes the appender.
  5151. </summary>
  5152. <remarks>
  5153. The default constructor initializes all fields to their default values.
  5154. </remarks>
  5155. </member>
  5156. <member name="M:log4net.Appender.NetSendAppender.ActivateOptions">
  5157. <summary>
  5158. Initialize the appender based on the options set.
  5159. </summary>
  5160. <remarks>
  5161. <para>
  5162. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5163. activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must
  5164. be called on this object after the configuration properties have
  5165. been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this
  5166. object is in an undefined state and must not be used.
  5167. </para>
  5168. <para>
  5169. If any of the configuration properties are modified then
  5170. <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again.
  5171. </para>
  5172. <para>
  5173. The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was specified.
  5174. </para>
  5175. </remarks>
  5176. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was not specified.</exception>
  5177. </member>
  5178. <member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)">
  5179. <summary>
  5180. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  5181. </summary>
  5182. <param name="loggingEvent">The event to log.</param>
  5183. <remarks>
  5184. <para>
  5185. Sends the event using a network message.
  5186. </para>
  5187. </remarks>
  5188. </member>
  5189. <member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)">
  5190. <summary>
  5191. Sends a buffer of information to a registered message alias.
  5192. </summary>
  5193. <param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param>
  5194. <param name="msgName">The message alias to which the message buffer should be sent</param>
  5195. <param name="fromName">The originator of the message.</param>
  5196. <param name="buffer">The message text.</param>
  5197. <param name="bufferSize">The length, in bytes, of the message text.</param>
  5198. <remarks>
  5199. <para>
  5200. The following restrictions apply for sending network messages:
  5201. </para>
  5202. <para>
  5203. <list type="table">
  5204. <listheader>
  5205. <term>Platform</term>
  5206. <description>Requirements</description>
  5207. </listheader>
  5208. <item>
  5209. <term>Windows NT</term>
  5210. <description>
  5211. <para>
  5212. No special group membership is required to send a network message.
  5213. </para>
  5214. <para>
  5215. Admin, Accounts, Print, or Server Operator group membership is required to
  5216. successfully send a network message on a remote server.
  5217. </para>
  5218. </description>
  5219. </item>
  5220. <item>
  5221. <term>Windows 2000 or later</term>
  5222. <description>
  5223. <para>
  5224. If you send a message on a domain controller that is running Active Directory,
  5225. access is allowed or denied based on the access control list (ACL) for the securable
  5226. object. The default ACL permits only Domain Admins and Account Operators to send a network message.
  5227. </para>
  5228. <para>
  5229. On a member server or workstation, only Administrators and Server Operators can send a network message.
  5230. </para>
  5231. </description>
  5232. </item>
  5233. </list>
  5234. </para>
  5235. <para>
  5236. 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>.
  5237. </para>
  5238. </remarks>
  5239. <returns>
  5240. <para>
  5241. If the function succeeds, the return value is zero.
  5242. </para>
  5243. </returns>
  5244. </member>
  5245. <member name="P:log4net.Appender.NetSendAppender.Sender">
  5246. <summary>
  5247. Gets or sets the sender of the message.
  5248. </summary>
  5249. <value>
  5250. The sender of the message.
  5251. </value>
  5252. <remarks>
  5253. If this property is not specified, the message is sent from the local computer.
  5254. </remarks>
  5255. </member>
  5256. <member name="P:log4net.Appender.NetSendAppender.Recipient">
  5257. <summary>
  5258. Gets or sets the message alias to which the message should be sent.
  5259. </summary>
  5260. <value>
  5261. The recipient of the message.
  5262. </value>
  5263. <remarks>
  5264. This property should always be specified in order to send a message.
  5265. </remarks>
  5266. </member>
  5267. <member name="P:log4net.Appender.NetSendAppender.Server">
  5268. <summary>
  5269. Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute.
  5270. </summary>
  5271. <value>
  5272. DNS or NetBIOS name of the remote server on which the function is to execute.
  5273. </value>
  5274. <remarks>
  5275. <para>
  5276. For Windows NT 4.0 and earlier, the string should begin with \\.
  5277. </para>
  5278. <para>
  5279. If this property is not specified, the local computer is used.
  5280. </para>
  5281. </remarks>
  5282. </member>
  5283. <member name="P:log4net.Appender.NetSendAppender.SecurityContext">
  5284. <summary>
  5285. Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5286. </summary>
  5287. <value>
  5288. The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5289. </value>
  5290. <remarks>
  5291. <para>
  5292. Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender
  5293. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  5294. security context to use. The default behavior is to use the security context
  5295. of the current thread.
  5296. </para>
  5297. </remarks>
  5298. </member>
  5299. <member name="P:log4net.Appender.NetSendAppender.RequiresLayout">
  5300. <summary>
  5301. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5302. </summary>
  5303. <value><c>true</c></value>
  5304. <remarks>
  5305. <para>
  5306. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5307. </para>
  5308. </remarks>
  5309. </member>
  5310. <member name="T:log4net.Appender.OutputDebugStringAppender">
  5311. <summary>
  5312. Appends log events to the OutputDebugString system.
  5313. </summary>
  5314. <remarks>
  5315. <para>
  5316. OutputDebugStringAppender appends log events to the
  5317. OutputDebugString system.
  5318. </para>
  5319. <para>
  5320. The string is passed to the native <c>OutputDebugString</c>
  5321. function.
  5322. </para>
  5323. </remarks>
  5324. <author>Nicko Cadell</author>
  5325. <author>Gert Driesen</author>
  5326. </member>
  5327. <member name="M:log4net.Appender.OutputDebugStringAppender.#ctor">
  5328. <summary>
  5329. Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender"/> class.
  5330. </summary>
  5331. <remarks>
  5332. <para>
  5333. Default constructor.
  5334. </para>
  5335. </remarks>
  5336. </member>
  5337. <member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)">
  5338. <summary>
  5339. Write the logging event to the output debug string API
  5340. </summary>
  5341. <param name="loggingEvent">the event to log</param>
  5342. <remarks>
  5343. <para>
  5344. Write the logging event to the output debug string API
  5345. </para>
  5346. </remarks>
  5347. </member>
  5348. <member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)">
  5349. <summary>
  5350. Stub for OutputDebugString native method
  5351. </summary>
  5352. <param name="message">the string to output</param>
  5353. <remarks>
  5354. <para>
  5355. Stub for OutputDebugString native method
  5356. </para>
  5357. </remarks>
  5358. </member>
  5359. <member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout">
  5360. <summary>
  5361. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5362. </summary>
  5363. <value><c>true</c></value>
  5364. <remarks>
  5365. <para>
  5366. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5367. </para>
  5368. </remarks>
  5369. </member>
  5370. <member name="T:log4net.Appender.RemoteSyslogAppender">
  5371. <summary>
  5372. Logs events to a remote syslog daemon.
  5373. </summary>
  5374. <remarks>
  5375. <para>
  5376. The BSD syslog protocol is used to remotely log to
  5377. a syslog daemon. The syslogd listens for for messages
  5378. on UDP port 514.
  5379. </para>
  5380. <para>
  5381. The syslog UDP protocol is not authenticated. Most syslog daemons
  5382. do not accept remote log messages because of the security implications.
  5383. You may be able to use the LocalSyslogAppender to talk to a local
  5384. syslog service.
  5385. </para>
  5386. <para>
  5387. There is an RFC 3164 that claims to document the BSD Syslog Protocol.
  5388. This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html.
  5389. This appender generates what the RFC calls an "Original Device Message",
  5390. i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation
  5391. this format of message will be accepted by all current syslog daemon
  5392. implementations. The daemon will attach the current time and the source
  5393. hostname or IP address to any messages received.
  5394. </para>
  5395. <para>
  5396. Syslog messages must have a facility and and a severity. The severity
  5397. is derived from the Level of the logging event.
  5398. The facility must be chosen from the set of defined syslog
  5399. <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  5400. and cannot be extended.
  5401. </para>
  5402. <para>
  5403. An identifier is specified with each log message. This can be specified
  5404. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  5405. as the tag) must not contain white space. The default value for the
  5406. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  5407. </para>
  5408. </remarks>
  5409. <author>Rob Lyon</author>
  5410. <author>Nicko Cadell</author>
  5411. </member>
  5412. <member name="T:log4net.Appender.UdpAppender">
  5413. <summary>
  5414. Sends logging events as connectionless UDP datagrams to a remote host or a
  5415. multicast group using an <see cref="T:System.Net.Sockets.UdpClient"/>.
  5416. </summary>
  5417. <remarks>
  5418. <para>
  5419. UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
  5420. </para>
  5421. <para>
  5422. To view the logging results, a custom application can be developed that listens for logging
  5423. events.
  5424. </para>
  5425. <para>
  5426. When decoding events send via this appender remember to use the same encoding
  5427. to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
  5428. property to specify the encoding to use.
  5429. </para>
  5430. </remarks>
  5431. <example>
  5432. This example shows how to log receive logging events that are sent
  5433. on IP address 244.0.0.1 and port 8080 to the console. The event is
  5434. encoded in the packet as a unicode string and it is decoded as such.
  5435. <code lang="C#">
  5436. IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
  5437. UdpClient udpClient;
  5438. byte[] buffer;
  5439. string loggingEvent;
  5440. try
  5441. {
  5442. udpClient = new UdpClient(8080);
  5443. while(true)
  5444. {
  5445. buffer = udpClient.Receive(ref remoteEndPoint);
  5446. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
  5447. Console.WriteLine(loggingEvent);
  5448. }
  5449. }
  5450. catch(Exception e)
  5451. {
  5452. Console.WriteLine(e.ToString());
  5453. }
  5454. </code>
  5455. <code lang="Visual Basic">
  5456. Dim remoteEndPoint as IPEndPoint
  5457. Dim udpClient as UdpClient
  5458. Dim buffer as Byte()
  5459. Dim loggingEvent as String
  5460. Try
  5461. remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
  5462. udpClient = new UdpClient(8080)
  5463. While True
  5464. buffer = udpClient.Receive(ByRef remoteEndPoint)
  5465. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
  5466. Console.WriteLine(loggingEvent)
  5467. Wend
  5468. Catch e As Exception
  5469. Console.WriteLine(e.ToString())
  5470. End Try
  5471. </code>
  5472. <para>
  5473. An example configuration section to log information using this appender to the
  5474. IP 224.0.0.1 on port 8080:
  5475. </para>
  5476. <code lang="XML" escaped="true">
  5477. <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
  5478. <remoteAddress value="224.0.0.1"/>
  5479. <remotePort value="8080"/>
  5480. <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline"/>
  5481. </appender>
  5482. </code>
  5483. </example>
  5484. <author>Gert Driesen</author>
  5485. <author>Nicko Cadell</author>
  5486. </member>
  5487. <member name="M:log4net.Appender.UdpAppender.#ctor">
  5488. <summary>
  5489. Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender"/> class.
  5490. </summary>
  5491. <remarks>
  5492. The default constructor initializes all fields to their default values.
  5493. </remarks>
  5494. </member>
  5495. <member name="M:log4net.Appender.UdpAppender.ActivateOptions">
  5496. <summary>
  5497. Initialize the appender based on the options set.
  5498. </summary>
  5499. <remarks>
  5500. <para>
  5501. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5502. activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must
  5503. be called on this object after the configuration properties have
  5504. been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this
  5505. object is in an undefined state and must not be used.
  5506. </para>
  5507. <para>
  5508. If any of the configuration properties are modified then
  5509. <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again.
  5510. </para>
  5511. <para>
  5512. The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was specified or
  5513. an invalid remote or local TCP port number was specified.
  5514. </para>
  5515. </remarks>
  5516. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was not specified.</exception>
  5517. <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>
  5518. </member>
  5519. <member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)">
  5520. <summary>
  5521. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  5522. </summary>
  5523. <param name="loggingEvent">The event to log.</param>
  5524. <remarks>
  5525. <para>
  5526. Sends the event using an UDP datagram.
  5527. </para>
  5528. <para>
  5529. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  5530. </para>
  5531. </remarks>
  5532. </member>
  5533. <member name="M:log4net.Appender.UdpAppender.OnClose">
  5534. <summary>
  5535. Closes the UDP connection and releases all resources associated with
  5536. this <see cref="T:log4net.Appender.UdpAppender"/> instance.
  5537. </summary>
  5538. <remarks>
  5539. <para>
  5540. Disables the underlying <see cref="T:System.Net.Sockets.UdpClient"/> and releases all managed
  5541. and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender"/>.
  5542. </para>
  5543. </remarks>
  5544. </member>
  5545. <member name="M:log4net.Appender.UdpAppender.InitializeClientConnection">
  5546. <summary>
  5547. Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient"/> connection.
  5548. </summary>
  5549. <remarks>
  5550. <para>
  5551. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the
  5552. port number from which you intend to communicate.
  5553. </para>
  5554. <para>
  5555. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  5556. </para>
  5557. </remarks>
  5558. </member>
  5559. <member name="F:log4net.Appender.UdpAppender.m_remoteAddress">
  5560. <summary>
  5561. The IP address of the remote host or multicast group to which
  5562. the logging event will be sent.
  5563. </summary>
  5564. </member>
  5565. <member name="F:log4net.Appender.UdpAppender.m_remotePort">
  5566. <summary>
  5567. The TCP port number of the remote host or multicast group to
  5568. which the logging event will be sent.
  5569. </summary>
  5570. </member>
  5571. <member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint">
  5572. <summary>
  5573. The cached remote endpoint to which the logging events will be sent.
  5574. </summary>
  5575. </member>
  5576. <member name="F:log4net.Appender.UdpAppender.m_localPort">
  5577. <summary>
  5578. The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  5579. </summary>
  5580. </member>
  5581. <member name="F:log4net.Appender.UdpAppender.m_client">
  5582. <summary>
  5583. The <see cref="T:System.Net.Sockets.UdpClient"/> instance that will be used for sending the
  5584. logging events.
  5585. </summary>
  5586. </member>
  5587. <member name="F:log4net.Appender.UdpAppender.m_encoding">
  5588. <summary>
  5589. The encoding to use for the packet.
  5590. </summary>
  5591. </member>
  5592. <member name="P:log4net.Appender.UdpAppender.RemoteAddress">
  5593. <summary>
  5594. Gets or sets the IP address of the remote host or multicast group to which
  5595. the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
  5596. </summary>
  5597. <value>
  5598. The IP address of the remote host or multicast group to which the logging event
  5599. will be sent.
  5600. </value>
  5601. <remarks>
  5602. <para>
  5603. Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to
  5604. 239.255.255.255). Multicast packets can pass across different networks through routers, so
  5605. it is possible to use multicasts in an Internet scenario as long as your network provider
  5606. supports multicasting.
  5607. </para>
  5608. <para>
  5609. Hosts that want to receive particular multicast messages must register their interest by joining
  5610. the multicast group. Multicast messages are not sent to networks where no host has joined
  5611. the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate
  5612. them from normal host addresses, allowing nodes to easily detect if a message is of interest.
  5613. </para>
  5614. <para>
  5615. Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below:
  5616. </para>
  5617. <para>
  5618. <list type="table">
  5619. <listheader>
  5620. <term>IP Address</term>
  5621. <description>Description</description>
  5622. </listheader>
  5623. <item>
  5624. <term>224.0.0.1</term>
  5625. <description>
  5626. <para>
  5627. Sends a message to all system on the subnet.
  5628. </para>
  5629. </description>
  5630. </item>
  5631. <item>
  5632. <term>224.0.0.2</term>
  5633. <description>
  5634. <para>
  5635. Sends a message to all routers on the subnet.
  5636. </para>
  5637. </description>
  5638. </item>
  5639. <item>
  5640. <term>224.0.0.12</term>
  5641. <description>
  5642. <para>
  5643. The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet.
  5644. </para>
  5645. </description>
  5646. </item>
  5647. </list>
  5648. </para>
  5649. <para>
  5650. A complete list of actually reserved multicast addresses and their owners in the ranges
  5651. defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>.
  5652. </para>
  5653. <para>
  5654. The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative
  5655. addresses. These addresses can be reused with other local groups. Routers are typically
  5656. configured with filters to prevent multicast traffic in this range from flowing outside
  5657. of the local network.
  5658. </para>
  5659. </remarks>
  5660. </member>
  5661. <member name="P:log4net.Appender.UdpAppender.RemotePort">
  5662. <summary>
  5663. Gets or sets the TCP port number of the remote host or multicast group to which
  5664. the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
  5665. </summary>
  5666. <value>
  5667. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  5668. indicating the TCP port number of the remote host or multicast group to which the logging event
  5669. will be sent.
  5670. </value>
  5671. <remarks>
  5672. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will send messages to this TCP port number
  5673. on the remote host or multicast group.
  5674. </remarks>
  5675. <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>
  5676. </member>
  5677. <member name="P:log4net.Appender.UdpAppender.LocalPort">
  5678. <summary>
  5679. Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  5680. </summary>
  5681. <value>
  5682. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  5683. indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  5684. </value>
  5685. <remarks>
  5686. <para>
  5687. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will bind to this port for sending messages.
  5688. </para>
  5689. <para>
  5690. Setting the value to 0 (the default) will cause the udp client not to bind to
  5691. a local port.
  5692. </para>
  5693. </remarks>
  5694. <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>
  5695. </member>
  5696. <member name="P:log4net.Appender.UdpAppender.Encoding">
  5697. <summary>
  5698. Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  5699. </summary>
  5700. <value>
  5701. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  5702. </value>
  5703. <remarks>
  5704. <para>
  5705. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  5706. </para>
  5707. </remarks>
  5708. </member>
  5709. <member name="P:log4net.Appender.UdpAppender.Client">
  5710. <summary>
  5711. Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
  5712. </summary>
  5713. <value>
  5714. The underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
  5715. </value>
  5716. <remarks>
  5717. <see cref="T:log4net.Appender.UdpAppender"/> creates a <see cref="T:System.Net.Sockets.UdpClient"/> to send logging events
  5718. over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender"/> can use this
  5719. property to get or set this <see cref="T:System.Net.Sockets.UdpClient"/>. Use the underlying <see cref="T:System.Net.Sockets.UdpClient"/>
  5720. returned from <see cref="P:log4net.Appender.UdpAppender.Client"/> if you require access beyond that which
  5721. <see cref="T:log4net.Appender.UdpAppender"/> provides.
  5722. </remarks>
  5723. </member>
  5724. <member name="P:log4net.Appender.UdpAppender.RemoteEndPoint">
  5725. <summary>
  5726. Gets or sets the cached remote endpoint to which the logging events should be sent.
  5727. </summary>
  5728. <value>
  5729. The cached remote endpoint to which the logging events will be sent.
  5730. </value>
  5731. <remarks>
  5732. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method will initialize the remote endpoint
  5733. with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/>
  5734. properties.
  5735. </remarks>
  5736. </member>
  5737. <member name="P:log4net.Appender.UdpAppender.RequiresLayout">
  5738. <summary>
  5739. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5740. </summary>
  5741. <value><c>true</c></value>
  5742. <remarks>
  5743. <para>
  5744. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5745. </para>
  5746. </remarks>
  5747. </member>
  5748. <member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort">
  5749. <summary>
  5750. Syslog port 514
  5751. </summary>
  5752. </member>
  5753. <member name="M:log4net.Appender.RemoteSyslogAppender.#ctor">
  5754. <summary>
  5755. Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class.
  5756. </summary>
  5757. <remarks>
  5758. This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class is set up to write
  5759. to a remote syslog daemon.
  5760. </remarks>
  5761. </member>
  5762. <member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)">
  5763. <summary>
  5764. Add a mapping of level to severity
  5765. </summary>
  5766. <param name="mapping">The mapping to add</param>
  5767. <remarks>
  5768. <para>
  5769. Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender.
  5770. </para>
  5771. </remarks>
  5772. </member>
  5773. <member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)">
  5774. <summary>
  5775. This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  5776. </summary>
  5777. <param name="loggingEvent">The event to log.</param>
  5778. <remarks>
  5779. <para>
  5780. Writes the event to a remote syslog daemon.
  5781. </para>
  5782. <para>
  5783. The format of the output will depend on the appender's layout.
  5784. </para>
  5785. </remarks>
  5786. </member>
  5787. <member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions">
  5788. <summary>
  5789. Initialize the options for this appender
  5790. </summary>
  5791. <remarks>
  5792. <para>
  5793. Initialize the level to syslog severity mappings set on this appender.
  5794. </para>
  5795. </remarks>
  5796. </member>
  5797. <member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)">
  5798. <summary>
  5799. Translates a log4net level to a syslog severity.
  5800. </summary>
  5801. <param name="level">A log4net level.</param>
  5802. <returns>A syslog severity.</returns>
  5803. <remarks>
  5804. <para>
  5805. Translates a log4net level to a syslog severity.
  5806. </para>
  5807. </remarks>
  5808. </member>
  5809. <member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)">
  5810. <summary>
  5811. Generate a syslog priority.
  5812. </summary>
  5813. <param name="facility">The syslog facility.</param>
  5814. <param name="severity">The syslog severity.</param>
  5815. <returns>A syslog priority.</returns>
  5816. <remarks>
  5817. <para>
  5818. Generate a syslog priority.
  5819. </para>
  5820. </remarks>
  5821. </member>
  5822. <member name="F:log4net.Appender.RemoteSyslogAppender.m_facility">
  5823. <summary>
  5824. The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  5825. </summary>
  5826. </member>
  5827. <member name="F:log4net.Appender.RemoteSyslogAppender.m_identity">
  5828. <summary>
  5829. The message identity
  5830. </summary>
  5831. </member>
  5832. <member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping">
  5833. <summary>
  5834. Mapping from level object to syslog severity
  5835. </summary>
  5836. </member>
  5837. <member name="P:log4net.Appender.RemoteSyslogAppender.Identity">
  5838. <summary>
  5839. Message identity
  5840. </summary>
  5841. <remarks>
  5842. <para>
  5843. An identifier is specified with each log message. This can be specified
  5844. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  5845. as the tag) must not contain white space. The default value for the
  5846. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  5847. </para>
  5848. </remarks>
  5849. </member>
  5850. <member name="P:log4net.Appender.RemoteSyslogAppender.Facility">
  5851. <summary>
  5852. Syslog facility
  5853. </summary>
  5854. <remarks>
  5855. Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of
  5856. facilities is predefined and cannot be extended. The default value
  5857. is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  5858. </remarks>
  5859. </member>
  5860. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity">
  5861. <summary>
  5862. syslog severities
  5863. </summary>
  5864. <remarks>
  5865. <para>
  5866. The syslog severities.
  5867. </para>
  5868. </remarks>
  5869. </member>
  5870. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency">
  5871. <summary>
  5872. system is unusable
  5873. </summary>
  5874. </member>
  5875. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert">
  5876. <summary>
  5877. action must be taken immediately
  5878. </summary>
  5879. </member>
  5880. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical">
  5881. <summary>
  5882. critical conditions
  5883. </summary>
  5884. </member>
  5885. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error">
  5886. <summary>
  5887. error conditions
  5888. </summary>
  5889. </member>
  5890. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning">
  5891. <summary>
  5892. warning conditions
  5893. </summary>
  5894. </member>
  5895. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice">
  5896. <summary>
  5897. normal but significant condition
  5898. </summary>
  5899. </member>
  5900. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational">
  5901. <summary>
  5902. informational
  5903. </summary>
  5904. </member>
  5905. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug">
  5906. <summary>
  5907. debug-level messages
  5908. </summary>
  5909. </member>
  5910. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility">
  5911. <summary>
  5912. syslog facilities
  5913. </summary>
  5914. <remarks>
  5915. <para>
  5916. The syslog facilities
  5917. </para>
  5918. </remarks>
  5919. </member>
  5920. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel">
  5921. <summary>
  5922. kernel messages
  5923. </summary>
  5924. </member>
  5925. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User">
  5926. <summary>
  5927. random user-level messages
  5928. </summary>
  5929. </member>
  5930. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail">
  5931. <summary>
  5932. mail system
  5933. </summary>
  5934. </member>
  5935. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons">
  5936. <summary>
  5937. system daemons
  5938. </summary>
  5939. </member>
  5940. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization">
  5941. <summary>
  5942. security/authorization messages
  5943. </summary>
  5944. </member>
  5945. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog">
  5946. <summary>
  5947. messages generated internally by syslogd
  5948. </summary>
  5949. </member>
  5950. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer">
  5951. <summary>
  5952. line printer subsystem
  5953. </summary>
  5954. </member>
  5955. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News">
  5956. <summary>
  5957. network news subsystem
  5958. </summary>
  5959. </member>
  5960. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp">
  5961. <summary>
  5962. UUCP subsystem
  5963. </summary>
  5964. </member>
  5965. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock">
  5966. <summary>
  5967. clock (cron/at) daemon
  5968. </summary>
  5969. </member>
  5970. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2">
  5971. <summary>
  5972. security/authorization messages (private)
  5973. </summary>
  5974. </member>
  5975. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp">
  5976. <summary>
  5977. ftp daemon
  5978. </summary>
  5979. </member>
  5980. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp">
  5981. <summary>
  5982. NTP subsystem
  5983. </summary>
  5984. </member>
  5985. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit">
  5986. <summary>
  5987. log audit
  5988. </summary>
  5989. </member>
  5990. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert">
  5991. <summary>
  5992. log alert
  5993. </summary>
  5994. </member>
  5995. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2">
  5996. <summary>
  5997. clock daemon
  5998. </summary>
  5999. </member>
  6000. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0">
  6001. <summary>
  6002. reserved for local use
  6003. </summary>
  6004. </member>
  6005. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1">
  6006. <summary>
  6007. reserved for local use
  6008. </summary>
  6009. </member>
  6010. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2">
  6011. <summary>
  6012. reserved for local use
  6013. </summary>
  6014. </member>
  6015. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3">
  6016. <summary>
  6017. reserved for local use
  6018. </summary>
  6019. </member>
  6020. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4">
  6021. <summary>
  6022. reserved for local use
  6023. </summary>
  6024. </member>
  6025. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5">
  6026. <summary>
  6027. reserved for local use
  6028. </summary>
  6029. </member>
  6030. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6">
  6031. <summary>
  6032. reserved for local use
  6033. </summary>
  6034. </member>
  6035. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7">
  6036. <summary>
  6037. reserved for local use
  6038. </summary>
  6039. </member>
  6040. <member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity">
  6041. <summary>
  6042. A class to act as a mapping between the level that a logging call is made at and
  6043. the syslog severity that is should be logged at.
  6044. </summary>
  6045. <remarks>
  6046. <para>
  6047. A class to act as a mapping between the level that a logging call is made at and
  6048. the syslog severity that is should be logged at.
  6049. </para>
  6050. </remarks>
  6051. </member>
  6052. <member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity">
  6053. <summary>
  6054. The mapped syslog severity for the specified level
  6055. </summary>
  6056. <remarks>
  6057. <para>
  6058. Required property.
  6059. The mapped syslog severity for the specified level
  6060. </para>
  6061. </remarks>
  6062. </member>
  6063. <member name="T:log4net.Appender.RemotingAppender">
  6064. <summary>
  6065. Delivers logging events to a remote logging sink.
  6066. </summary>
  6067. <remarks>
  6068. <para>
  6069. This Appender is designed to deliver events to a remote sink.
  6070. That is any object that implements the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6071. interface. It delivers the events using .NET remoting. The
  6072. object to deliver events to is specified by setting the
  6073. appenders <see cref="P:log4net.Appender.RemotingAppender.Sink"/> property.</para>
  6074. <para>
  6075. The RemotingAppender buffers events before sending them. This allows it to
  6076. make more efficient use of the remoting infrastructure.</para>
  6077. <para>
  6078. Once the buffer is full the events are still not sent immediately.
  6079. They are scheduled to be sent using a pool thread. The effect is that
  6080. the send occurs asynchronously. This is very important for a
  6081. number of non obvious reasons. The remoting infrastructure will
  6082. flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  6083. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  6084. remoting boundary. If the server is not contactable then
  6085. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  6086. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  6087. having side effects on the calling application the remoting call must be made
  6088. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  6089. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  6090. the events will block in the thread pool manager until a thread is available.</para>
  6091. <para>
  6092. Because the events are sent asynchronously using pool threads it is possible to close
  6093. this appender before all the queued events have been sent.
  6094. When closing the appender attempts to wait until all the queued events have been sent, but
  6095. this will timeout after 30 seconds regardless.</para>
  6096. <para>
  6097. If this appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
  6098. event has fired it may not be possible to send all the queued events. During process
  6099. exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
  6100. event handler is allowed to run for. If the runtime terminates the threads before
  6101. the queued events have been sent then they will be lost. To ensure that all events
  6102. are sent the appender must be closed before the application exits. See
  6103. <see cref="M:log4net.Core.LoggerManager.Shutdown"/> for details on how to shutdown
  6104. log4net programmatically.</para>
  6105. </remarks>
  6106. <seealso cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6107. <author>Nicko Cadell</author>
  6108. <author>Gert Driesen</author>
  6109. <author>Daniel Cazzulino</author>
  6110. </member>
  6111. <member name="M:log4net.Appender.RemotingAppender.#ctor">
  6112. <summary>
  6113. Initializes a new instance of the <see cref="T:log4net.Appender.RemotingAppender"/> class.
  6114. </summary>
  6115. <remarks>
  6116. <para>
  6117. Default constructor.
  6118. </para>
  6119. </remarks>
  6120. </member>
  6121. <member name="M:log4net.Appender.RemotingAppender.ActivateOptions">
  6122. <summary>
  6123. Initialize the appender based on the options set
  6124. </summary>
  6125. <remarks>
  6126. <para>
  6127. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6128. activation scheme. The <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> method must
  6129. be called on this object after the configuration properties have
  6130. been set. Until <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> is called this
  6131. object is in an undefined state and must not be used.
  6132. </para>
  6133. <para>
  6134. If any of the configuration properties are modified then
  6135. <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> must be called again.
  6136. </para>
  6137. </remarks>
  6138. </member>
  6139. <member name="M:log4net.Appender.RemotingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  6140. <summary>
  6141. Send the contents of the buffer to the remote sink.
  6142. </summary>
  6143. <remarks>
  6144. The events are not sent immediately. They are scheduled to be sent
  6145. using a pool thread. The effect is that the send occurs asynchronously.
  6146. This is very important for a number of non obvious reasons. The remoting
  6147. infrastructure will flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  6148. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  6149. remoting boundary. If the server is not contactable then
  6150. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  6151. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  6152. having side effects on the calling application the remoting call must be made
  6153. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  6154. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  6155. the events will block in the thread pool manager until a thread is available.
  6156. </remarks>
  6157. <param name="events">The events to send.</param>
  6158. </member>
  6159. <member name="M:log4net.Appender.RemotingAppender.OnClose">
  6160. <summary>
  6161. Override base class close.
  6162. </summary>
  6163. <remarks>
  6164. <para>
  6165. This method waits while there are queued work items. The events are
  6166. sent asynchronously using <see cref="T:System.Threading.ThreadPool"/> work items. These items
  6167. will be sent once a thread pool thread is available to send them, therefore
  6168. it is possible to close the appender before all the queued events have been
  6169. sent.</para>
  6170. <para>
  6171. This method attempts to wait until all the queued events have been sent, but this
  6172. method will timeout after 30 seconds regardless.</para>
  6173. <para>
  6174. If the appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
  6175. event has fired it may not be possible to send all the queued events. During process
  6176. exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
  6177. event handler is allowed to run for.</para>
  6178. </remarks>
  6179. </member>
  6180. <member name="M:log4net.Appender.RemotingAppender.BeginAsyncSend">
  6181. <summary>
  6182. A work item is being queued into the thread pool
  6183. </summary>
  6184. </member>
  6185. <member name="M:log4net.Appender.RemotingAppender.EndAsyncSend">
  6186. <summary>
  6187. A work item from the thread pool has completed
  6188. </summary>
  6189. </member>
  6190. <member name="M:log4net.Appender.RemotingAppender.SendBufferCallback(System.Object)">
  6191. <summary>
  6192. Send the contents of the buffer to the remote sink.
  6193. </summary>
  6194. <remarks>
  6195. This method is designed to be used with the <see cref="T:System.Threading.ThreadPool"/>.
  6196. This method expects to be passed an array of <see cref="T:log4net.Core.LoggingEvent"/>
  6197. objects in the state param.
  6198. </remarks>
  6199. <param name="state">the logging events to send</param>
  6200. </member>
  6201. <member name="F:log4net.Appender.RemotingAppender.m_sinkUrl">
  6202. <summary>
  6203. The URL of the remote sink.
  6204. </summary>
  6205. </member>
  6206. <member name="F:log4net.Appender.RemotingAppender.m_sinkObj">
  6207. <summary>
  6208. The local proxy (.NET remoting) for the remote logging sink.
  6209. </summary>
  6210. </member>
  6211. <member name="F:log4net.Appender.RemotingAppender.m_queuedCallbackCount">
  6212. <summary>
  6213. The number of queued callbacks currently waiting or executing
  6214. </summary>
  6215. </member>
  6216. <member name="F:log4net.Appender.RemotingAppender.m_workQueueEmptyEvent">
  6217. <summary>
  6218. Event used to signal when there are no queued work items
  6219. </summary>
  6220. <remarks>
  6221. This event is set when there are no queued work items. In this
  6222. state it is safe to close the appender.
  6223. </remarks>
  6224. </member>
  6225. <member name="P:log4net.Appender.RemotingAppender.Sink">
  6226. <summary>
  6227. Gets or sets the URL of the well-known object that will accept
  6228. the logging events.
  6229. </summary>
  6230. <value>
  6231. The well-known URL of the remote sink.
  6232. </value>
  6233. <remarks>
  6234. <para>
  6235. The URL of the remoting sink that will accept logging events.
  6236. The sink must implement the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6237. interface.
  6238. </para>
  6239. </remarks>
  6240. </member>
  6241. <member name="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink">
  6242. <summary>
  6243. Interface used to deliver <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
  6244. </summary>
  6245. <remarks>
  6246. This interface must be implemented by a remoting sink
  6247. if the <see cref="T:log4net.Appender.RemotingAppender"/> is to be used
  6248. to deliver logging events to the sink.
  6249. </remarks>
  6250. </member>
  6251. <member name="M:log4net.Appender.RemotingAppender.IRemoteLoggingSink.LogEvents(log4net.Core.LoggingEvent[])">
  6252. <summary>
  6253. Delivers logging events to the remote sink
  6254. </summary>
  6255. <param name="events">Array of events to log.</param>
  6256. <remarks>
  6257. <para>
  6258. Delivers logging events to the remote sink
  6259. </para>
  6260. </remarks>
  6261. </member>
  6262. <member name="T:log4net.Appender.RollingFileAppender">
  6263. <summary>
  6264. Appender that rolls log files based on size or date or both.
  6265. </summary>
  6266. <remarks>
  6267. <para>
  6268. RollingFileAppender can roll log files based on size or date or both
  6269. depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property.
  6270. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled
  6271. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  6272. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled
  6273. once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  6274. is crossed.
  6275. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be
  6276. rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  6277. is crossed, but within a date boundary the file will also be rolled
  6278. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  6279. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when
  6280. the appender is configured. This effectively means that the log file can be
  6281. rolled once per program execution.
  6282. </para>
  6283. <para>
  6284. A of few additional optional features have been added:
  6285. <list type="bullet">
  6286. <item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item>
  6287. <item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item>
  6288. <item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item>
  6289. </list>
  6290. </para>
  6291. <note>
  6292. <para>
  6293. For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/>
  6294. greater than zero is highly recommended, otherwise all the backup files need
  6295. to be renamed each time a new backup is created.
  6296. </para>
  6297. <para>
  6298. When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  6299. to <see langword="true"/> will reduce the number of file renamings to few or none.
  6300. </para>
  6301. </note>
  6302. <note type="caution">
  6303. <para>
  6304. Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing
  6305. the log file directory of backup files will cause unexpected and unwanted side effects.
  6306. </para>
  6307. </note>
  6308. <para>
  6309. If Date/Time based rolling is enabled this appender will attempt to roll existing files
  6310. in the directory without a Date/Time tag based on the last write date of the base log file.
  6311. The appender only rolls the log file when a message is logged. If Date/Time based rolling
  6312. is enabled then the appender will not roll the log file at the Date/Time boundary but
  6313. at the point when the next message is logged after the boundary has been crossed.
  6314. </para>
  6315. <para>
  6316. The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and
  6317. has the same behavior when opening the log file.
  6318. The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>
  6319. is called. This will typically be during configuration.
  6320. If the file cannot be opened for writing the appender will attempt
  6321. to open the file again each time a message is logged to the appender.
  6322. If the file cannot be opened for writing when a message is logged then
  6323. the message will be discarded by this appender.
  6324. </para>
  6325. <para>
  6326. When rolling a backup file necessitates deleting an older backup file the
  6327. file to be deleted is moved to a temporary name before being deleted.
  6328. </para>
  6329. <note type="caution">
  6330. <para>
  6331. A maximum number of backup files when rolling on date/time boundaries is not supported.
  6332. </para>
  6333. </note>
  6334. </remarks>
  6335. <author>Nicko Cadell</author>
  6336. <author>Gert Driesen</author>
  6337. <author>Aspi Havewala</author>
  6338. <author>Douglas de la Torre</author>
  6339. <author>Edward Smit</author>
  6340. </member>
  6341. <member name="M:log4net.Appender.RollingFileAppender.#ctor">
  6342. <summary>
  6343. Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender"/> class.
  6344. </summary>
  6345. <remarks>
  6346. <para>
  6347. Default constructor.
  6348. </para>
  6349. </remarks>
  6350. </member>
  6351. <member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)">
  6352. <summary>
  6353. Sets the quiet writer being used.
  6354. </summary>
  6355. <remarks>
  6356. This method can be overridden by sub classes.
  6357. </remarks>
  6358. <param name="writer">the writer to set</param>
  6359. </member>
  6360. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)">
  6361. <summary>
  6362. Write out a logging event.
  6363. </summary>
  6364. <param name="loggingEvent">the event to write to file.</param>
  6365. <remarks>
  6366. <para>
  6367. Handles append time behavior for RollingFileAppender. This checks
  6368. if a roll over either by date (checked first) or time (checked second)
  6369. is need and then appends to the file last.
  6370. </para>
  6371. </remarks>
  6372. </member>
  6373. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])">
  6374. <summary>
  6375. Write out an array of logging events.
  6376. </summary>
  6377. <param name="loggingEvents">the events to write to file.</param>
  6378. <remarks>
  6379. <para>
  6380. Handles append time behavior for RollingFileAppender. This checks
  6381. if a roll over either by date (checked first) or time (checked second)
  6382. is need and then appends to the file last.
  6383. </para>
  6384. </remarks>
  6385. </member>
  6386. <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend">
  6387. <summary>
  6388. Performs any required rolling before outputting the next event
  6389. </summary>
  6390. <remarks>
  6391. <para>
  6392. Handles append time behavior for RollingFileAppender. This checks
  6393. if a roll over either by date (checked first) or time (checked second)
  6394. is need and then appends to the file last.
  6395. </para>
  6396. </remarks>
  6397. </member>
  6398. <member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)">
  6399. <summary>
  6400. Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  6401. is false then the fully qualified name is determined and used.
  6402. </summary>
  6403. <param name="fileName">the name of the file to open</param>
  6404. <param name="append">true to append to existing file</param>
  6405. <remarks>
  6406. <para>This method will ensure that the directory structure
  6407. for the <paramref name="fileName"/> specified exists.</para>
  6408. </remarks>
  6409. </member>
  6410. <member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)">
  6411. <summary>
  6412. Get the current output file name
  6413. </summary>
  6414. <param name="fileName">the base file name</param>
  6415. <returns>the output file name</returns>
  6416. <remarks>
  6417. The output file name is based on the base fileName specified.
  6418. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output
  6419. file name is the same as the base file passed in. Otherwise
  6420. the output file depends on the date pattern, on the count
  6421. direction or both.
  6422. </remarks>
  6423. </member>
  6424. <member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups">
  6425. <summary>
  6426. Determines curSizeRollBackups (only within the current roll point)
  6427. </summary>
  6428. </member>
  6429. <member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)">
  6430. <summary>
  6431. Generates a wildcard pattern that can be used to find all files
  6432. that are similar to the base file name.
  6433. </summary>
  6434. <param name="baseFileName"></param>
  6435. <returns></returns>
  6436. </member>
  6437. <member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)">
  6438. <summary>
  6439. Builds a list of filenames for all files matching the base filename plus a file
  6440. pattern.
  6441. </summary>
  6442. <param name="baseFilePath"></param>
  6443. <returns></returns>
  6444. </member>
  6445. <member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing">
  6446. <summary>
  6447. Initiates a roll over if needed for crossing a date boundary since the last run.
  6448. </summary>
  6449. </member>
  6450. <member name="M:log4net.Appender.RollingFileAppender.ExistingInit">
  6451. <summary>
  6452. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  6453. </summary>
  6454. <remarks>
  6455. <para>
  6456. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  6457. The following is done
  6458. <list type="bullet">
  6459. <item>determine curSizeRollBackups (only within the current roll point)</item>
  6460. <item>initiates a roll over if needed for crossing a date boundary since the last run.</item>
  6461. </list>
  6462. </para>
  6463. </remarks>
  6464. </member>
  6465. <member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)">
  6466. <summary>
  6467. Does the work of bumping the 'current' file counter higher
  6468. to the highest count when an incremental file name is seen.
  6469. The highest count is either the first file (when count direction
  6470. is greater than 0) or the last file (when count direction less than 0).
  6471. In either case, we want to know the highest count that is present.
  6472. </summary>
  6473. <param name="baseFile"></param>
  6474. <param name="curFileName"></param>
  6475. </member>
  6476. <member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)">
  6477. <summary>
  6478. Takes a list of files and a base file name, and looks for
  6479. 'incremented' versions of the base file. Bumps the max
  6480. count up to the highest count seen.
  6481. </summary>
  6482. <param name="baseFile"></param>
  6483. <param name="arrayFiles"></param>
  6484. </member>
  6485. <member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)">
  6486. <summary>
  6487. Calculates the RollPoint for the datePattern supplied.
  6488. </summary>
  6489. <param name="datePattern">the date pattern to calculate the check period for</param>
  6490. <returns>The RollPoint that is most accurate for the date pattern supplied</returns>
  6491. <remarks>
  6492. Essentially the date pattern is examined to determine what the
  6493. most suitable roll point is. The roll point chosen is the roll point
  6494. with the smallest period that can be detected using the date pattern
  6495. supplied. i.e. if the date pattern only outputs the year, month, day
  6496. and hour then the smallest roll point that can be detected would be
  6497. and hourly roll point as minutes could not be detected.
  6498. </remarks>
  6499. </member>
  6500. <member name="M:log4net.Appender.RollingFileAppender.ActivateOptions">
  6501. <summary>
  6502. Initialize the appender based on the options set
  6503. </summary>
  6504. <remarks>
  6505. <para>
  6506. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6507. activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must
  6508. be called on this object after the configuration properties have
  6509. been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this
  6510. object is in an undefined state and must not be used.
  6511. </para>
  6512. <para>
  6513. If any of the configuration properties are modified then
  6514. <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again.
  6515. </para>
  6516. <para>
  6517. Sets initial conditions including date/time roll over information, first check,
  6518. scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize
  6519. the current number of backups.
  6520. </para>
  6521. </remarks>
  6522. </member>
  6523. <member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)">
  6524. <summary>
  6525. Rollover the file(s) to date/time tagged file(s).
  6526. </summary>
  6527. <param name="fileIsOpen">set to true if the file to be rolled is currently open</param>
  6528. <remarks>
  6529. <para>
  6530. Rollover the file(s) to date/time tagged file(s).
  6531. Resets curSizeRollBackups.
  6532. If fileIsOpen is set then the new file is opened (through SafeOpenFile).
  6533. </para>
  6534. </remarks>
  6535. </member>
  6536. <member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)">
  6537. <summary>
  6538. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>.
  6539. </summary>
  6540. <param name="fromFile">Name of existing file to roll.</param>
  6541. <param name="toFile">New name for file.</param>
  6542. <remarks>
  6543. <para>
  6544. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It
  6545. also checks for existence of target file and deletes if it does.
  6546. </para>
  6547. </remarks>
  6548. </member>
  6549. <member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)">
  6550. <summary>
  6551. Test if a file exists at a specified path
  6552. </summary>
  6553. <param name="path">the path to the file</param>
  6554. <returns>true if the file exists</returns>
  6555. <remarks>
  6556. <para>
  6557. Test if a file exists at a specified path
  6558. </para>
  6559. </remarks>
  6560. </member>
  6561. <member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)">
  6562. <summary>
  6563. Deletes the specified file if it exists.
  6564. </summary>
  6565. <param name="fileName">The file to delete.</param>
  6566. <remarks>
  6567. <para>
  6568. Delete a file if is exists.
  6569. The file is first moved to a new filename then deleted.
  6570. This allows the file to be removed even when it cannot
  6571. be deleted, but it still can be moved.
  6572. </para>
  6573. </remarks>
  6574. </member>
  6575. <member name="M:log4net.Appender.RollingFileAppender.RollOverSize">
  6576. <summary>
  6577. Implements file roll base on file size.
  6578. </summary>
  6579. <remarks>
  6580. <para>
  6581. If the maximum number of size based backups is reached
  6582. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  6583. file is deleted -- its index determined by the sign of countDirection.
  6584. If <c>countDirection</c> &lt; 0, then files
  6585. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  6586. are renamed to {<c>File.2</c>, ...,
  6587. <c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is
  6588. renamed <c>File.1</c> and closed.
  6589. </para>
  6590. <para>
  6591. A new file is created to receive further log output.
  6592. </para>
  6593. <para>
  6594. If <c>maxSizeRollBackups</c> is equal to zero, then the
  6595. <c>File</c> is truncated with no backup files created.
  6596. </para>
  6597. <para>
  6598. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  6599. renamed if needed and no files are deleted.
  6600. </para>
  6601. </remarks>
  6602. </member>
  6603. <member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)">
  6604. <summary>
  6605. Implements file roll.
  6606. </summary>
  6607. <param name="baseFileName">the base name to rename</param>
  6608. <remarks>
  6609. <para>
  6610. If the maximum number of size based backups is reached
  6611. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  6612. file is deleted -- its index determined by the sign of countDirection.
  6613. If <c>countDirection</c> &lt; 0, then files
  6614. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  6615. are renamed to {<c>File.2</c>, ...,
  6616. <c>File.curSizeRollBackups</c>}.
  6617. </para>
  6618. <para>
  6619. If <c>maxSizeRollBackups</c> is equal to zero, then the
  6620. <c>File</c> is truncated with no backup files created.
  6621. </para>
  6622. <para>
  6623. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  6624. renamed if needed and no files are deleted.
  6625. </para>
  6626. <para>
  6627. This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files.
  6628. </para>
  6629. </remarks>
  6630. </member>
  6631. <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)">
  6632. <summary>
  6633. Get the start time of the next window for the current rollpoint
  6634. </summary>
  6635. <param name="currentDateTime">the current date</param>
  6636. <param name="rollPoint">the type of roll point we are working with</param>
  6637. <returns>the start time for the next roll point an interval after the currentDateTime date</returns>
  6638. <remarks>
  6639. <para>
  6640. Returns the date of the next roll point after the currentDateTime date passed to the method.
  6641. </para>
  6642. <para>
  6643. The basic strategy is to subtract the time parts that are less significant
  6644. than the rollpoint from the current time. This should roll the time back to
  6645. the start of the time window for the current rollpoint. Then we add 1 window
  6646. worth of time and get the start time of the next window for the rollpoint.
  6647. </para>
  6648. </remarks>
  6649. </member>
  6650. <member name="F:log4net.Appender.RollingFileAppender.m_dateTime">
  6651. <summary>
  6652. This object supplies the current date/time. Allows test code to plug in
  6653. a method to control this class when testing date/time based rolling.
  6654. </summary>
  6655. </member>
  6656. <member name="F:log4net.Appender.RollingFileAppender.m_datePattern">
  6657. <summary>
  6658. The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c>
  6659. meaning daily rollover.
  6660. </summary>
  6661. </member>
  6662. <member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename">
  6663. <summary>
  6664. The actual formatted filename that is currently being written to
  6665. or will be the file transferred to on roll over
  6666. (based on staticLogFileName).
  6667. </summary>
  6668. </member>
  6669. <member name="F:log4net.Appender.RollingFileAppender.m_nextCheck">
  6670. <summary>
  6671. The timestamp when we shall next recompute the filename.
  6672. </summary>
  6673. </member>
  6674. <member name="F:log4net.Appender.RollingFileAppender.m_now">
  6675. <summary>
  6676. Holds date of last roll over
  6677. </summary>
  6678. </member>
  6679. <member name="F:log4net.Appender.RollingFileAppender.m_rollPoint">
  6680. <summary>
  6681. The type of rolling done
  6682. </summary>
  6683. </member>
  6684. <member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize">
  6685. <summary>
  6686. The default maximum file size is 10MB
  6687. </summary>
  6688. </member>
  6689. <member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups">
  6690. <summary>
  6691. There is zero backup files by default
  6692. </summary>
  6693. </member>
  6694. <member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups">
  6695. <summary>
  6696. How many sized based backups have been made so far
  6697. </summary>
  6698. </member>
  6699. <member name="F:log4net.Appender.RollingFileAppender.m_countDirection">
  6700. <summary>
  6701. The rolling file count direction.
  6702. </summary>
  6703. </member>
  6704. <member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle">
  6705. <summary>
  6706. The rolling mode used in this appender.
  6707. </summary>
  6708. </member>
  6709. <member name="F:log4net.Appender.RollingFileAppender.m_rollDate">
  6710. <summary>
  6711. Cache flag set if we are rolling by date.
  6712. </summary>
  6713. </member>
  6714. <member name="F:log4net.Appender.RollingFileAppender.m_rollSize">
  6715. <summary>
  6716. Cache flag set if we are rolling by size.
  6717. </summary>
  6718. </member>
  6719. <member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName">
  6720. <summary>
  6721. Value indicating whether to always log to the same file.
  6722. </summary>
  6723. </member>
  6724. <member name="F:log4net.Appender.RollingFileAppender.m_baseFileName">
  6725. <summary>
  6726. FileName provided in configuration. Used for rolling properly
  6727. </summary>
  6728. </member>
  6729. <member name="F:log4net.Appender.RollingFileAppender.s_date1970">
  6730. <summary>
  6731. The 1st of January 1970 in UTC
  6732. </summary>
  6733. </member>
  6734. <member name="P:log4net.Appender.RollingFileAppender.DatePattern">
  6735. <summary>
  6736. Gets or sets the date pattern to be used for generating file names
  6737. when rolling over on date.
  6738. </summary>
  6739. <value>
  6740. The date pattern to be used for generating file names when rolling
  6741. over on date.
  6742. </value>
  6743. <remarks>
  6744. <para>
  6745. Takes a string in the same format as expected by
  6746. <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/>.
  6747. </para>
  6748. <para>
  6749. This property determines the rollover schedule when rolling over
  6750. on date.
  6751. </para>
  6752. </remarks>
  6753. </member>
  6754. <member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups">
  6755. <summary>
  6756. Gets or sets the maximum number of backup files that are kept before
  6757. the oldest is erased.
  6758. </summary>
  6759. <value>
  6760. The maximum number of backup files that are kept before the oldest is
  6761. erased.
  6762. </value>
  6763. <remarks>
  6764. <para>
  6765. If set to zero, then there will be no backup files and the log file
  6766. will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>.
  6767. </para>
  6768. <para>
  6769. If a negative number is supplied then no deletions will be made. Note
  6770. that this could result in very slow performance as a large number of
  6771. files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used.
  6772. </para>
  6773. <para>
  6774. The maximum applies to <b>each</b> time based group of files and
  6775. <b>not</b> the total.
  6776. </para>
  6777. </remarks>
  6778. </member>
  6779. <member name="P:log4net.Appender.RollingFileAppender.MaxFileSize">
  6780. <summary>
  6781. Gets or sets the maximum size that the output file is allowed to reach
  6782. before being rolled over to backup files.
  6783. </summary>
  6784. <value>
  6785. The maximum size in bytes that the output file is allowed to reach before being
  6786. rolled over to backup files.
  6787. </value>
  6788. <remarks>
  6789. <para>
  6790. This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except
  6791. that it is required for differentiating the setter taking a
  6792. <see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/>
  6793. argument.
  6794. </para>
  6795. <para>
  6796. The default maximum file size is 10MB (10*1024*1024).
  6797. </para>
  6798. </remarks>
  6799. </member>
  6800. <member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize">
  6801. <summary>
  6802. Gets or sets the maximum size that the output file is allowed to reach
  6803. before being rolled over to backup files.
  6804. </summary>
  6805. <value>
  6806. The maximum size that the output file is allowed to reach before being
  6807. rolled over to backup files.
  6808. </value>
  6809. <remarks>
  6810. <para>
  6811. This property allows you to specify the maximum size with the
  6812. suffixes "KB", "MB" or "GB" so that the size is interpreted being
  6813. expressed respectively in kilobytes, megabytes or gigabytes.
  6814. </para>
  6815. <para>
  6816. For example, the value "10KB" will be interpreted as 10240 bytes.
  6817. </para>
  6818. <para>
  6819. The default maximum file size is 10MB.
  6820. </para>
  6821. <para>
  6822. If you have the option to set the maximum file size programmatically
  6823. consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this
  6824. allows you to set the size in bytes as a <see cref="T:System.Int64"/>.
  6825. </para>
  6826. </remarks>
  6827. </member>
  6828. <member name="P:log4net.Appender.RollingFileAppender.CountDirection">
  6829. <summary>
  6830. Gets or sets the rolling file count direction.
  6831. </summary>
  6832. <value>
  6833. The rolling file count direction.
  6834. </value>
  6835. <remarks>
  6836. <para>
  6837. Indicates if the current file is the lowest numbered file or the
  6838. highest numbered file.
  6839. </para>
  6840. <para>
  6841. By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &lt; 0),
  6842. i.e. log.1 is most recent, log.5 is the 5th backup, etc...
  6843. </para>
  6844. <para>
  6845. <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &gt;= 0 does the opposite i.e.
  6846. log.1 is the first backup made, log.5 is the 5th backup made, etc.
  6847. For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &gt;= 0 to reduce
  6848. rollover costs.
  6849. </para>
  6850. <para>The default file count direction is -1.</para>
  6851. </remarks>
  6852. </member>
  6853. <member name="P:log4net.Appender.RollingFileAppender.RollingStyle">
  6854. <summary>
  6855. Gets or sets the rolling style.
  6856. </summary>
  6857. <value>The rolling style.</value>
  6858. <remarks>
  6859. <para>
  6860. The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/>.
  6861. </para>
  6862. <para>
  6863. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's
  6864. <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise
  6865. the appender would append to a single file rather than rolling
  6866. the file each time it is opened.
  6867. </para>
  6868. </remarks>
  6869. </member>
  6870. <member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName">
  6871. <summary>
  6872. Gets or sets a value indicating whether to always log to
  6873. the same file.
  6874. </summary>
  6875. <value>
  6876. <c>true</c> if always should be logged to the same file, otherwise <c>false</c>.
  6877. </value>
  6878. <remarks>
  6879. <para>
  6880. By default file.log is always the current file. Optionally
  6881. file.log.yyyy-mm-dd for current formatted datePattern can by the currently
  6882. logging file (or file.log.curSizeRollBackup or even
  6883. file.log.yyyy-mm-dd.curSizeRollBackup).
  6884. </para>
  6885. <para>
  6886. This will make time based rollovers with a large number of backups
  6887. much faster as the appender it won't have to rename all the backups!
  6888. </para>
  6889. </remarks>
  6890. </member>
  6891. <member name="T:log4net.Appender.RollingFileAppender.RollingMode">
  6892. <summary>
  6893. Style of rolling to use
  6894. </summary>
  6895. <remarks>
  6896. <para>
  6897. Style of rolling to use
  6898. </para>
  6899. </remarks>
  6900. </member>
  6901. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once">
  6902. <summary>
  6903. Roll files once per program execution
  6904. </summary>
  6905. <remarks>
  6906. <para>
  6907. Roll files once per program execution.
  6908. Well really once each time this appender is
  6909. configured.
  6910. </para>
  6911. <para>
  6912. Setting this option also sets <c>AppendToFile</c> to
  6913. <c>false</c> on the <c>RollingFileAppender</c>, otherwise
  6914. this appender would just be a normal file appender.
  6915. </para>
  6916. </remarks>
  6917. </member>
  6918. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size">
  6919. <summary>
  6920. Roll files based only on the size of the file
  6921. </summary>
  6922. </member>
  6923. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date">
  6924. <summary>
  6925. Roll files based only on the date
  6926. </summary>
  6927. </member>
  6928. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite">
  6929. <summary>
  6930. Roll files based on both the size and date of the file
  6931. </summary>
  6932. </member>
  6933. <member name="T:log4net.Appender.RollingFileAppender.RollPoint">
  6934. <summary>
  6935. The code assumes that the following 'time' constants are in a increasing sequence.
  6936. </summary>
  6937. <remarks>
  6938. <para>
  6939. The code assumes that the following 'time' constants are in a increasing sequence.
  6940. </para>
  6941. </remarks>
  6942. </member>
  6943. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint">
  6944. <summary>
  6945. Roll the log not based on the date
  6946. </summary>
  6947. </member>
  6948. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute">
  6949. <summary>
  6950. Roll the log for each minute
  6951. </summary>
  6952. </member>
  6953. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour">
  6954. <summary>
  6955. Roll the log for each hour
  6956. </summary>
  6957. </member>
  6958. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay">
  6959. <summary>
  6960. Roll the log twice a day (midday and midnight)
  6961. </summary>
  6962. </member>
  6963. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay">
  6964. <summary>
  6965. Roll the log each day (midnight)
  6966. </summary>
  6967. </member>
  6968. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek">
  6969. <summary>
  6970. Roll the log each week
  6971. </summary>
  6972. </member>
  6973. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth">
  6974. <summary>
  6975. Roll the log each month
  6976. </summary>
  6977. </member>
  6978. <member name="T:log4net.Appender.RollingFileAppender.IDateTime">
  6979. <summary>
  6980. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  6981. </summary>
  6982. <remarks>
  6983. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  6984. Used primarily to allow test classes to plug themselves in so they can
  6985. supply test date/times.
  6986. </remarks>
  6987. </member>
  6988. <member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now">
  6989. <summary>
  6990. Gets the <i>current</i> time.
  6991. </summary>
  6992. <value>The <i>current</i> time.</value>
  6993. <remarks>
  6994. <para>
  6995. Gets the <i>current</i> time.
  6996. </para>
  6997. </remarks>
  6998. </member>
  6999. <member name="T:log4net.Appender.RollingFileAppender.DefaultDateTime">
  7000. <summary>
  7001. Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time.
  7002. </summary>
  7003. </member>
  7004. <member name="P:log4net.Appender.RollingFileAppender.DefaultDateTime.Now">
  7005. <summary>
  7006. Gets the <b>current</b> time.
  7007. </summary>
  7008. <value>The <b>current</b> time.</value>
  7009. <remarks>
  7010. <para>
  7011. Gets the <b>current</b> time.
  7012. </para>
  7013. </remarks>
  7014. </member>
  7015. <member name="T:log4net.Appender.SmtpAppender">
  7016. <summary>
  7017. Send an e-mail when a specific logging event occurs, typically on errors
  7018. or fatal errors.
  7019. </summary>
  7020. <remarks>
  7021. <para>
  7022. The number of logging events delivered in this e-mail depend on
  7023. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  7024. <see cref="T:log4net.Appender.SmtpAppender"/> keeps only the last
  7025. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  7026. cyclic buffer. This keeps memory requirements at a reasonable level while
  7027. still delivering useful application context.
  7028. </para>
  7029. <note type="caution">
  7030. Authentication and setting the server Port are only available on the MS .NET 1.1 runtime.
  7031. For these features to be enabled you need to ensure that you are using a version of
  7032. the log4net assembly that is built against the MS .NET 1.1 framework and that you are
  7033. running the your application on the MS .NET 1.1 runtime. On all other platforms only sending
  7034. unauthenticated messages to a server listening on port 25 (the default) is supported.
  7035. </note>
  7036. <para>
  7037. Authentication is supported by setting the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property to
  7038. either <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> or <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  7039. If using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> authentication then the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  7040. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> properties must also be set.
  7041. </para>
  7042. <para>
  7043. To set the SMTP server port use the <see cref="P:log4net.Appender.SmtpAppender.Port"/> property. The default port is 25.
  7044. </para>
  7045. </remarks>
  7046. <author>Nicko Cadell</author>
  7047. <author>Gert Driesen</author>
  7048. </member>
  7049. <member name="M:log4net.Appender.SmtpAppender.#ctor">
  7050. <summary>
  7051. Default constructor
  7052. </summary>
  7053. <remarks>
  7054. <para>
  7055. Default constructor
  7056. </para>
  7057. </remarks>
  7058. </member>
  7059. <member name="M:log4net.Appender.SmtpAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  7060. <summary>
  7061. Sends the contents of the cyclic buffer as an e-mail message.
  7062. </summary>
  7063. <param name="events">The logging events to send.</param>
  7064. </member>
  7065. <member name="M:log4net.Appender.SmtpAppender.SendEmail(System.String)">
  7066. <summary>
  7067. Send the email message
  7068. </summary>
  7069. <param name="messageBody">the body text to include in the mail</param>
  7070. </member>
  7071. <member name="P:log4net.Appender.SmtpAppender.To">
  7072. <summary>
  7073. Gets or sets a semicolon-delimited list of recipient e-mail addresses.
  7074. </summary>
  7075. <value>
  7076. A semicolon-delimited list of e-mail addresses.
  7077. </value>
  7078. <remarks>
  7079. <para>
  7080. A semicolon-delimited list of recipient e-mail addresses.
  7081. </para>
  7082. </remarks>
  7083. </member>
  7084. <member name="P:log4net.Appender.SmtpAppender.From">
  7085. <summary>
  7086. Gets or sets the e-mail address of the sender.
  7087. </summary>
  7088. <value>
  7089. The e-mail address of the sender.
  7090. </value>
  7091. <remarks>
  7092. <para>
  7093. The e-mail address of the sender.
  7094. </para>
  7095. </remarks>
  7096. </member>
  7097. <member name="P:log4net.Appender.SmtpAppender.Subject">
  7098. <summary>
  7099. Gets or sets the subject line of the e-mail message.
  7100. </summary>
  7101. <value>
  7102. The subject line of the e-mail message.
  7103. </value>
  7104. <remarks>
  7105. <para>
  7106. The subject line of the e-mail message.
  7107. </para>
  7108. </remarks>
  7109. </member>
  7110. <member name="P:log4net.Appender.SmtpAppender.SmtpHost">
  7111. <summary>
  7112. Gets or sets the name of the SMTP relay mail server to use to send
  7113. the e-mail messages.
  7114. </summary>
  7115. <value>
  7116. The name of the e-mail relay server. If SmtpServer is not set, the
  7117. name of the local SMTP server is used.
  7118. </value>
  7119. <remarks>
  7120. <para>
  7121. The name of the e-mail relay server. If SmtpServer is not set, the
  7122. name of the local SMTP server is used.
  7123. </para>
  7124. </remarks>
  7125. </member>
  7126. <member name="P:log4net.Appender.SmtpAppender.LocationInfo">
  7127. <summary>
  7128. Obsolete
  7129. </summary>
  7130. <remarks>
  7131. Use the BufferingAppenderSkeleton Fix methods instead
  7132. </remarks>
  7133. <remarks>
  7134. <para>
  7135. Obsolete property.
  7136. </para>
  7137. </remarks>
  7138. </member>
  7139. <member name="P:log4net.Appender.SmtpAppender.Authentication">
  7140. <summary>
  7141. The mode to use to authentication with the SMTP server
  7142. </summary>
  7143. <remarks>
  7144. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7145. <para>
  7146. Valid Authentication mode values are: <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>,
  7147. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, and <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  7148. The default value is <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>. When using
  7149. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> you must specify the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  7150. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> to use to authenticate.
  7151. When using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/> the Windows credentials for the current
  7152. thread, if impersonating, or the process will be used to authenticate.
  7153. </para>
  7154. </remarks>
  7155. </member>
  7156. <member name="P:log4net.Appender.SmtpAppender.Username">
  7157. <summary>
  7158. The username to use to authenticate with the SMTP server
  7159. </summary>
  7160. <remarks>
  7161. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7162. <para>
  7163. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7164. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7165. otherwise the username will be ignored.
  7166. </para>
  7167. </remarks>
  7168. </member>
  7169. <member name="P:log4net.Appender.SmtpAppender.Password">
  7170. <summary>
  7171. The password to use to authenticate with the SMTP server
  7172. </summary>
  7173. <remarks>
  7174. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7175. <para>
  7176. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7177. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7178. otherwise the password will be ignored.
  7179. </para>
  7180. </remarks>
  7181. </member>
  7182. <member name="P:log4net.Appender.SmtpAppender.Port">
  7183. <summary>
  7184. The port on which the SMTP server is listening
  7185. </summary>
  7186. <remarks>
  7187. <note type="caution">Server Port is only available on the MS .NET 1.1 runtime.</note>
  7188. <para>
  7189. The port on which the SMTP server is listening. The default
  7190. port is <c>25</c>. The Port can only be changed when running on
  7191. the MS .NET 1.1 runtime.
  7192. </para>
  7193. </remarks>
  7194. </member>
  7195. <member name="P:log4net.Appender.SmtpAppender.Priority">
  7196. <summary>
  7197. Gets or sets the priority of the e-mail message
  7198. </summary>
  7199. <value>
  7200. One of the <see cref="T:System.Net.Mail.MailPriority"/> values.
  7201. </value>
  7202. <remarks>
  7203. <para>
  7204. Sets the priority of the e-mails generated by this
  7205. appender. The default priority is <see cref="F:System.Net.Mail.MailPriority.Normal"/>.
  7206. </para>
  7207. <para>
  7208. If you are using this appender to report errors then
  7209. you may want to set the priority to <see cref="F:System.Net.Mail.MailPriority.High"/>.
  7210. </para>
  7211. </remarks>
  7212. </member>
  7213. <member name="P:log4net.Appender.SmtpAppender.RequiresLayout">
  7214. <summary>
  7215. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7216. </summary>
  7217. <value><c>true</c></value>
  7218. <remarks>
  7219. <para>
  7220. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7221. </para>
  7222. </remarks>
  7223. </member>
  7224. <member name="T:log4net.Appender.SmtpAppender.SmtpAuthentication">
  7225. <summary>
  7226. Values for the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property.
  7227. </summary>
  7228. <remarks>
  7229. <para>
  7230. SMTP authentication modes.
  7231. </para>
  7232. </remarks>
  7233. </member>
  7234. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None">
  7235. <summary>
  7236. No authentication
  7237. </summary>
  7238. </member>
  7239. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic">
  7240. <summary>
  7241. Basic authentication.
  7242. </summary>
  7243. <remarks>
  7244. Requires a username and password to be supplied
  7245. </remarks>
  7246. </member>
  7247. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm">
  7248. <summary>
  7249. Integrated authentication
  7250. </summary>
  7251. <remarks>
  7252. Uses the Windows credentials from the current thread or process to authenticate.
  7253. </remarks>
  7254. </member>
  7255. <member name="T:log4net.Appender.SmtpPickupDirAppender">
  7256. <summary>
  7257. Send an email when a specific logging event occurs, typically on errors
  7258. or fatal errors. Rather than sending via smtp it writes a file into the
  7259. directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such
  7260. as the IIS SMTP agent to manage sending the messages.
  7261. </summary>
  7262. <remarks>
  7263. <para>
  7264. The configuration for this appender is identical to that of the <c>SMTPAppender</c>,
  7265. except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify
  7266. <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>.
  7267. </para>
  7268. <para>
  7269. The number of logging events delivered in this e-mail depend on
  7270. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  7271. <see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last
  7272. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  7273. cyclic buffer. This keeps memory requirements at a reasonable level while
  7274. still delivering useful application context.
  7275. </para>
  7276. </remarks>
  7277. <author>Niall Daley</author>
  7278. <author>Nicko Cadell</author>
  7279. </member>
  7280. <member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor">
  7281. <summary>
  7282. Default constructor
  7283. </summary>
  7284. <remarks>
  7285. <para>
  7286. Default constructor
  7287. </para>
  7288. </remarks>
  7289. </member>
  7290. <member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  7291. <summary>
  7292. Sends the contents of the cyclic buffer as an e-mail message.
  7293. </summary>
  7294. <param name="events">The logging events to send.</param>
  7295. <remarks>
  7296. <para>
  7297. Sends the contents of the cyclic buffer as an e-mail message.
  7298. </para>
  7299. </remarks>
  7300. </member>
  7301. <member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions">
  7302. <summary>
  7303. Activate the options on this appender.
  7304. </summary>
  7305. <remarks>
  7306. <para>
  7307. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  7308. activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must
  7309. be called on this object after the configuration properties have
  7310. been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this
  7311. object is in an undefined state and must not be used.
  7312. </para>
  7313. <para>
  7314. If any of the configuration properties are modified then
  7315. <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again.
  7316. </para>
  7317. </remarks>
  7318. </member>
  7319. <member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)">
  7320. <summary>
  7321. Convert a path into a fully qualified path.
  7322. </summary>
  7323. <param name="path">The path to convert.</param>
  7324. <returns>The fully qualified path.</returns>
  7325. <remarks>
  7326. <para>
  7327. Converts the path specified to a fully
  7328. qualified path. If the path is relative it is
  7329. taken as relative from the application base
  7330. directory.
  7331. </para>
  7332. </remarks>
  7333. </member>
  7334. <member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext">
  7335. <summary>
  7336. The security context to use for privileged calls
  7337. </summary>
  7338. </member>
  7339. <member name="P:log4net.Appender.SmtpPickupDirAppender.To">
  7340. <summary>
  7341. Gets or sets a semicolon-delimited list of recipient e-mail addresses.
  7342. </summary>
  7343. <value>
  7344. A semicolon-delimited list of e-mail addresses.
  7345. </value>
  7346. <remarks>
  7347. <para>
  7348. A semicolon-delimited list of e-mail addresses.
  7349. </para>
  7350. </remarks>
  7351. </member>
  7352. <member name="P:log4net.Appender.SmtpPickupDirAppender.From">
  7353. <summary>
  7354. Gets or sets the e-mail address of the sender.
  7355. </summary>
  7356. <value>
  7357. The e-mail address of the sender.
  7358. </value>
  7359. <remarks>
  7360. <para>
  7361. The e-mail address of the sender.
  7362. </para>
  7363. </remarks>
  7364. </member>
  7365. <member name="P:log4net.Appender.SmtpPickupDirAppender.Subject">
  7366. <summary>
  7367. Gets or sets the subject line of the e-mail message.
  7368. </summary>
  7369. <value>
  7370. The subject line of the e-mail message.
  7371. </value>
  7372. <remarks>
  7373. <para>
  7374. The subject line of the e-mail message.
  7375. </para>
  7376. </remarks>
  7377. </member>
  7378. <member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir">
  7379. <summary>
  7380. Gets or sets the path to write the messages to.
  7381. </summary>
  7382. <remarks>
  7383. <para>
  7384. Gets or sets the path to write the messages to. This should be the same
  7385. as that used by the agent sending the messages.
  7386. </para>
  7387. </remarks>
  7388. </member>
  7389. <member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext">
  7390. <summary>
  7391. Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  7392. </summary>
  7393. <value>
  7394. The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  7395. </value>
  7396. <remarks>
  7397. <para>
  7398. Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender
  7399. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  7400. security context to use. The default behavior is to use the security context
  7401. of the current thread.
  7402. </para>
  7403. </remarks>
  7404. </member>
  7405. <member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout">
  7406. <summary>
  7407. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7408. </summary>
  7409. <value><c>true</c></value>
  7410. <remarks>
  7411. <para>
  7412. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7413. </para>
  7414. </remarks>
  7415. </member>
  7416. <member name="T:log4net.Appender.TelnetAppender">
  7417. <summary>
  7418. Appender that allows clients to connect via Telnet to receive log messages
  7419. </summary>
  7420. <remarks>
  7421. <para>
  7422. The TelnetAppender accepts socket connections and streams logging messages
  7423. back to the client.
  7424. The output is provided in a telnet-friendly way so that a log can be monitored
  7425. over a TCP/IP socket.
  7426. This allows simple remote monitoring of application logging.
  7427. </para>
  7428. <para>
  7429. The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port).
  7430. </para>
  7431. </remarks>
  7432. <author>Keith Long</author>
  7433. <author>Nicko Cadell</author>
  7434. </member>
  7435. <member name="M:log4net.Appender.TelnetAppender.#ctor">
  7436. <summary>
  7437. Default constructor
  7438. </summary>
  7439. <remarks>
  7440. <para>
  7441. Default constructor
  7442. </para>
  7443. </remarks>
  7444. </member>
  7445. <member name="M:log4net.Appender.TelnetAppender.OnClose">
  7446. <summary>
  7447. Overrides the parent method to close the socket handler
  7448. </summary>
  7449. <remarks>
  7450. <para>
  7451. Closes all the outstanding connections.
  7452. </para>
  7453. </remarks>
  7454. </member>
  7455. <member name="M:log4net.Appender.TelnetAppender.ActivateOptions">
  7456. <summary>
  7457. Initialize the appender based on the options set.
  7458. </summary>
  7459. <remarks>
  7460. <para>
  7461. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  7462. activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must
  7463. be called on this object after the configuration properties have
  7464. been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this
  7465. object is in an undefined state and must not be used.
  7466. </para>
  7467. <para>
  7468. If any of the configuration properties are modified then
  7469. <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again.
  7470. </para>
  7471. <para>
  7472. Create the socket handler and wait for connections
  7473. </para>
  7474. </remarks>
  7475. </member>
  7476. <member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)">
  7477. <summary>
  7478. Writes the logging event to each connected client.
  7479. </summary>
  7480. <param name="loggingEvent">The event to log.</param>
  7481. <remarks>
  7482. <para>
  7483. Writes the logging event to each connected client.
  7484. </para>
  7485. </remarks>
  7486. </member>
  7487. <member name="P:log4net.Appender.TelnetAppender.Port">
  7488. <summary>
  7489. Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  7490. </summary>
  7491. <value>
  7492. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  7493. indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  7494. </value>
  7495. <remarks>
  7496. <para>
  7497. The default value is 23 (the telnet port).
  7498. </para>
  7499. </remarks>
  7500. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/>
  7501. or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
  7502. </member>
  7503. <member name="P:log4net.Appender.TelnetAppender.RequiresLayout">
  7504. <summary>
  7505. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7506. </summary>
  7507. <value><c>true</c></value>
  7508. <remarks>
  7509. <para>
  7510. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7511. </para>
  7512. </remarks>
  7513. </member>
  7514. <member name="T:log4net.Appender.TelnetAppender.SocketHandler">
  7515. <summary>
  7516. Helper class to manage connected clients
  7517. </summary>
  7518. <remarks>
  7519. <para>
  7520. The SocketHandler class is used to accept connections from
  7521. clients. It is threaded so that clients can connect/disconnect
  7522. asynchronously.
  7523. </para>
  7524. </remarks>
  7525. </member>
  7526. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)">
  7527. <summary>
  7528. Opens a new server port on <paramref ref="port"/>
  7529. </summary>
  7530. <param name="port">the local port to listen on for connections</param>
  7531. <remarks>
  7532. <para>
  7533. Creates a socket handler on the specified local server port.
  7534. </para>
  7535. </remarks>
  7536. </member>
  7537. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)">
  7538. <summary>
  7539. Sends a string message to each of the connected clients
  7540. </summary>
  7541. <param name="message">the text to send</param>
  7542. <remarks>
  7543. <para>
  7544. Sends a string message to each of the connected clients
  7545. </para>
  7546. </remarks>
  7547. </member>
  7548. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  7549. <summary>
  7550. Add a client to the internal clients list
  7551. </summary>
  7552. <param name="client">client to add</param>
  7553. </member>
  7554. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  7555. <summary>
  7556. Remove a client from the internal clients list
  7557. </summary>
  7558. <param name="client">client to remove</param>
  7559. </member>
  7560. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.OnConnect(System.IAsyncResult)">
  7561. <summary>
  7562. Callback used to accept a connection on the server socket
  7563. </summary>
  7564. <param name="asyncResult">The result of the asynchronous operation</param>
  7565. <remarks>
  7566. <para>
  7567. On connection adds to the list of connections
  7568. if there are two many open connections you will be disconnected
  7569. </para>
  7570. </remarks>
  7571. </member>
  7572. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose">
  7573. <summary>
  7574. Close all network connections
  7575. </summary>
  7576. <remarks>
  7577. <para>
  7578. Make sure we close all network connections
  7579. </para>
  7580. </remarks>
  7581. </member>
  7582. <member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections">
  7583. <summary>
  7584. Test if this handler has active connections
  7585. </summary>
  7586. <value>
  7587. <c>true</c> if this handler has active connections
  7588. </value>
  7589. <remarks>
  7590. <para>
  7591. This property will be <c>true</c> while this handler has
  7592. active connections, that is at least one connection that
  7593. the handler will attempt to send a message to.
  7594. </para>
  7595. </remarks>
  7596. </member>
  7597. <member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient">
  7598. <summary>
  7599. Class that represents a client connected to this handler
  7600. </summary>
  7601. <remarks>
  7602. <para>
  7603. Class that represents a client connected to this handler
  7604. </para>
  7605. </remarks>
  7606. </member>
  7607. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)">
  7608. <summary>
  7609. Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/>
  7610. </summary>
  7611. <param name="socket">the client's socket</param>
  7612. <remarks>
  7613. <para>
  7614. Opens a stream writer on the socket.
  7615. </para>
  7616. </remarks>
  7617. </member>
  7618. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)">
  7619. <summary>
  7620. Write a string to the client
  7621. </summary>
  7622. <param name="message">string to send</param>
  7623. <remarks>
  7624. <para>
  7625. Write a string to the client
  7626. </para>
  7627. </remarks>
  7628. </member>
  7629. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose">
  7630. <summary>
  7631. Cleanup the clients connection
  7632. </summary>
  7633. <remarks>
  7634. <para>
  7635. Close the socket connection.
  7636. </para>
  7637. </remarks>
  7638. </member>
  7639. <member name="T:log4net.Appender.TraceAppender">
  7640. <summary>
  7641. Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system.
  7642. </summary>
  7643. <remarks>
  7644. <para>
  7645. The application configuration file can be used to control what listeners
  7646. are actually used. See the MSDN documentation for the
  7647. <see cref="T:System.Diagnostics.Trace"/> class for details on configuring the
  7648. trace system.
  7649. </para>
  7650. <para>
  7651. Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c>
  7652. method. The event's logger name is passed as the value for the category name to the Write method.
  7653. </para>
  7654. <para>
  7655. <b>Compact Framework</b><br/>
  7656. The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/>
  7657. class for any operation except <c>Assert</c>. When using the Compact Framework this
  7658. appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than
  7659. the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>.
  7660. </para>
  7661. </remarks>
  7662. <author>Douglas de la Torre</author>
  7663. <author>Nicko Cadell</author>
  7664. <author>Gert Driesen</author>
  7665. </member>
  7666. <member name="M:log4net.Appender.TraceAppender.#ctor">
  7667. <summary>
  7668. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>.
  7669. </summary>
  7670. <remarks>
  7671. <para>
  7672. Default constructor.
  7673. </para>
  7674. </remarks>
  7675. </member>
  7676. <member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)">
  7677. <summary>
  7678. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>
  7679. with a specified layout.
  7680. </summary>
  7681. <param name="layout">The layout to use with this appender.</param>
  7682. <remarks>
  7683. <para>
  7684. Obsolete constructor.
  7685. </para>
  7686. </remarks>
  7687. </member>
  7688. <member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)">
  7689. <summary>
  7690. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  7691. </summary>
  7692. <param name="loggingEvent">The event to log.</param>
  7693. <remarks>
  7694. <para>
  7695. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  7696. </para>
  7697. </remarks>
  7698. </member>
  7699. <member name="F:log4net.Appender.TraceAppender.m_immediateFlush">
  7700. <summary>
  7701. Immediate flush means that the underlying writer or output stream
  7702. will be flushed at the end of each append operation.
  7703. </summary>
  7704. <remarks>
  7705. <para>
  7706. Immediate flush is slower but ensures that each append request is
  7707. actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to
  7708. <c>false</c>, then there is a good chance that the last few
  7709. logs events are not actually written to persistent media if and
  7710. when the application crashes.
  7711. </para>
  7712. <para>
  7713. The default value is <c>true</c>.</para>
  7714. </remarks>
  7715. </member>
  7716. <member name="P:log4net.Appender.TraceAppender.ImmediateFlush">
  7717. <summary>
  7718. Gets or sets a value that indicates whether the appender will
  7719. flush at the end of each write.
  7720. </summary>
  7721. <remarks>
  7722. <para>The default behavior is to flush at the end of each
  7723. write. If the option is set to<c>false</c>, then the underlying
  7724. stream can defer writing to physical medium to a later time.
  7725. </para>
  7726. <para>
  7727. Avoiding the flush operation at the end of each append results
  7728. in a performance gain of 10 to 20 percent. However, there is safety
  7729. trade-off involved in skipping flushing. Indeed, when flushing is
  7730. skipped, then it is likely that the last few log events will not
  7731. be recorded on disk when the application exits. This is a high
  7732. price to pay even for a 20% performance gain.
  7733. </para>
  7734. </remarks>
  7735. </member>
  7736. <member name="P:log4net.Appender.TraceAppender.RequiresLayout">
  7737. <summary>
  7738. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7739. </summary>
  7740. <value><c>true</c></value>
  7741. <remarks>
  7742. <para>
  7743. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7744. </para>
  7745. </remarks>
  7746. </member>
  7747. <member name="T:log4net.Config.AliasDomainAttribute">
  7748. <summary>
  7749. Assembly level attribute that specifies a domain to alias to this assembly's repository.
  7750. </summary>
  7751. <remarks>
  7752. <para>
  7753. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  7754. </para>
  7755. <para>
  7756. An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>,
  7757. however this can be overridden by an assembly loaded before the target assembly.
  7758. </para>
  7759. <para>
  7760. An assembly can alias another assembly's domain to its repository by
  7761. specifying this attribute with the name of the target domain.
  7762. </para>
  7763. <para>
  7764. This attribute can only be specified on the assembly and may be used
  7765. as many times as necessary to alias all the required domains.
  7766. </para>
  7767. </remarks>
  7768. <author>Nicko Cadell</author>
  7769. <author>Gert Driesen</author>
  7770. </member>
  7771. <member name="T:log4net.Config.AliasRepositoryAttribute">
  7772. <summary>
  7773. Assembly level attribute that specifies a repository to alias to this assembly's repository.
  7774. </summary>
  7775. <remarks>
  7776. <para>
  7777. An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>,
  7778. however this can be overridden by an assembly loaded before the target assembly.
  7779. </para>
  7780. <para>
  7781. An assembly can alias another assembly's repository to its repository by
  7782. specifying this attribute with the name of the target repository.
  7783. </para>
  7784. <para>
  7785. This attribute can only be specified on the assembly and may be used
  7786. as many times as necessary to alias all the required repositories.
  7787. </para>
  7788. </remarks>
  7789. <author>Nicko Cadell</author>
  7790. <author>Gert Driesen</author>
  7791. </member>
  7792. <member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)">
  7793. <summary>
  7794. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
  7795. the specified repository to alias to this assembly's repository.
  7796. </summary>
  7797. <param name="name">The repository to alias to this assemby's repository.</param>
  7798. <remarks>
  7799. <para>
  7800. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
  7801. the specified repository to alias to this assembly's repository.
  7802. </para>
  7803. </remarks>
  7804. </member>
  7805. <member name="P:log4net.Config.AliasRepositoryAttribute.Name">
  7806. <summary>
  7807. Gets or sets the repository to alias to this assemby's repository.
  7808. </summary>
  7809. <value>
  7810. The repository to alias to this assemby's repository.
  7811. </value>
  7812. <remarks>
  7813. <para>
  7814. The name of the repository to alias to this assemby's repository.
  7815. </para>
  7816. </remarks>
  7817. </member>
  7818. <member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)">
  7819. <summary>
  7820. Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute"/> class with
  7821. the specified domain to alias to this assembly's repository.
  7822. </summary>
  7823. <param name="name">The domain to alias to this assemby's repository.</param>
  7824. <remarks>
  7825. <para>
  7826. Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>.
  7827. </para>
  7828. </remarks>
  7829. </member>
  7830. <member name="T:log4net.Config.BasicConfigurator">
  7831. <summary>
  7832. Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  7833. </summary>
  7834. <remarks>
  7835. <para>
  7836. Allows very simple programmatic configuration of log4net.
  7837. </para>
  7838. <para>
  7839. Only one appender can be configured using this configurator.
  7840. The appender is set at the root of the hierarchy and all logging
  7841. events will be delivered to that appender.
  7842. </para>
  7843. <para>
  7844. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  7845. they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method
  7846. be called after the appenders properties have been configured.
  7847. </para>
  7848. </remarks>
  7849. <author>Nicko Cadell</author>
  7850. <author>Gert Driesen</author>
  7851. </member>
  7852. <member name="M:log4net.Config.BasicConfigurator.#ctor">
  7853. <summary>
  7854. Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator"/> class.
  7855. </summary>
  7856. <remarks>
  7857. <para>
  7858. Uses a private access modifier to prevent instantiation of this class.
  7859. </para>
  7860. </remarks>
  7861. </member>
  7862. <member name="M:log4net.Config.BasicConfigurator.Configure">
  7863. <summary>
  7864. Initializes the log4net system with a default configuration.
  7865. </summary>
  7866. <remarks>
  7867. <para>
  7868. Initializes the log4net logging system using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  7869. that will write to <c>Console.Out</c>. The log messages are
  7870. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  7871. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  7872. layout style.
  7873. </para>
  7874. </remarks>
  7875. </member>
  7876. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender)">
  7877. <summary>
  7878. Initializes the log4net system using the specified appender.
  7879. </summary>
  7880. <param name="appender">The appender to use to log all logging events.</param>
  7881. <remarks>
  7882. <para>
  7883. Initializes the log4net system using the specified appender.
  7884. </para>
  7885. </remarks>
  7886. </member>
  7887. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  7888. <summary>
  7889. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration.
  7890. </summary>
  7891. <param name="repository">The repository to configure.</param>
  7892. <remarks>
  7893. <para>
  7894. Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  7895. that will write to <c>Console.Out</c>. The log messages are
  7896. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  7897. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  7898. layout style.
  7899. </para>
  7900. </remarks>
  7901. </member>
  7902. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)">
  7903. <summary>
  7904. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  7905. </summary>
  7906. <param name="repository">The repository to configure.</param>
  7907. <param name="appender">The appender to use to log all logging events.</param>
  7908. <remarks>
  7909. <para>
  7910. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  7911. </para>
  7912. </remarks>
  7913. </member>
  7914. <member name="T:log4net.Config.ConfiguratorAttribute">
  7915. <summary>
  7916. Base class for all log4net configuration attributes.
  7917. </summary>
  7918. <remarks>
  7919. This is an abstract class that must be extended by
  7920. specific configurators. This attribute allows the
  7921. configurator to be parameterized by an assembly level
  7922. attribute.
  7923. </remarks>
  7924. <author>Nicko Cadell</author>
  7925. <author>Gert Driesen</author>
  7926. </member>
  7927. <member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)">
  7928. <summary>
  7929. Constructor used by subclasses.
  7930. </summary>
  7931. <param name="priority">the ordering priority for this configurator</param>
  7932. <remarks>
  7933. <para>
  7934. The <paramref name="priority"/> is used to order the configurator
  7935. attributes before they are invoked. Higher priority configurators are executed
  7936. before lower priority ones.
  7937. </para>
  7938. </remarks>
  7939. </member>
  7940. <member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  7941. <summary>
  7942. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  7943. </summary>
  7944. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  7945. <param name="targetRepository">The repository to configure.</param>
  7946. <remarks>
  7947. <para>
  7948. Abstract method implemented by a subclass. When this method is called
  7949. the subclass should configure the <paramref name="targetRepository"/>.
  7950. </para>
  7951. </remarks>
  7952. </member>
  7953. <member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)">
  7954. <summary>
  7955. Compare this instance to another ConfiguratorAttribute
  7956. </summary>
  7957. <param name="obj">the object to compare to</param>
  7958. <returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns>
  7959. <remarks>
  7960. <para>
  7961. Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances.
  7962. Sorts by priority in descending order. Objects with the same priority are
  7963. randomly ordered.
  7964. </para>
  7965. </remarks>
  7966. </member>
  7967. <member name="T:log4net.Config.DomainAttribute">
  7968. <summary>
  7969. Assembly level attribute that specifies the logging domain for the assembly.
  7970. </summary>
  7971. <remarks>
  7972. <para>
  7973. <b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b>
  7974. </para>
  7975. <para>
  7976. Assemblies are mapped to logging domains. Each domain has its own
  7977. logging repository. This attribute specified on the assembly controls
  7978. the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  7979. of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  7980. specifies the type of the repository objects to create for the domain. If
  7981. this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified
  7982. then the assembly will be part of the default shared logging domain.
  7983. </para>
  7984. <para>
  7985. This attribute can only be specified on the assembly and may only be used
  7986. once per assembly.
  7987. </para>
  7988. </remarks>
  7989. <author>Nicko Cadell</author>
  7990. <author>Gert Driesen</author>
  7991. </member>
  7992. <member name="T:log4net.Config.RepositoryAttribute">
  7993. <summary>
  7994. Assembly level attribute that specifies the logging repository for the assembly.
  7995. </summary>
  7996. <remarks>
  7997. <para>
  7998. Assemblies are mapped to logging repository. This attribute specified
  7999. on the assembly controls
  8000. the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  8001. of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  8002. specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object
  8003. to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/>
  8004. is not specified then the assembly will be part of the default shared logging repository.
  8005. </para>
  8006. <para>
  8007. This attribute can only be specified on the assembly and may only be used
  8008. once per assembly.
  8009. </para>
  8010. </remarks>
  8011. <author>Nicko Cadell</author>
  8012. <author>Gert Driesen</author>
  8013. </member>
  8014. <member name="M:log4net.Config.RepositoryAttribute.#ctor">
  8015. <summary>
  8016. Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class.
  8017. </summary>
  8018. <remarks>
  8019. <para>
  8020. Default constructor.
  8021. </para>
  8022. </remarks>
  8023. </member>
  8024. <member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)">
  8025. <summary>
  8026. Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class
  8027. with the name of the repository.
  8028. </summary>
  8029. <param name="name">The name of the repository.</param>
  8030. <remarks>
  8031. <para>
  8032. Initialize the attribute with the name for the assembly's repository.
  8033. </para>
  8034. </remarks>
  8035. </member>
  8036. <member name="P:log4net.Config.RepositoryAttribute.Name">
  8037. <summary>
  8038. Gets or sets the name of the logging repository.
  8039. </summary>
  8040. <value>
  8041. The string name to use as the name of the repository associated with this
  8042. assembly.
  8043. </value>
  8044. <remarks>
  8045. <para>
  8046. This value does not have to be unique. Several assemblies can share the
  8047. same repository. They will share the logging configuration of the repository.
  8048. </para>
  8049. </remarks>
  8050. </member>
  8051. <member name="P:log4net.Config.RepositoryAttribute.RepositoryType">
  8052. <summary>
  8053. Gets or sets the type of repository to create for this assembly.
  8054. </summary>
  8055. <value>
  8056. The type of repository to create for this assembly.
  8057. </value>
  8058. <remarks>
  8059. <para>
  8060. The type of the repository to create for the assembly.
  8061. The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/>
  8062. interface.
  8063. </para>
  8064. <para>
  8065. This will be the type of repository created when
  8066. the repository is created. If multiple assemblies reference the
  8067. same repository then the repository is only created once using the
  8068. <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> of the first assembly to call into the
  8069. repository.
  8070. </para>
  8071. </remarks>
  8072. </member>
  8073. <member name="M:log4net.Config.DomainAttribute.#ctor">
  8074. <summary>
  8075. Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class.
  8076. </summary>
  8077. <remarks>
  8078. <para>
  8079. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8080. </para>
  8081. </remarks>
  8082. </member>
  8083. <member name="M:log4net.Config.DomainAttribute.#ctor(System.String)">
  8084. <summary>
  8085. Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class
  8086. with the name of the domain.
  8087. </summary>
  8088. <param name="name">The name of the domain.</param>
  8089. <remarks>
  8090. <para>
  8091. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8092. </para>
  8093. </remarks>
  8094. </member>
  8095. <member name="T:log4net.Config.DOMConfigurator">
  8096. <summary>
  8097. Use this class to initialize the log4net environment using an Xml tree.
  8098. </summary>
  8099. <remarks>
  8100. <para>
  8101. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8102. </para>
  8103. <para>
  8104. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  8105. </para>
  8106. </remarks>
  8107. <author>Nicko Cadell</author>
  8108. <author>Gert Driesen</author>
  8109. </member>
  8110. <member name="M:log4net.Config.DOMConfigurator.#ctor">
  8111. <summary>
  8112. Private constructor
  8113. </summary>
  8114. </member>
  8115. <member name="M:log4net.Config.DOMConfigurator.Configure">
  8116. <summary>
  8117. Automatically configures the log4net system based on the
  8118. application's configuration settings.
  8119. </summary>
  8120. <remarks>
  8121. <para>
  8122. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8123. </para>
  8124. Each application has a configuration file. This has the
  8125. same name as the application with '.config' appended.
  8126. This file is XML and calling this function prompts the
  8127. configurator to look in that file for a section called
  8128. <c>log4net</c> that contains the configuration data.
  8129. </remarks>
  8130. </member>
  8131. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  8132. <summary>
  8133. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  8134. stored in the application's configuration file.
  8135. </summary>
  8136. <remarks>
  8137. <para>
  8138. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8139. </para>
  8140. Each application has a configuration file. This has the
  8141. same name as the application with '.config' appended.
  8142. This file is XML and calling this function prompts the
  8143. configurator to look in that file for a section called
  8144. <c>log4net</c> that contains the configuration data.
  8145. </remarks>
  8146. <param name="repository">The repository to configure.</param>
  8147. </member>
  8148. <member name="M:log4net.Config.DOMConfigurator.Configure(System.Xml.XmlElement)">
  8149. <summary>
  8150. Configures log4net using a <c>log4net</c> element
  8151. </summary>
  8152. <remarks>
  8153. <para>
  8154. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8155. </para>
  8156. Loads the log4net configuration from the XML element
  8157. supplied as <paramref name="element"/>.
  8158. </remarks>
  8159. <param name="element">The element to parse.</param>
  8160. </member>
  8161. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  8162. <summary>
  8163. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  8164. element.
  8165. </summary>
  8166. <remarks>
  8167. <para>
  8168. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8169. </para>
  8170. Loads the log4net configuration from the XML element
  8171. supplied as <paramref name="element"/>.
  8172. </remarks>
  8173. <param name="repository">The repository to configure.</param>
  8174. <param name="element">The element to parse.</param>
  8175. </member>
  8176. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)">
  8177. <summary>
  8178. Configures log4net using the specified configuration file.
  8179. </summary>
  8180. <param name="configFile">The XML file to load the configuration from.</param>
  8181. <remarks>
  8182. <para>
  8183. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8184. </para>
  8185. <para>
  8186. The configuration file must be valid XML. It must contain
  8187. at least one element called <c>log4net</c> that holds
  8188. the log4net configuration data.
  8189. </para>
  8190. <para>
  8191. The log4net configuration file can possible be specified in the application's
  8192. configuration file (either <c>MyAppName.exe.config</c> for a
  8193. normal application on <c>Web.config</c> for an ASP.NET application).
  8194. </para>
  8195. <example>
  8196. The following example configures log4net using a configuration file, of which the
  8197. location is stored in the application's configuration file :
  8198. </example>
  8199. <code lang="C#">
  8200. using log4net.Config;
  8201. using System.IO;
  8202. using System.Configuration;
  8203. ...
  8204. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  8205. </code>
  8206. <para>
  8207. In the <c>.config</c> file, the path to the log4net can be specified like this :
  8208. </para>
  8209. <code lang="XML" escaped="true">
  8210. <configuration>
  8211. <appSettings>
  8212. <add key="log4net-config-file" value="log.config"/>
  8213. </appSettings>
  8214. </configuration>
  8215. </code>
  8216. </remarks>
  8217. </member>
  8218. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.Stream)">
  8219. <summary>
  8220. Configures log4net using the specified configuration file.
  8221. </summary>
  8222. <param name="configStream">A stream to load the XML configuration from.</param>
  8223. <remarks>
  8224. <para>
  8225. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8226. </para>
  8227. <para>
  8228. The configuration data must be valid XML. It must contain
  8229. at least one element called <c>log4net</c> that holds
  8230. the log4net configuration data.
  8231. </para>
  8232. <para>
  8233. Note that this method will NOT close the stream parameter.
  8234. </para>
  8235. </remarks>
  8236. </member>
  8237. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8238. <summary>
  8239. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  8240. file.
  8241. </summary>
  8242. <param name="repository">The repository to configure.</param>
  8243. <param name="configFile">The XML file to load the configuration from.</param>
  8244. <remarks>
  8245. <para>
  8246. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8247. </para>
  8248. <para>
  8249. The configuration file must be valid XML. It must contain
  8250. at least one element called <c>log4net</c> that holds
  8251. the configuration data.
  8252. </para>
  8253. <para>
  8254. The log4net configuration file can possible be specified in the application's
  8255. configuration file (either <c>MyAppName.exe.config</c> for a
  8256. normal application on <c>Web.config</c> for an ASP.NET application).
  8257. </para>
  8258. <example>
  8259. The following example configures log4net using a configuration file, of which the
  8260. location is stored in the application's configuration file :
  8261. </example>
  8262. <code lang="C#">
  8263. using log4net.Config;
  8264. using System.IO;
  8265. using System.Configuration;
  8266. ...
  8267. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  8268. </code>
  8269. <para>
  8270. In the <c>.config</c> file, the path to the log4net can be specified like this :
  8271. </para>
  8272. <code lang="XML" escaped="true">
  8273. <configuration>
  8274. <appSettings>
  8275. <add key="log4net-config-file" value="log.config"/>
  8276. </appSettings>
  8277. </configuration>
  8278. </code>
  8279. </remarks>
  8280. </member>
  8281. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  8282. <summary>
  8283. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  8284. file.
  8285. </summary>
  8286. <param name="repository">The repository to configure.</param>
  8287. <param name="configStream">The stream to load the XML configuration from.</param>
  8288. <remarks>
  8289. <para>
  8290. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8291. </para>
  8292. <para>
  8293. The configuration data must be valid XML. It must contain
  8294. at least one element called <c>log4net</c> that holds
  8295. the configuration data.
  8296. </para>
  8297. <para>
  8298. Note that this method will NOT close the stream parameter.
  8299. </para>
  8300. </remarks>
  8301. </member>
  8302. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  8303. <summary>
  8304. Configures log4net using the file specified, monitors the file for changes
  8305. and reloads the configuration if a change is detected.
  8306. </summary>
  8307. <param name="configFile">The XML file to load the configuration from.</param>
  8308. <remarks>
  8309. <para>
  8310. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8311. </para>
  8312. <para>
  8313. The configuration file must be valid XML. It must contain
  8314. at least one element called <c>log4net</c> that holds
  8315. the configuration data.
  8316. </para>
  8317. <para>
  8318. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  8319. and depends on the behavior of that class.
  8320. </para>
  8321. <para>
  8322. For more information on how to configure log4net using
  8323. a separate configuration file, see <see cref="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)"/>.
  8324. </para>
  8325. </remarks>
  8326. <seealso cref="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)"/>
  8327. </member>
  8328. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8329. <summary>
  8330. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  8331. monitors the file for changes and reloads the configuration if a change
  8332. is detected.
  8333. </summary>
  8334. <param name="repository">The repository to configure.</param>
  8335. <param name="configFile">The XML file to load the configuration from.</param>
  8336. <remarks>
  8337. <para>
  8338. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8339. </para>
  8340. <para>
  8341. The configuration file must be valid XML. It must contain
  8342. at least one element called <c>log4net</c> that holds
  8343. the configuration data.
  8344. </para>
  8345. <para>
  8346. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  8347. and depends on the behavior of that class.
  8348. </para>
  8349. <para>
  8350. For more information on how to configure log4net using
  8351. a separate configuration file, see <see cref="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)"/>.
  8352. </para>
  8353. </remarks>
  8354. <seealso cref="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)"/>
  8355. </member>
  8356. <member name="T:log4net.Config.DOMConfiguratorAttribute">
  8357. <summary>
  8358. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  8359. </summary>
  8360. <remarks>
  8361. <para>
  8362. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  8363. </para>
  8364. <para>
  8365. This attribute may only be used at the assembly scope and can only
  8366. be used once per assembly.
  8367. </para>
  8368. <para>
  8369. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  8370. without calling one of the <see cref="M:log4net.Config.XmlConfigurator.Configure"/>
  8371. methods.
  8372. </para>
  8373. </remarks>
  8374. <author>Nicko Cadell</author>
  8375. <author>Gert Driesen</author>
  8376. </member>
  8377. <member name="T:log4net.Config.XmlConfiguratorAttribute">
  8378. <summary>
  8379. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  8380. </summary>
  8381. <remarks>
  8382. <para>
  8383. This attribute may only be used at the assembly scope and can only
  8384. be used once per assembly.
  8385. </para>
  8386. <para>
  8387. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  8388. without calling one of the <see cref="M:log4net.Config.XmlConfigurator.Configure"/>
  8389. methods.
  8390. </para>
  8391. <para>
  8392. If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>
  8393. properties are set the configuration is loaded from the application's .config file.
  8394. If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the
  8395. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property
  8396. specifies a path to a file to load the config from. The path is relative to the
  8397. application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  8398. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name.
  8399. The config file must be located in the application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  8400. For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to
  8401. <c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or
  8402. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties.
  8403. </para>
  8404. <para>
  8405. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/>
  8406. to watch the configuration file for changes.
  8407. </para>
  8408. <note>
  8409. <para>
  8410. Log4net will only look for assembly level configuration attributes once.
  8411. When using the log4net assembly level attributes to control the configuration
  8412. of log4net you must ensure that the first call to any of the
  8413. <see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration
  8414. attributes.
  8415. </para>
  8416. <para>
  8417. If you cannot guarantee the order in which log4net calls will be made from
  8418. different assemblies you must use programmatic configuration instead, i.e.
  8419. call the <see cref="M:log4net.Config.XmlConfigurator.Configure"/> method directly.
  8420. </para>
  8421. </note>
  8422. </remarks>
  8423. <author>Nicko Cadell</author>
  8424. <author>Gert Driesen</author>
  8425. </member>
  8426. <member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor">
  8427. <summary>
  8428. Default constructor
  8429. </summary>
  8430. <remarks>
  8431. <para>
  8432. Default constructor
  8433. </para>
  8434. </remarks>
  8435. </member>
  8436. <member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8437. <summary>
  8438. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  8439. </summary>
  8440. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8441. <param name="targetRepository">The repository to configure.</param>
  8442. <remarks>
  8443. <para>
  8444. Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>.
  8445. The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  8446. class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to
  8447. configure it.
  8448. </para>
  8449. </remarks>
  8450. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="repository"/> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception>
  8451. </member>
  8452. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8453. <summary>
  8454. Attempt to load configuration from the local file system
  8455. </summary>
  8456. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8457. <param name="targetRepository">The repository to configure.</param>
  8458. </member>
  8459. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8460. <summary>
  8461. Configure the specified repository using a <see cref="T:System.IO.FileInfo"/>
  8462. </summary>
  8463. <param name="targetRepository">The repository to configure.</param>
  8464. <param name="configFile">the FileInfo pointing to the config file</param>
  8465. </member>
  8466. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8467. <summary>
  8468. Attempt to load configuration from a URI
  8469. </summary>
  8470. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8471. <param name="targetRepository">The repository to configure.</param>
  8472. </member>
  8473. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile">
  8474. <summary>
  8475. Gets or sets the filename of the configuration file.
  8476. </summary>
  8477. <value>
  8478. The filename of the configuration file.
  8479. </value>
  8480. <remarks>
  8481. <para>
  8482. If specified, this is the name of the configuration file to use with
  8483. the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the
  8484. <b>application base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>).
  8485. </para>
  8486. <para>
  8487. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  8488. </para>
  8489. </remarks>
  8490. </member>
  8491. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension">
  8492. <summary>
  8493. Gets or sets the extension of the configuration file.
  8494. </summary>
  8495. <value>
  8496. The extension of the configuration file.
  8497. </value>
  8498. <remarks>
  8499. <para>
  8500. If specified this is the extension for the configuration file.
  8501. The path to the config file is built by using the <b>application
  8502. base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>),
  8503. the <b>assembly file name</b> and the config file extension.
  8504. </para>
  8505. <para>
  8506. If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then
  8507. possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or
  8508. <c>MyClassLibrary.dll.MyExt</c>.
  8509. </para>
  8510. <para>
  8511. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  8512. </para>
  8513. </remarks>
  8514. </member>
  8515. <member name="P:log4net.Config.XmlConfiguratorAttribute.Watch">
  8516. <summary>
  8517. Gets or sets a value indicating whether to watch the configuration file.
  8518. </summary>
  8519. <value>
  8520. <c>true</c> if the configuration should be watched, <c>false</c> otherwise.
  8521. </value>
  8522. <remarks>
  8523. <para>
  8524. If this flag is specified and set to <c>true</c> then the framework
  8525. will watch the configuration file and will reload the config each time
  8526. the file is modified.
  8527. </para>
  8528. <para>
  8529. The config file can only be watched if it is loaded from local disk.
  8530. In a No-Touch (Smart Client) deployment where the application is downloaded
  8531. from a web server the config file may not reside on the local disk
  8532. and therefore it may not be able to watch it.
  8533. </para>
  8534. <note>
  8535. Watching configuration is not supported on the SSCLI.
  8536. </note>
  8537. </remarks>
  8538. </member>
  8539. <member name="T:log4net.Config.Log4NetConfigurationSectionHandler">
  8540. <summary>
  8541. Class to register for the log4net section of the configuration file
  8542. </summary>
  8543. <remarks>
  8544. The log4net section of the configuration file needs to have a section
  8545. handler registered. This is the section handler used. It simply returns
  8546. the XML element that is the root of the section.
  8547. </remarks>
  8548. <example>
  8549. Example of registering the log4net section handler :
  8550. <code lang="XML" escaped="true">
  8551. <configuration>
  8552. <configSections>
  8553. <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  8554. </configSections>
  8555. <log4net>
  8556. log4net configuration XML goes here
  8557. </log4net>
  8558. </configuration>
  8559. </code>
  8560. </example>
  8561. <author>Nicko Cadell</author>
  8562. <author>Gert Driesen</author>
  8563. </member>
  8564. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.#ctor">
  8565. <summary>
  8566. Initializes a new instance of the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> class.
  8567. </summary>
  8568. <remarks>
  8569. <para>
  8570. Default constructor.
  8571. </para>
  8572. </remarks>
  8573. </member>
  8574. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.Create(System.Object,System.Object,System.Xml.XmlNode)">
  8575. <summary>
  8576. Parses the configuration section.
  8577. </summary>
  8578. <param name="parent">The configuration settings in a corresponding parent configuration section.</param>
  8579. <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>
  8580. <param name="section">The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</param>
  8581. <returns>The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</returns>
  8582. <remarks>
  8583. <para>
  8584. Returns the <see cref="T:System.Xml.XmlNode"/> containing the configuration data,
  8585. </para>
  8586. </remarks>
  8587. </member>
  8588. <member name="T:log4net.Config.PluginAttribute">
  8589. <summary>
  8590. Assembly level attribute that specifies a plugin to attach to
  8591. the repository.
  8592. </summary>
  8593. <remarks>
  8594. <para>
  8595. Specifies the type of a plugin to create and attach to the
  8596. assembly's repository. The plugin type must implement the
  8597. <see cref="T:log4net.Plugin.IPlugin"/> interface.
  8598. </para>
  8599. </remarks>
  8600. <author>Nicko Cadell</author>
  8601. <author>Gert Driesen</author>
  8602. </member>
  8603. <member name="T:log4net.Plugin.IPluginFactory">
  8604. <summary>
  8605. Interface used to create plugins.
  8606. </summary>
  8607. <remarks>
  8608. <para>
  8609. Interface used to create a plugin.
  8610. </para>
  8611. </remarks>
  8612. <author>Nicko Cadell</author>
  8613. <author>Gert Driesen</author>
  8614. </member>
  8615. <member name="M:log4net.Plugin.IPluginFactory.CreatePlugin">
  8616. <summary>
  8617. Creates the plugin object.
  8618. </summary>
  8619. <returns>the new plugin instance</returns>
  8620. <remarks>
  8621. <para>
  8622. Create and return a new plugin instance.
  8623. </para>
  8624. </remarks>
  8625. </member>
  8626. <member name="M:log4net.Config.PluginAttribute.#ctor(System.String)">
  8627. <summary>
  8628. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
  8629. with the specified type.
  8630. </summary>
  8631. <param name="typeName">The type name of plugin to create.</param>
  8632. <remarks>
  8633. <para>
  8634. Create the attribute with the plugin type specified.
  8635. </para>
  8636. <para>
  8637. Where possible use the constructor that takes a <see cref="T:System.Type"/>.
  8638. </para>
  8639. </remarks>
  8640. </member>
  8641. <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)">
  8642. <summary>
  8643. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
  8644. with the specified type.
  8645. </summary>
  8646. <param name="type">The type of plugin to create.</param>
  8647. <remarks>
  8648. <para>
  8649. Create the attribute with the plugin type specified.
  8650. </para>
  8651. </remarks>
  8652. </member>
  8653. <member name="M:log4net.Config.PluginAttribute.CreatePlugin">
  8654. <summary>
  8655. Creates the plugin object defined by this attribute.
  8656. </summary>
  8657. <remarks>
  8658. <para>
  8659. Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as
  8660. specified by this attribute.
  8661. </para>
  8662. </remarks>
  8663. <returns>The plugin object.</returns>
  8664. </member>
  8665. <member name="M:log4net.Config.PluginAttribute.ToString">
  8666. <summary>
  8667. Returns a representation of the properties of this object.
  8668. </summary>
  8669. <remarks>
  8670. <para>
  8671. Overrides base class <see cref="M:System.Object.ToString"/> method to
  8672. return a representation of the properties of this object.
  8673. </para>
  8674. </remarks>
  8675. <returns>A representation of the properties of this object</returns>
  8676. </member>
  8677. <member name="P:log4net.Config.PluginAttribute.Type">
  8678. <summary>
  8679. Gets or sets the type for the plugin.
  8680. </summary>
  8681. <value>
  8682. The type for the plugin.
  8683. </value>
  8684. <remarks>
  8685. <para>
  8686. The type for the plugin.
  8687. </para>
  8688. </remarks>
  8689. </member>
  8690. <member name="P:log4net.Config.PluginAttribute.TypeName">
  8691. <summary>
  8692. Gets or sets the type name for the plugin.
  8693. </summary>
  8694. <value>
  8695. The type name for the plugin.
  8696. </value>
  8697. <remarks>
  8698. <para>
  8699. The type name for the plugin.
  8700. </para>
  8701. <para>
  8702. Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead.
  8703. </para>
  8704. </remarks>
  8705. </member>
  8706. <member name="T:log4net.Config.SecurityContextProviderAttribute">
  8707. <summary>
  8708. Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>.
  8709. </summary>
  8710. <remarks>
  8711. <para>
  8712. This attribute may only be used at the assembly scope and can only
  8713. be used once per assembly.
  8714. </para>
  8715. <para>
  8716. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  8717. without calling one of the <see cref="M:log4net.Config.XmlConfigurator.Configure"/>
  8718. methods.
  8719. </para>
  8720. </remarks>
  8721. <author>Nicko Cadell</author>
  8722. </member>
  8723. <member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)">
  8724. <summary>
  8725. Construct provider attribute with type specified
  8726. </summary>
  8727. <param name="providerType">the type of the provider to use</param>
  8728. <remarks>
  8729. <para>
  8730. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  8731. class.
  8732. </para>
  8733. </remarks>
  8734. </member>
  8735. <member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8736. <summary>
  8737. Configures the SecurityContextProvider
  8738. </summary>
  8739. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8740. <param name="targetRepository">The repository to configure.</param>
  8741. <remarks>
  8742. <para>
  8743. Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified.
  8744. Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>.
  8745. </para>
  8746. </remarks>
  8747. </member>
  8748. <member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType">
  8749. <summary>
  8750. Gets or sets the type of the provider to use.
  8751. </summary>
  8752. <value>
  8753. the type of the provider to use.
  8754. </value>
  8755. <remarks>
  8756. <para>
  8757. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  8758. class.
  8759. </para>
  8760. </remarks>
  8761. </member>
  8762. <member name="T:log4net.Config.XmlConfigurator">
  8763. <summary>
  8764. Use this class to initialize the log4net environment using an Xml tree.
  8765. </summary>
  8766. <remarks>
  8767. <para>
  8768. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  8769. </para>
  8770. </remarks>
  8771. <author>Nicko Cadell</author>
  8772. <author>Gert Driesen</author>
  8773. </member>
  8774. <member name="M:log4net.Config.XmlConfigurator.#ctor">
  8775. <summary>
  8776. Private constructor
  8777. </summary>
  8778. </member>
  8779. <member name="M:log4net.Config.XmlConfigurator.Configure">
  8780. <summary>
  8781. Automatically configures the log4net system based on the
  8782. application's configuration settings.
  8783. </summary>
  8784. <remarks>
  8785. <para>
  8786. Each application has a configuration file. This has the
  8787. same name as the application with '.config' appended.
  8788. This file is XML and calling this function prompts the
  8789. configurator to look in that file for a section called
  8790. <c>log4net</c> that contains the configuration data.
  8791. </para>
  8792. <para>
  8793. To use this method to configure log4net you must specify
  8794. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  8795. handler for the <c>log4net</c> configuration section. See the
  8796. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  8797. </para>
  8798. </remarks>
  8799. <seealso cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/>
  8800. </member>
  8801. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  8802. <summary>
  8803. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  8804. stored in the application's configuration file.
  8805. </summary>
  8806. <remarks>
  8807. <para>
  8808. Each application has a configuration file. This has the
  8809. same name as the application with '.config' appended.
  8810. This file is XML and calling this function prompts the
  8811. configurator to look in that file for a section called
  8812. <c>log4net</c> that contains the configuration data.
  8813. </para>
  8814. <para>
  8815. To use this method to configure log4net you must specify
  8816. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  8817. handler for the <c>log4net</c> configuration section. See the
  8818. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  8819. </para>
  8820. </remarks>
  8821. <param name="repository">The repository to configure.</param>
  8822. </member>
  8823. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Xml.XmlElement)">
  8824. <summary>
  8825. Configures log4net using a <c>log4net</c> element
  8826. </summary>
  8827. <remarks>
  8828. <para>
  8829. Loads the log4net configuration from the XML element
  8830. supplied as <paramref name="element"/>.
  8831. </para>
  8832. </remarks>
  8833. <param name="element">The element to parse.</param>
  8834. </member>
  8835. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  8836. <summary>
  8837. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  8838. element.
  8839. </summary>
  8840. <remarks>
  8841. Loads the log4net configuration from the XML element
  8842. supplied as <paramref name="element"/>.
  8843. </remarks>
  8844. <param name="repository">The repository to configure.</param>
  8845. <param name="element">The element to parse.</param>
  8846. </member>
  8847. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)">
  8848. <summary>
  8849. Configures log4net using the specified configuration file.
  8850. </summary>
  8851. <param name="configFile">The XML file to load the configuration from.</param>
  8852. <remarks>
  8853. <para>
  8854. The configuration file must be valid XML. It must contain
  8855. at least one element called <c>log4net</c> that holds
  8856. the log4net configuration data.
  8857. </para>
  8858. <para>
  8859. The log4net configuration file can possible be specified in the application's
  8860. configuration file (either <c>MyAppName.exe.config</c> for a
  8861. normal application on <c>Web.config</c> for an ASP.NET application).
  8862. </para>
  8863. <para>
  8864. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  8865. configuration. If this file is also a .NET .config file then you must specify
  8866. a configuration section for the <c>log4net</c> element otherwise .NET will
  8867. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  8868. <code lang="XML" escaped="true">
  8869. <configSections>
  8870. <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
  8871. </configSections>
  8872. </code>
  8873. </para>
  8874. <example>
  8875. The following example configures log4net using a configuration file, of which the
  8876. location is stored in the application's configuration file :
  8877. </example>
  8878. <code lang="C#">
  8879. using log4net.Config;
  8880. using System.IO;
  8881. using System.Configuration;
  8882. ...
  8883. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  8884. </code>
  8885. <para>
  8886. In the <c>.config</c> file, the path to the log4net can be specified like this :
  8887. </para>
  8888. <code lang="XML" escaped="true">
  8889. <configuration>
  8890. <appSettings>
  8891. <add key="log4net-config-file" value="log.config"/>
  8892. </appSettings>
  8893. </configuration>
  8894. </code>
  8895. </remarks>
  8896. </member>
  8897. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Uri)">
  8898. <summary>
  8899. Configures log4net using the specified configuration URI.
  8900. </summary>
  8901. <param name="configUri">A URI to load the XML configuration from.</param>
  8902. <remarks>
  8903. <para>
  8904. The configuration data must be valid XML. It must contain
  8905. at least one element called <c>log4net</c> that holds
  8906. the log4net configuration data.
  8907. </para>
  8908. <para>
  8909. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  8910. </para>
  8911. </remarks>
  8912. </member>
  8913. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.Stream)">
  8914. <summary>
  8915. Configures log4net using the specified configuration data stream.
  8916. </summary>
  8917. <param name="configStream">A stream to load the XML configuration from.</param>
  8918. <remarks>
  8919. <para>
  8920. The configuration data must be valid XML. It must contain
  8921. at least one element called <c>log4net</c> that holds
  8922. the log4net configuration data.
  8923. </para>
  8924. <para>
  8925. Note that this method will NOT close the stream parameter.
  8926. </para>
  8927. </remarks>
  8928. </member>
  8929. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8930. <summary>
  8931. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  8932. file.
  8933. </summary>
  8934. <param name="repository">The repository to configure.</param>
  8935. <param name="configFile">The XML file to load the configuration from.</param>
  8936. <remarks>
  8937. <para>
  8938. The configuration file must be valid XML. It must contain
  8939. at least one element called <c>log4net</c> that holds
  8940. the configuration data.
  8941. </para>
  8942. <para>
  8943. The log4net configuration file can possible be specified in the application's
  8944. configuration file (either <c>MyAppName.exe.config</c> for a
  8945. normal application on <c>Web.config</c> for an ASP.NET application).
  8946. </para>
  8947. <para>
  8948. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  8949. configuration. If this file is also a .NET .config file then you must specify
  8950. a configuration section for the <c>log4net</c> element otherwise .NET will
  8951. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  8952. <code lang="XML" escaped="true">
  8953. <configSections>
  8954. <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
  8955. </configSections>
  8956. </code>
  8957. </para>
  8958. <example>
  8959. The following example configures log4net using a configuration file, of which the
  8960. location is stored in the application's configuration file :
  8961. </example>
  8962. <code lang="C#">
  8963. using log4net.Config;
  8964. using System.IO;
  8965. using System.Configuration;
  8966. ...
  8967. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  8968. </code>
  8969. <para>
  8970. In the <c>.config</c> file, the path to the log4net can be specified like this :
  8971. </para>
  8972. <code lang="XML" escaped="true">
  8973. <configuration>
  8974. <appSettings>
  8975. <add key="log4net-config-file" value="log.config"/>
  8976. </appSettings>
  8977. </configuration>
  8978. </code>
  8979. </remarks>
  8980. </member>
  8981. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)">
  8982. <summary>
  8983. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  8984. URI.
  8985. </summary>
  8986. <param name="repository">The repository to configure.</param>
  8987. <param name="configUri">A URI to load the XML configuration from.</param>
  8988. <remarks>
  8989. <para>
  8990. The configuration data must be valid XML. It must contain
  8991. at least one element called <c>log4net</c> that holds
  8992. the configuration data.
  8993. </para>
  8994. <para>
  8995. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  8996. </para>
  8997. </remarks>
  8998. </member>
  8999. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  9000. <summary>
  9001. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9002. file.
  9003. </summary>
  9004. <param name="repository">The repository to configure.</param>
  9005. <param name="configStream">The stream to load the XML configuration from.</param>
  9006. <remarks>
  9007. <para>
  9008. The configuration data must be valid XML. It must contain
  9009. at least one element called <c>log4net</c> that holds
  9010. the configuration data.
  9011. </para>
  9012. <para>
  9013. Note that this method will NOT close the stream parameter.
  9014. </para>
  9015. </remarks>
  9016. </member>
  9017. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  9018. <summary>
  9019. Configures log4net using the file specified, monitors the file for changes
  9020. and reloads the configuration if a change is detected.
  9021. </summary>
  9022. <param name="configFile">The XML file to load the configuration from.</param>
  9023. <remarks>
  9024. <para>
  9025. The configuration file must be valid XML. It must contain
  9026. at least one element called <c>log4net</c> that holds
  9027. the configuration data.
  9028. </para>
  9029. <para>
  9030. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9031. and depends on the behavior of that class.
  9032. </para>
  9033. <para>
  9034. For more information on how to configure log4net using
  9035. a separate configuration file, see <see cref="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)"/>.
  9036. </para>
  9037. </remarks>
  9038. <seealso cref="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)"/>
  9039. </member>
  9040. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9041. <summary>
  9042. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  9043. monitors the file for changes and reloads the configuration if a change
  9044. is detected.
  9045. </summary>
  9046. <param name="repository">The repository to configure.</param>
  9047. <param name="configFile">The XML file to load the configuration from.</param>
  9048. <remarks>
  9049. <para>
  9050. The configuration file must be valid XML. It must contain
  9051. at least one element called <c>log4net</c> that holds
  9052. the configuration data.
  9053. </para>
  9054. <para>
  9055. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9056. and depends on the behavior of that class.
  9057. </para>
  9058. <para>
  9059. For more information on how to configure log4net using
  9060. a separate configuration file, see <see cref="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)"/>.
  9061. </para>
  9062. </remarks>
  9063. <seealso cref="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)"/>
  9064. </member>
  9065. <member name="M:log4net.Config.XmlConfigurator.ConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9066. <summary>
  9067. Configures the specified repository using a <c>log4net</c> element.
  9068. </summary>
  9069. <param name="repository">The hierarchy to configure.</param>
  9070. <param name="element">The element to parse.</param>
  9071. <remarks>
  9072. <para>
  9073. Loads the log4net configuration from the XML element
  9074. supplied as <paramref name="element"/>.
  9075. </para>
  9076. <para>
  9077. This method is ultimately called by one of the Configure methods
  9078. to load the configuration from an <see cref="T:System.Xml.XmlElement"/>.
  9079. </para>
  9080. </remarks>
  9081. </member>
  9082. <member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler">
  9083. <summary>
  9084. Class used to watch config files.
  9085. </summary>
  9086. <remarks>
  9087. <para>
  9088. Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor
  9089. changes to a specified file. Because multiple change notifications
  9090. may be raised when the file is modified, a timer is used to
  9091. compress the notifications into a single event. The timer
  9092. waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering
  9093. the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/>
  9094. change notifications arrive while the timer is waiting it
  9095. is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to
  9096. elapse.
  9097. </para>
  9098. </remarks>
  9099. </member>
  9100. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis">
  9101. <summary>
  9102. The default amount of time to wait after receiving notification
  9103. before reloading the config file.
  9104. </summary>
  9105. </member>
  9106. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.StartWatching(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9107. <summary>
  9108. Watch a specified config file used to configure a repository
  9109. </summary>
  9110. <param name="repository">The repository to configure.</param>
  9111. <param name="configFile">The configuration file to watch.</param>
  9112. <remarks>
  9113. <para>
  9114. Watch a specified config file used to configure a repository
  9115. </para>
  9116. </remarks>
  9117. </member>
  9118. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile">
  9119. <summary>
  9120. Holds the FileInfo used to configure the XmlConfigurator
  9121. </summary>
  9122. </member>
  9123. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository">
  9124. <summary>
  9125. Holds the repository being configured.
  9126. </summary>
  9127. </member>
  9128. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer">
  9129. <summary>
  9130. The timer used to compress the notification events.
  9131. </summary>
  9132. </member>
  9133. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9134. <summary>
  9135. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class.
  9136. </summary>
  9137. <param name="repository">The repository to configure.</param>
  9138. <param name="configFile">The configuration file to watch.</param>
  9139. <remarks>
  9140. <para>
  9141. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class.
  9142. </para>
  9143. </remarks>
  9144. </member>
  9145. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)">
  9146. <summary>
  9147. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  9148. </summary>
  9149. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  9150. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  9151. <remarks>
  9152. <para>
  9153. This handler reloads the configuration from the file when the event is fired.
  9154. </para>
  9155. </remarks>
  9156. </member>
  9157. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)">
  9158. <summary>
  9159. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  9160. </summary>
  9161. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  9162. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  9163. <remarks>
  9164. <para>
  9165. This handler reloads the configuration from the file when the event is fired.
  9166. </para>
  9167. </remarks>
  9168. </member>
  9169. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)">
  9170. <summary>
  9171. Called by the timer when the configuration has been updated.
  9172. </summary>
  9173. <param name="state">null</param>
  9174. </member>
  9175. <member name="T:log4net.Core.CompactRepositorySelector">
  9176. <summary>
  9177. The implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface suitable
  9178. for use with the compact framework
  9179. </summary>
  9180. <remarks>
  9181. <para>
  9182. This <see cref="T:log4net.Core.IRepositorySelector"/> implementation is a simple
  9183. mapping between repository name and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9184. object.
  9185. </para>
  9186. <para>
  9187. The .NET Compact Framework 1.0 does not support retrieving assembly
  9188. level attributes therefore unlike the <c>DefaultRepositorySelector</c>
  9189. this selector does not examine the calling assembly for attributes.
  9190. </para>
  9191. </remarks>
  9192. <author>Nicko Cadell</author>
  9193. </member>
  9194. <member name="T:log4net.Core.IRepositorySelector">
  9195. <summary>
  9196. Interface used by the <see cref="T:log4net.LogManager"/> to select the <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9197. </summary>
  9198. <remarks>
  9199. <para>
  9200. The <see cref="T:log4net.LogManager"/> uses a <see cref="T:log4net.Core.IRepositorySelector"/>
  9201. to specify the policy for selecting the correct <see cref="T:log4net.Repository.ILoggerRepository"/>
  9202. to return to the caller.
  9203. </para>
  9204. </remarks>
  9205. <author>Nicko Cadell</author>
  9206. <author>Gert Driesen</author>
  9207. </member>
  9208. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)">
  9209. <summary>
  9210. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9211. </summary>
  9212. <param name="assembly">The assembly to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9213. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly.</returns>
  9214. <remarks>
  9215. <para>
  9216. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9217. </para>
  9218. <para>
  9219. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9220. is made is not defined. The implementation may choose any method for
  9221. this association. The results of this method must be repeatable, i.e.
  9222. when called again with the same arguments the result must be the
  9223. save value.
  9224. </para>
  9225. </remarks>
  9226. </member>
  9227. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.String)">
  9228. <summary>
  9229. Gets the named <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9230. </summary>
  9231. <param name="repositoryName">The name to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9232. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9233. <remarks>
  9234. Lookup a named <see cref="T:log4net.Repository.ILoggerRepository"/>. This is the repository created by
  9235. calling <see cref="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)"/>.
  9236. </remarks>
  9237. </member>
  9238. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  9239. <summary>
  9240. Creates a new repository for the assembly specified.
  9241. </summary>
  9242. <param name="assembly">The assembly to use to create the domain to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9243. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9244. <returns>The repository created.</returns>
  9245. <remarks>
  9246. <para>
  9247. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the domain
  9248. specified such that a call to <see cref="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)"/> with the
  9249. same assembly specified will return the same repository instance.
  9250. </para>
  9251. <para>
  9252. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9253. is made is not defined. The implementation may choose any method for
  9254. this association.
  9255. </para>
  9256. </remarks>
  9257. </member>
  9258. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)">
  9259. <summary>
  9260. Creates a new repository with the name specified.
  9261. </summary>
  9262. <param name="repositoryName">The name to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9263. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9264. <returns>The repository created.</returns>
  9265. <remarks>
  9266. <para>
  9267. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the name
  9268. specified such that a call to <see cref="M:log4net.Core.IRepositorySelector.GetRepository(System.String)"/> with the
  9269. same name will return the same repository instance.
  9270. </para>
  9271. </remarks>
  9272. </member>
  9273. <member name="M:log4net.Core.IRepositorySelector.ExistsRepository(System.String)">
  9274. <summary>
  9275. Test if a named repository exists
  9276. </summary>
  9277. <param name="repositoryName">the named repository to check</param>
  9278. <returns><c>true</c> if the repository exists</returns>
  9279. <remarks>
  9280. <para>
  9281. Test if a named repository exists. Use <see cref="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)"/>
  9282. to create a new repository and <see cref="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)"/> to retrieve
  9283. a repository.
  9284. </para>
  9285. </remarks>
  9286. </member>
  9287. <member name="M:log4net.Core.IRepositorySelector.GetAllRepositories">
  9288. <summary>
  9289. Gets an array of all currently defined repositories.
  9290. </summary>
  9291. <returns>
  9292. An array of the <see cref="T:log4net.Repository.ILoggerRepository"/> instances created by
  9293. this <see cref="T:log4net.Core.IRepositorySelector"/>.</returns>
  9294. <remarks>
  9295. <para>
  9296. Gets an array of all of the repositories created by this selector.
  9297. </para>
  9298. </remarks>
  9299. </member>
  9300. <member name="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent">
  9301. <summary>
  9302. Event to notify that a logger repository has been created.
  9303. </summary>
  9304. <value>
  9305. Event to notify that a logger repository has been created.
  9306. </value>
  9307. <remarks>
  9308. <para>
  9309. Event raised when a new repository is created.
  9310. The event source will be this selector. The event args will
  9311. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  9312. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9313. </para>
  9314. </remarks>
  9315. </member>
  9316. <member name="M:log4net.Core.CompactRepositorySelector.#ctor(System.Type)">
  9317. <summary>
  9318. Create a new repository selector
  9319. </summary>
  9320. <param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9321. <remarks>
  9322. <para>
  9323. Create an new compact repository selector.
  9324. The default type for repositories must be specified,
  9325. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  9326. </para>
  9327. </remarks>
  9328. <exception cref="T:System.ArgumentNullException">throw if <paramref name="defaultRepositoryType"/> is null</exception>
  9329. <exception cref="T:System.ArgumentOutOfRangeException">throw if <paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/></exception>
  9330. </member>
  9331. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)">
  9332. <summary>
  9333. Get the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly
  9334. </summary>
  9335. <param name="assembly">not used</param>
  9336. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9337. <remarks>
  9338. <para>
  9339. The <paramref name="assembly"/> argument is not used. This selector does not create a
  9340. separate repository for each assembly.
  9341. </para>
  9342. <para>
  9343. As a named repository is not specified the default repository is
  9344. returned. The default repository is named <c>log4net-default-repository</c>.
  9345. </para>
  9346. </remarks>
  9347. </member>
  9348. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)">
  9349. <summary>
  9350. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>
  9351. </summary>
  9352. <param name="repositoryName">the name of the repository to lookup</param>
  9353. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9354. <remarks>
  9355. <para>
  9356. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>. The default
  9357. repository is <c>log4net-default-repository</c>. Other repositories
  9358. must be created using the <see cref="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)"/>.
  9359. If the named repository does not exist an exception is thrown.
  9360. </para>
  9361. </remarks>
  9362. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  9363. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> does not exist</exception>
  9364. </member>
  9365. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  9366. <summary>
  9367. Create a new repository for the assembly specified
  9368. </summary>
  9369. <param name="assembly">not used</param>
  9370. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9371. <returns>the repository created</returns>
  9372. <remarks>
  9373. <para>
  9374. The <paramref name="assembly"/> argument is not used. This selector does not create a
  9375. separate repository for each assembly.
  9376. </para>
  9377. <para>
  9378. If the <paramref name="repositoryType"/> is <c>null</c> then the
  9379. default repository type specified to the constructor is used.
  9380. </para>
  9381. <para>
  9382. As a named repository is not specified the default repository is
  9383. returned. The default repository is named <c>log4net-default-repository</c>.
  9384. </para>
  9385. </remarks>
  9386. </member>
  9387. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)">
  9388. <summary>
  9389. Create a new repository for the repository specified
  9390. </summary>
  9391. <param name="repositoryName">the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9392. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9393. If this param is null then the default repository type is used.</param>
  9394. <returns>the repository created</returns>
  9395. <remarks>
  9396. <para>
  9397. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  9398. specified such that a call to <see cref="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)"/> with the
  9399. same repository specified will return the same repository instance.
  9400. </para>
  9401. <para>
  9402. If the named repository already exists an exception will be thrown.
  9403. </para>
  9404. <para>
  9405. If <paramref name="repositoryType"/> is <c>null</c> then the default
  9406. repository type specified to the constructor is used.
  9407. </para>
  9408. </remarks>
  9409. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  9410. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> already exists</exception>
  9411. </member>
  9412. <member name="M:log4net.Core.CompactRepositorySelector.ExistsRepository(System.String)">
  9413. <summary>
  9414. Test if a named repository exists
  9415. </summary>
  9416. <param name="repositoryName">the named repository to check</param>
  9417. <returns><c>true</c> if the repository exists</returns>
  9418. <remarks>
  9419. <para>
  9420. Test if a named repository exists. Use <see cref="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)"/>
  9421. to create a new repository and <see cref="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)"/> to retrieve
  9422. a repository.
  9423. </para>
  9424. </remarks>
  9425. </member>
  9426. <member name="M:log4net.Core.CompactRepositorySelector.GetAllRepositories">
  9427. <summary>
  9428. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  9429. </summary>
  9430. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  9431. <remarks>
  9432. <para>
  9433. Gets an array of all of the repositories created by this selector.
  9434. </para>
  9435. </remarks>
  9436. </member>
  9437. <member name="M:log4net.Core.CompactRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  9438. <summary>
  9439. Notify the registered listeners that the repository has been created
  9440. </summary>
  9441. <param name="repository">The repository that has been created</param>
  9442. <remarks>
  9443. <para>
  9444. Raises the <event cref="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">LoggerRepositoryCreatedEvent</event>
  9445. event.
  9446. </para>
  9447. </remarks>
  9448. </member>
  9449. <member name="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">
  9450. <summary>
  9451. Event to notify that a logger repository has been created.
  9452. </summary>
  9453. <value>
  9454. Event to notify that a logger repository has been created.
  9455. </value>
  9456. <remarks>
  9457. <para>
  9458. Event raised when a new repository is created.
  9459. The event source will be this selector. The event args will
  9460. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  9461. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9462. </para>
  9463. </remarks>
  9464. </member>
  9465. <member name="T:log4net.Core.DefaultRepositorySelector">
  9466. <summary>
  9467. The default implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface.
  9468. </summary>
  9469. <remarks>
  9470. <para>
  9471. Uses attributes defined on the calling assembly to determine how to
  9472. configure the hierarchy for the repository.
  9473. </para>
  9474. </remarks>
  9475. <author>Nicko Cadell</author>
  9476. <author>Gert Driesen</author>
  9477. </member>
  9478. <member name="M:log4net.Core.DefaultRepositorySelector.#ctor(System.Type)">
  9479. <summary>
  9480. Creates a new repository selector.
  9481. </summary>
  9482. <param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9483. <remarks>
  9484. <para>
  9485. Create an new repository selector.
  9486. The default type for repositories must be specified,
  9487. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  9488. </para>
  9489. </remarks>
  9490. <exception cref="T:System.ArgumentNullException"><paramref name="defaultRepositoryType"/> is <see langword="null"/>.</exception>
  9491. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</exception>
  9492. </member>
  9493. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)">
  9494. <summary>
  9495. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9496. </summary>
  9497. <param name="repositoryAssembly">The assembly use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9498. <remarks>
  9499. <para>
  9500. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository
  9501. to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/>
  9502. attribute on the <paramref name="repositoryAssembly"/>.
  9503. </para>
  9504. <para>
  9505. The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  9506. implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  9507. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  9508. </para>
  9509. <para>
  9510. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using
  9511. any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on
  9512. the <paramref name="repositoryAssembly"/>.
  9513. </para>
  9514. </remarks>
  9515. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns>
  9516. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  9517. </member>
  9518. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)">
  9519. <summary>
  9520. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.
  9521. </summary>
  9522. <param name="repositoryName">The repository to use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9523. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.</returns>
  9524. <remarks>
  9525. <para>
  9526. Returns the named repository. If <paramref name="repositoryName"/> is <c>null</c>
  9527. a <see cref="T:System.ArgumentNullException"/> is thrown. If the repository
  9528. does not exist a <see cref="T:log4net.Core.LogException"/> is thrown.
  9529. </para>
  9530. <para>
  9531. Use <see cref="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)"/> to create a repository.
  9532. </para>
  9533. </remarks>
  9534. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
  9535. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> does not exist.</exception>
  9536. </member>
  9537. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  9538. <summary>
  9539. Create a new repository for the assembly specified
  9540. </summary>
  9541. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9542. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9543. <returns>The repository created.</returns>
  9544. <remarks>
  9545. <para>
  9546. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  9547. specified such that a call to <see cref="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)"/> with the
  9548. same assembly specified will return the same repository instance.
  9549. </para>
  9550. <para>
  9551. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  9552. the repository to create can be overridden by specifying the
  9553. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  9554. <paramref name="repositoryAssembly"/>. The default values are to use the
  9555. <paramref name="repositoryType"/> implementation of the
  9556. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  9557. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  9558. </para>
  9559. <para>
  9560. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  9561. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  9562. attributes defined on the <paramref name="repositoryAssembly"/>.
  9563. </para>
  9564. <para>
  9565. If a repository for the <paramref name="repositoryAssembly"/> already exists
  9566. that repository will be returned. An error will not be raised and that
  9567. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  9568. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  9569. assembly may be used to override the repository type specified in
  9570. <paramref name="repositoryType"/>.
  9571. </para>
  9572. </remarks>
  9573. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  9574. </member>
  9575. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type,System.String,System.Boolean)">
  9576. <summary>
  9577. Creates a new repository for the assembly specified.
  9578. </summary>
  9579. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9580. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9581. <param name="repositoryName">The name to assign to the created repository</param>
  9582. <param name="readAssemblyAttributes">Set to <c>true</c> to read and apply the assembly attributes</param>
  9583. <returns>The repository created.</returns>
  9584. <remarks>
  9585. <para>
  9586. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  9587. specified such that a call to <see cref="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)"/> with the
  9588. same assembly specified will return the same repository instance.
  9589. </para>
  9590. <para>
  9591. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  9592. the repository to create can be overridden by specifying the
  9593. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  9594. <paramref name="repositoryAssembly"/>. The default values are to use the
  9595. <paramref name="repositoryType"/> implementation of the
  9596. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  9597. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  9598. </para>
  9599. <para>
  9600. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  9601. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  9602. attributes defined on the <paramref name="repositoryAssembly"/>.
  9603. </para>
  9604. <para>
  9605. If a repository for the <paramref name="repositoryAssembly"/> already exists
  9606. that repository will be returned. An error will not be raised and that
  9607. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  9608. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  9609. assembly may be used to override the repository type specified in
  9610. <paramref name="repositoryType"/>.
  9611. </para>
  9612. </remarks>
  9613. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  9614. </member>
  9615. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)">
  9616. <summary>
  9617. Creates a new repository for the specified repository.
  9618. </summary>
  9619. <param name="repositoryName">The repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9620. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9621. If this param is <see langword="null"/> then the default repository type is used.</param>
  9622. <returns>The new repository.</returns>
  9623. <remarks>
  9624. <para>
  9625. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  9626. specified such that a call to <see cref="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)"/> with the
  9627. same repository specified will return the same repository instance.
  9628. </para>
  9629. </remarks>
  9630. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
  9631. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> already exists.</exception>
  9632. </member>
  9633. <member name="M:log4net.Core.DefaultRepositorySelector.ExistsRepository(System.String)">
  9634. <summary>
  9635. Test if a named repository exists
  9636. </summary>
  9637. <param name="repositoryName">the named repository to check</param>
  9638. <returns><c>true</c> if the repository exists</returns>
  9639. <remarks>
  9640. <para>
  9641. Test if a named repository exists. Use <see cref="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)"/>
  9642. to create a new repository and <see cref="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)"/> to retrieve
  9643. a repository.
  9644. </para>
  9645. </remarks>
  9646. </member>
  9647. <member name="M:log4net.Core.DefaultRepositorySelector.GetAllRepositories">
  9648. <summary>
  9649. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  9650. </summary>
  9651. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  9652. <remarks>
  9653. <para>
  9654. Gets an array of all of the repositories created by this selector.
  9655. </para>
  9656. </remarks>
  9657. </member>
  9658. <member name="M:log4net.Core.DefaultRepositorySelector.AliasRepository(System.String,log4net.Repository.ILoggerRepository)">
  9659. <summary>
  9660. Aliases a repository to an existing repository.
  9661. </summary>
  9662. <param name="repositoryAlias">The repository to alias.</param>
  9663. <param name="repositoryTarget">The repository that the repository is aliased to.</param>
  9664. <remarks>
  9665. <para>
  9666. The repository specified will be aliased to the repository when created.
  9667. The repository must not already exist.
  9668. </para>
  9669. <para>
  9670. When the repository is created it must utilize the same repository type as
  9671. the repository it is aliased to, otherwise the aliasing will fail.
  9672. </para>
  9673. </remarks>
  9674. <exception cref="T:System.ArgumentNullException">
  9675. <para><paramref name="repositoryAlias"/> is <see langword="null"/>.</para>
  9676. <para>-or-</para>
  9677. <para><paramref name="repositoryTarget"/> is <see langword="null"/>.</para>
  9678. </exception>
  9679. </member>
  9680. <member name="M:log4net.Core.DefaultRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  9681. <summary>
  9682. Notifies the registered listeners that the repository has been created.
  9683. </summary>
  9684. <param name="repository">The repository that has been created.</param>
  9685. <remarks>
  9686. <para>
  9687. Raises the <see cref="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  9688. </para>
  9689. </remarks>
  9690. </member>
  9691. <member name="M:log4net.Core.DefaultRepositorySelector.GetInfoForAssembly(System.Reflection.Assembly,System.String@,System.Type@)">
  9692. <summary>
  9693. Gets the repository name and repository type for the specified assembly.
  9694. </summary>
  9695. <param name="assembly">The assembly that has a <see cref="T:log4net.Config.RepositoryAttribute"/>.</param>
  9696. <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>
  9697. <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>
  9698. <exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is <see langword="null"/>.</exception>
  9699. </member>
  9700. <member name="M:log4net.Core.DefaultRepositorySelector.ConfigureRepository(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9701. <summary>
  9702. Configures the repository using information from the assembly.
  9703. </summary>
  9704. <param name="assembly">The assembly containing <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  9705. attributes which define the configuration for the repository.</param>
  9706. <param name="repository">The repository to configure.</param>
  9707. <exception cref="T:System.ArgumentNullException">
  9708. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  9709. <para>-or-</para>
  9710. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  9711. </exception>
  9712. </member>
  9713. <member name="M:log4net.Core.DefaultRepositorySelector.LoadPlugins(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9714. <summary>
  9715. Loads the attribute defined plugins on the assembly.
  9716. </summary>
  9717. <param name="assembly">The assembly that contains the attributes.</param>
  9718. <param name="repository">The repository to add the plugins to.</param>
  9719. <exception cref="T:System.ArgumentNullException">
  9720. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  9721. <para>-or-</para>
  9722. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  9723. </exception>
  9724. </member>
  9725. <member name="M:log4net.Core.DefaultRepositorySelector.LoadAliases(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9726. <summary>
  9727. Loads the attribute defined aliases on the assembly.
  9728. </summary>
  9729. <param name="assembly">The assembly that contains the attributes.</param>
  9730. <param name="repository">The repository to alias to.</param>
  9731. <exception cref="T:System.ArgumentNullException">
  9732. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  9733. <para>-or-</para>
  9734. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  9735. </exception>
  9736. </member>
  9737. <member name="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent">
  9738. <summary>
  9739. Event to notify that a logger repository has been created.
  9740. </summary>
  9741. <value>
  9742. Event to notify that a logger repository has been created.
  9743. </value>
  9744. <remarks>
  9745. <para>
  9746. Event raised when a new repository is created.
  9747. The event source will be this selector. The event args will
  9748. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  9749. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9750. </para>
  9751. </remarks>
  9752. </member>
  9753. <member name="T:log4net.Core.ErrorCode">
  9754. <summary>
  9755. Defined error codes that can be passed to the <see cref="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)"/> method.
  9756. </summary>
  9757. <remarks>
  9758. <para>
  9759. Values passed to the <see cref="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)"/> method.
  9760. </para>
  9761. </remarks>
  9762. <author>Nicko Cadell</author>
  9763. </member>
  9764. <member name="F:log4net.Core.ErrorCode.GenericFailure">
  9765. <summary>
  9766. A general error
  9767. </summary>
  9768. </member>
  9769. <member name="F:log4net.Core.ErrorCode.WriteFailure">
  9770. <summary>
  9771. Error while writing output
  9772. </summary>
  9773. </member>
  9774. <member name="F:log4net.Core.ErrorCode.FlushFailure">
  9775. <summary>
  9776. Failed to flush file
  9777. </summary>
  9778. </member>
  9779. <member name="F:log4net.Core.ErrorCode.CloseFailure">
  9780. <summary>
  9781. Failed to close file
  9782. </summary>
  9783. </member>
  9784. <member name="F:log4net.Core.ErrorCode.FileOpenFailure">
  9785. <summary>
  9786. Unable to open output file
  9787. </summary>
  9788. </member>
  9789. <member name="F:log4net.Core.ErrorCode.MissingLayout">
  9790. <summary>
  9791. No layout specified
  9792. </summary>
  9793. </member>
  9794. <member name="F:log4net.Core.ErrorCode.AddressParseFailure">
  9795. <summary>
  9796. Failed to parse address
  9797. </summary>
  9798. </member>
  9799. <member name="T:log4net.Core.IErrorHandler">
  9800. <summary>
  9801. Appenders may delegate their error handling to an <see cref="T:log4net.Core.IErrorHandler"/>.
  9802. </summary>
  9803. <remarks>
  9804. <para>
  9805. Error handling is a particularly tedious to get right because by
  9806. definition errors are hard to predict and to reproduce.
  9807. </para>
  9808. </remarks>
  9809. <author>Nicko Cadell</author>
  9810. <author>Gert Driesen</author>
  9811. </member>
  9812. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  9813. <summary>
  9814. Handles the error and information about the error condition is passed as
  9815. a parameter.
  9816. </summary>
  9817. <param name="message">The message associated with the error.</param>
  9818. <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
  9819. <param name="errorCode">The error code associated with the error.</param>
  9820. <remarks>
  9821. <para>
  9822. Handles the error and information about the error condition is passed as
  9823. a parameter.
  9824. </para>
  9825. </remarks>
  9826. </member>
  9827. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception)">
  9828. <summary>
  9829. Prints the error message passed as a parameter.
  9830. </summary>
  9831. <param name="message">The message associated with the error.</param>
  9832. <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
  9833. <remarks>
  9834. <para>
  9835. See <see cref="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)"/>.
  9836. </para>
  9837. </remarks>
  9838. </member>
  9839. <member name="M:log4net.Core.IErrorHandler.Error(System.String)">
  9840. <summary>
  9841. Prints the error message passed as a parameter.
  9842. </summary>
  9843. <param name="message">The message associated with the error.</param>
  9844. <remarks>
  9845. <para>
  9846. See <see cref="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)"/>.
  9847. </para>
  9848. </remarks>
  9849. </member>
  9850. <member name="T:log4net.Core.IFixingRequired">
  9851. <summary>
  9852. Interface for objects that require fixing.
  9853. </summary>
  9854. <remarks>
  9855. <para>
  9856. Interface that indicates that the object requires fixing before it
  9857. can be taken outside the context of the appender's
  9858. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  9859. </para>
  9860. <para>
  9861. When objects that implement this interface are stored
  9862. in the context properties maps <see cref="T:log4net.GlobalContext"/>
  9863. <see cref="P:log4net.GlobalContext.Properties"/> and <see cref="T:log4net.ThreadContext"/>
  9864. <see cref="P:log4net.ThreadContext.Properties"/> are fixed
  9865. (see <see cref="P:log4net.Core.LoggingEvent.Fix"/>) the <see cref="M:log4net.Core.IFixingRequired.GetFixedObject"/>
  9866. method will be called.
  9867. </para>
  9868. </remarks>
  9869. <author>Nicko Cadell</author>
  9870. </member>
  9871. <member name="M:log4net.Core.IFixingRequired.GetFixedObject">
  9872. <summary>
  9873. Get a portable version of this object
  9874. </summary>
  9875. <returns>the portable instance of this object</returns>
  9876. <remarks>
  9877. <para>
  9878. Get a portable instance object that represents the current
  9879. state of this object. The portable object can be stored
  9880. and logged from any thread with identical results.
  9881. </para>
  9882. </remarks>
  9883. </member>
  9884. <member name="T:log4net.Core.ILogger">
  9885. <summary>
  9886. Interface that all loggers implement
  9887. </summary>
  9888. <remarks>
  9889. <para>
  9890. This interface supports logging events and testing if a level
  9891. is enabled for logging.
  9892. </para>
  9893. <para>
  9894. These methods will not throw exceptions. Note to implementor, ensure
  9895. that the implementation of these methods cannot allow an exception
  9896. to be thrown to the caller.
  9897. </para>
  9898. </remarks>
  9899. <author>Nicko Cadell</author>
  9900. <author>Gert Driesen</author>
  9901. </member>
  9902. <member name="M:log4net.Core.ILogger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  9903. <summary>
  9904. This generic form is intended to be used by wrappers.
  9905. </summary>
  9906. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  9907. the stack boundary into the logging system for this call.</param>
  9908. <param name="level">The level of the message to be logged.</param>
  9909. <param name="message">The message object to log.</param>
  9910. <param name="exception">the exception to log, including its stack trace. Pass <c>null</c> to not log an exception.</param>
  9911. <remarks>
  9912. <para>
  9913. Generates a logging event for the specified <paramref name="level"/> using
  9914. the <paramref name="message"/> and <paramref name="exception"/>.
  9915. </para>
  9916. </remarks>
  9917. </member>
  9918. <member name="M:log4net.Core.ILogger.Log(log4net.Core.LoggingEvent)">
  9919. <summary>
  9920. This is the most generic printing method that is intended to be used
  9921. by wrappers.
  9922. </summary>
  9923. <param name="logEvent">The event being logged.</param>
  9924. <remarks>
  9925. <para>
  9926. Logs the specified logging event through this logger.
  9927. </para>
  9928. </remarks>
  9929. </member>
  9930. <member name="M:log4net.Core.ILogger.IsEnabledFor(log4net.Core.Level)">
  9931. <summary>
  9932. Checks if this logger is enabled for a given <see cref="T:log4net.Core.Level"/> passed as parameter.
  9933. </summary>
  9934. <param name="level">The level to check.</param>
  9935. <returns>
  9936. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  9937. </returns>
  9938. <remarks>
  9939. <para>
  9940. Test if this logger is going to log events of the specified <paramref name="level"/>.
  9941. </para>
  9942. </remarks>
  9943. </member>
  9944. <member name="P:log4net.Core.ILogger.Name">
  9945. <summary>
  9946. Gets the name of the logger.
  9947. </summary>
  9948. <value>
  9949. The name of the logger.
  9950. </value>
  9951. <remarks>
  9952. <para>
  9953. The name of this logger
  9954. </para>
  9955. </remarks>
  9956. </member>
  9957. <member name="P:log4net.Core.ILogger.Repository">
  9958. <summary>
  9959. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  9960. <c>Logger</c> instance is attached to.
  9961. </summary>
  9962. <value>
  9963. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to.
  9964. </value>
  9965. <remarks>
  9966. <para>
  9967. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  9968. <c>Logger</c> instance is attached to.
  9969. </para>
  9970. </remarks>
  9971. </member>
  9972. <member name="T:log4net.Core.ILoggerWrapper">
  9973. <summary>
  9974. Base interface for all wrappers
  9975. </summary>
  9976. <remarks>
  9977. <para>
  9978. Base interface for all wrappers.
  9979. </para>
  9980. <para>
  9981. All wrappers must implement this interface.
  9982. </para>
  9983. </remarks>
  9984. <author>Nicko Cadell</author>
  9985. </member>
  9986. <member name="P:log4net.Core.ILoggerWrapper.Logger">
  9987. <summary>
  9988. Get the implementation behind this wrapper object.
  9989. </summary>
  9990. <value>
  9991. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this object.
  9992. </value>
  9993. <remarks>
  9994. <para>
  9995. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this
  9996. object. The <c>Logger</c> object may not
  9997. be the same object as this object because of logger decorators.
  9998. This gets the actual underlying objects that is used to process
  9999. the log events.
  10000. </para>
  10001. </remarks>
  10002. </member>
  10003. <member name="T:log4net.Core.LoggerRepositoryCreationEventHandler">
  10004. <summary>
  10005. Delegate used to handle logger repository creation event notifications
  10006. </summary>
  10007. <param name="sender">The <see cref="T:log4net.Core.IRepositorySelector"/> which created the repository.</param>
  10008. <param name="e">The <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> event args
  10009. that holds the <see cref="T:log4net.Repository.ILoggerRepository"/> instance that has been created.</param>
  10010. <remarks>
  10011. <para>
  10012. Delegate used to handle logger repository creation event notifications.
  10013. </para>
  10014. </remarks>
  10015. </member>
  10016. <member name="T:log4net.Core.LoggerRepositoryCreationEventArgs">
  10017. <summary>
  10018. Provides data for the <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  10019. </summary>
  10020. <remarks>
  10021. <para>
  10022. A <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/>
  10023. event is raised every time a <see cref="T:log4net.Repository.ILoggerRepository"/> is created.
  10024. </para>
  10025. </remarks>
  10026. </member>
  10027. <member name="F:log4net.Core.LoggerRepositoryCreationEventArgs.m_repository">
  10028. <summary>
  10029. The <see cref="T:log4net.Repository.ILoggerRepository"/> created
  10030. </summary>
  10031. </member>
  10032. <member name="M:log4net.Core.LoggerRepositoryCreationEventArgs.#ctor(log4net.Repository.ILoggerRepository)">
  10033. <summary>
  10034. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  10035. </summary>
  10036. <param name="repository">the <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created</param>
  10037. <remarks>
  10038. <para>
  10039. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  10040. </para>
  10041. </remarks>
  10042. </member>
  10043. <member name="P:log4net.Core.LoggerRepositoryCreationEventArgs.LoggerRepository">
  10044. <summary>
  10045. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10046. </summary>
  10047. <value>
  10048. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10049. </value>
  10050. <remarks>
  10051. <para>
  10052. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10053. </para>
  10054. </remarks>
  10055. </member>
  10056. <member name="T:log4net.Core.ITriggeringEventEvaluator">
  10057. <summary>
  10058. Test if an <see cref="T:log4net.Core.LoggingEvent"/> triggers an action
  10059. </summary>
  10060. <remarks>
  10061. <para>
  10062. Implementations of this interface allow certain appenders to decide
  10063. when to perform an appender specific action.
  10064. </para>
  10065. <para>
  10066. The action or behavior triggered is defined by the implementation.
  10067. </para>
  10068. </remarks>
  10069. <author>Nicko Cadell</author>
  10070. </member>
  10071. <member name="M:log4net.Core.ITriggeringEventEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  10072. <summary>
  10073. Test if this event triggers the action
  10074. </summary>
  10075. <param name="loggingEvent">The event to check</param>
  10076. <returns><c>true</c> if this event triggers the action, otherwise <c>false</c></returns>
  10077. <remarks>
  10078. <para>
  10079. Return <c>true</c> if this event triggers the action
  10080. </para>
  10081. </remarks>
  10082. </member>
  10083. <member name="T:log4net.Core.Level">
  10084. <summary>
  10085. Defines the default set of levels recognized by the system.
  10086. </summary>
  10087. <remarks>
  10088. <para>
  10089. Each <see cref="T:log4net.Core.LoggingEvent"/> has an associated <see cref="T:log4net.Core.Level"/>.
  10090. </para>
  10091. <para>
  10092. Levels have a numeric <see cref="P:log4net.Core.Level.Value"/> that defines the relative
  10093. ordering between levels. Two Levels with the same <see cref="P:log4net.Core.Level.Value"/>
  10094. are deemed to be equivalent.
  10095. </para>
  10096. <para>
  10097. The levels that are recognized by log4net are set for each <see cref="T:log4net.Repository.ILoggerRepository"/>
  10098. and each repository can have different levels defined. The levels are stored
  10099. in the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> on the repository. Levels are
  10100. looked up by name from the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>.
  10101. </para>
  10102. <para>
  10103. When logging at level INFO the actual level used is not <see cref="F:log4net.Core.Level.Info"/> but
  10104. the value of <c>LoggerRepository.LevelMap["INFO"]</c>. The default value for this is
  10105. <see cref="F:log4net.Core.Level.Info"/>, but this can be changed by reconfiguring the level map.
  10106. </para>
  10107. <para>
  10108. Each level has a <see cref="P:log4net.Core.Level.DisplayName"/> in addition to its <see cref="P:log4net.Core.Level.Name"/>. The
  10109. <see cref="P:log4net.Core.Level.DisplayName"/> is the string that is written into the output log. By default
  10110. the display name is the same as the level name, but this can be used to alias levels
  10111. or to localize the log output.
  10112. </para>
  10113. <para>
  10114. Some of the predefined levels recognized by the system are:
  10115. </para>
  10116. <list type="bullet">
  10117. <item>
  10118. <description><see cref="F:log4net.Core.Level.Off"/>.</description>
  10119. </item>
  10120. <item>
  10121. <description><see cref="F:log4net.Core.Level.Fatal"/>.</description>
  10122. </item>
  10123. <item>
  10124. <description><see cref="F:log4net.Core.Level.Error"/>.</description>
  10125. </item>
  10126. <item>
  10127. <description><see cref="F:log4net.Core.Level.Warn"/>.</description>
  10128. </item>
  10129. <item>
  10130. <description><see cref="F:log4net.Core.Level.Info"/>.</description>
  10131. </item>
  10132. <item>
  10133. <description><see cref="F:log4net.Core.Level.Debug"/>.</description>
  10134. </item>
  10135. <item>
  10136. <description><see cref="F:log4net.Core.Level.All"/>.</description>
  10137. </item>
  10138. </list>
  10139. </remarks>
  10140. <author>Nicko Cadell</author>
  10141. <author>Gert Driesen</author>
  10142. </member>
  10143. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String,System.String)">
  10144. <summary>
  10145. Constructor
  10146. </summary>
  10147. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  10148. <param name="levelName">The string name of this level.</param>
  10149. <param name="displayName">The display name for this level. This may be localized or otherwise different from the name</param>
  10150. <remarks>
  10151. <para>
  10152. Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
  10153. the specified level name and value.
  10154. </para>
  10155. </remarks>
  10156. </member>
  10157. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String)">
  10158. <summary>
  10159. Constructor
  10160. </summary>
  10161. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  10162. <param name="levelName">The string name of this level.</param>
  10163. <remarks>
  10164. <para>
  10165. Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
  10166. the specified level name and value.
  10167. </para>
  10168. </remarks>
  10169. </member>
  10170. <member name="M:log4net.Core.Level.ToString">
  10171. <summary>
  10172. Returns the <see cref="T:System.String"/> representation of the current
  10173. <see cref="T:log4net.Core.Level"/>.
  10174. </summary>
  10175. <returns>
  10176. A <see cref="T:System.String"/> representation of the current <see cref="T:log4net.Core.Level"/>.
  10177. </returns>
  10178. <remarks>
  10179. <para>
  10180. Returns the level <see cref="P:log4net.Core.Level.Name"/>.
  10181. </para>
  10182. </remarks>
  10183. </member>
  10184. <member name="M:log4net.Core.Level.Equals(System.Object)">
  10185. <summary>
  10186. Compares levels.
  10187. </summary>
  10188. <param name="o">The object to compare against.</param>
  10189. <returns><c>true</c> if the objects are equal.</returns>
  10190. <remarks>
  10191. <para>
  10192. Compares the levels of <see cref="T:log4net.Core.Level"/> instances, and
  10193. defers to base class if the target object is not a <see cref="T:log4net.Core.Level"/>
  10194. instance.
  10195. </para>
  10196. </remarks>
  10197. </member>
  10198. <member name="M:log4net.Core.Level.GetHashCode">
  10199. <summary>
  10200. Returns a hash code
  10201. </summary>
  10202. <returns>A hash code for the current <see cref="T:log4net.Core.Level"/>.</returns>
  10203. <remarks>
  10204. <para>
  10205. Returns a hash code suitable for use in hashing algorithms and data
  10206. structures like a hash table.
  10207. </para>
  10208. <para>
  10209. Returns the hash code of the level <see cref="P:log4net.Core.Level.Value"/>.
  10210. </para>
  10211. </remarks>
  10212. </member>
  10213. <member name="M:log4net.Core.Level.CompareTo(System.Object)">
  10214. <summary>
  10215. Compares this instance to a specified object and returns an
  10216. indication of their relative values.
  10217. </summary>
  10218. <param name="r">A <see cref="T:log4net.Core.Level"/> instance or <see langword="null"/> to compare with this instance.</param>
  10219. <returns>
  10220. A 32-bit signed integer that indicates the relative order of the
  10221. values compared. The return value has these meanings:
  10222. <list type="table">
  10223. <listheader>
  10224. <term>Value</term>
  10225. <description>Meaning</description>
  10226. </listheader>
  10227. <item>
  10228. <term>Less than zero</term>
  10229. <description>This instance is less than <paramref name="r"/>.</description>
  10230. </item>
  10231. <item>
  10232. <term>Zero</term>
  10233. <description>This instance is equal to <paramref name="r"/>.</description>
  10234. </item>
  10235. <item>
  10236. <term>Greater than zero</term>
  10237. <description>
  10238. <para>This instance is greater than <paramref name="r"/>.</para>
  10239. <para>-or-</para>
  10240. <para><paramref name="r"/> is <see langword="null"/>.</para>
  10241. </description>
  10242. </item>
  10243. </list>
  10244. </returns>
  10245. <remarks>
  10246. <para>
  10247. <paramref name="r"/> must be an instance of <see cref="T:log4net.Core.Level"/>
  10248. or <see langword="null"/>; otherwise, an exception is thrown.
  10249. </para>
  10250. </remarks>
  10251. <exception cref="T:System.ArgumentException"><paramref name="r"/> is not a <see cref="T:log4net.Core.Level"/>.</exception>
  10252. </member>
  10253. <member name="M:log4net.Core.Level.op_GreaterThan(log4net.Core.Level,log4net.Core.Level)">
  10254. <summary>
  10255. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  10256. is greater than another specified <see cref="T:log4net.Core.Level"/>.
  10257. </summary>
  10258. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  10259. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  10260. <returns>
  10261. <c>true</c> if <paramref name="l"/> is greater than
  10262. <paramref name="r"/>; otherwise, <c>false</c>.
  10263. </returns>
  10264. <remarks>
  10265. <para>
  10266. Compares two levels.
  10267. </para>
  10268. </remarks>
  10269. </member>
  10270. <member name="M:log4net.Core.Level.op_LessThan(log4net.Core.Level,log4net.Core.Level)">
  10271. <summary>
  10272. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  10273. is less than another specified <see cref="T:log4net.Core.Level"/>.
  10274. </summary>
  10275. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  10276. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  10277. <returns>
  10278. <c>true</c> if <paramref name="l"/> is less than
  10279. <paramref name="r"/>; otherwise, <c>false</c>.
  10280. </returns>
  10281. <remarks>
  10282. <para>
  10283. Compares two levels.
  10284. </para>
  10285. </remarks>
  10286. </member>
  10287. <member name="M:log4net.Core.Level.op_GreaterThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  10288. <summary>
  10289. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  10290. is greater than or equal to another specified <see cref="T:log4net.Core.Level"/>.
  10291. </summary>
  10292. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  10293. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  10294. <returns>
  10295. <c>true</c> if <paramref name="l"/> is greater than or equal to
  10296. <paramref name="r"/>; otherwise, <c>false</c>.
  10297. </returns>
  10298. <remarks>
  10299. <para>
  10300. Compares two levels.
  10301. </para>
  10302. </remarks>
  10303. </member>
  10304. <member name="M:log4net.Core.Level.op_LessThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  10305. <summary>
  10306. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  10307. is less than or equal to another specified <see cref="T:log4net.Core.Level"/>.
  10308. </summary>
  10309. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  10310. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  10311. <returns>
  10312. <c>true</c> if <paramref name="l"/> is less than or equal to
  10313. <paramref name="r"/>; otherwise, <c>false</c>.
  10314. </returns>
  10315. <remarks>
  10316. <para>
  10317. Compares two levels.
  10318. </para>
  10319. </remarks>
  10320. </member>
  10321. <member name="M:log4net.Core.Level.op_Equality(log4net.Core.Level,log4net.Core.Level)">
  10322. <summary>
  10323. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
  10324. objects have the same value.
  10325. </summary>
  10326. <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  10327. <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  10328. <returns>
  10329. <c>true</c> if the value of <paramref name="l"/> is the same as the
  10330. value of <paramref name="r"/>; otherwise, <c>false</c>.
  10331. </returns>
  10332. <remarks>
  10333. <para>
  10334. Compares two levels.
  10335. </para>
  10336. </remarks>
  10337. </member>
  10338. <member name="M:log4net.Core.Level.op_Inequality(log4net.Core.Level,log4net.Core.Level)">
  10339. <summary>
  10340. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
  10341. objects have different values.
  10342. </summary>
  10343. <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  10344. <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  10345. <returns>
  10346. <c>true</c> if the value of <paramref name="l"/> is different from
  10347. the value of <paramref name="r"/>; otherwise, <c>false</c>.
  10348. </returns>
  10349. <remarks>
  10350. <para>
  10351. Compares two levels.
  10352. </para>
  10353. </remarks>
  10354. </member>
  10355. <member name="M:log4net.Core.Level.Compare(log4net.Core.Level,log4net.Core.Level)">
  10356. <summary>
  10357. Compares two specified <see cref="T:log4net.Core.Level"/> instances.
  10358. </summary>
  10359. <param name="l">The first <see cref="T:log4net.Core.Level"/> to compare.</param>
  10360. <param name="r">The second <see cref="T:log4net.Core.Level"/> to compare.</param>
  10361. <returns>
  10362. A 32-bit signed integer that indicates the relative order of the
  10363. two values compared. The return value has these meanings:
  10364. <list type="table">
  10365. <listheader>
  10366. <term>Value</term>
  10367. <description>Meaning</description>
  10368. </listheader>
  10369. <item>
  10370. <term>Less than zero</term>
  10371. <description><paramref name="l"/> is less than <paramref name="r"/>.</description>
  10372. </item>
  10373. <item>
  10374. <term>Zero</term>
  10375. <description><paramref name="l"/> is equal to <paramref name="r"/>.</description>
  10376. </item>
  10377. <item>
  10378. <term>Greater than zero</term>
  10379. <description><paramref name="l"/> is greater than <paramref name="r"/>.</description>
  10380. </item>
  10381. </list>
  10382. </returns>
  10383. <remarks>
  10384. <para>
  10385. Compares two levels.
  10386. </para>
  10387. </remarks>
  10388. </member>
  10389. <member name="F:log4net.Core.Level.Off">
  10390. <summary>
  10391. The <see cref="F:log4net.Core.Level.Off"/> level designates a higher level than all the rest.
  10392. </summary>
  10393. </member>
  10394. <member name="F:log4net.Core.Level.Emergency">
  10395. <summary>
  10396. The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events.
  10397. System unusable, emergencies.
  10398. </summary>
  10399. </member>
  10400. <member name="F:log4net.Core.Level.Fatal">
  10401. <summary>
  10402. The <see cref="F:log4net.Core.Level.Fatal"/> level designates very severe error events
  10403. that will presumably lead the application to abort.
  10404. </summary>
  10405. </member>
  10406. <member name="F:log4net.Core.Level.Alert">
  10407. <summary>
  10408. The <see cref="F:log4net.Core.Level.Alert"/> level designates very severe error events.
  10409. Take immediate action, alerts.
  10410. </summary>
  10411. </me