File: log4net.Config.XmlConfigurator.Configure_overload_8.html

package info (click to toggle)
log4net 1.2.10%2Bdfsg-6
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 16,716 kB
  • ctags: 3,590
  • sloc: cs: 25,174; xml: 8,133; cpp: 91; makefile: 57; ansic: 7
file content (73 lines) | stat: -rw-r--r-- 4,716 bytes parent folder | download | duplicates (6) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
<html dir="LTR">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-1252" />
    <meta name="vs_targetSchema" content="http://schemas.microsoft.com/intellisense/ie5" />
    <title>XmlConfigurator.Configure Method (ILoggerRepository, FileInfo)</title>
    <xml>
    </xml>
    <link rel="stylesheet" type="text/css" href="MSDN.css" />
  </head>
  <body id="bodyID" class="dtBODY">
    <div id="nsbanner">
      <div id="bannerrow1">
        <table class="bannerparthead" cellspacing="0">
          <tr id="hdr">
            <td class="runninghead">log4net SDK Reference</td>
            <td class="product">
            </td>
          </tr>
        </table>
      </div>
      <div id="TitleRow">
        <h1 class="dtH1">XmlConfigurator.ConfigureMethod(ILoggerRepository, FileInfo)</h1>
      </div>
    </div>
    <div id="nstext">
      <p> Configures the <a href="log4net.Repository.ILoggerRepository.html">ILoggerRepository</a> using the specified configuration file. </p>
      <div class="syntax">
        <span class="lang">[VisualBasic]</span>
        <br />OverloadsPublicSharedSubConfigure( _<br />ByVal <i>repository</i>As<a href="log4net.Repository.ILoggerRepository.html">ILoggerRepository</a>,_<br />ByVal <i>configFile</i>As<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIOFileInfoClassTopic.asp">FileInfo</a>_<br />)</div>
      <div class="syntax">
        <span class="lang">[C#]</span>
        <br />publicstatic<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemVoidClassTopic.asp">void</a>Configure(<br /><a href="log4net.Repository.ILoggerRepository.html">ILoggerRepository</a><i>repository</i>,<br /><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIOFileInfoClassTopic.asp">FileInfo</a><i>configFile</i><br />);</div>
      <h4 class="dtH4">Parameters</h4>
      <dl>
        <dt>
          <i>repository</i>
        </dt>
        <dd>The repository to configure.</dd>
        <dt>
          <i>configFile</i>
        </dt>
        <dd>The XML file to load the configuration from.</dd>
      </dl>
      <h4 class="dtH4">Remarks</h4>
            <p> The configuration file must be valid XML. It must contain at least one element called <code>log4net</code> that holds the configuration data. </p>
            <p> The log4net configuration file can possible be specified in the application's configuration file (either <code>MyAppName.exe.config</code> for a normal application on <code>Web.config</code> for an ASP.NET application). </p>
            <p> The first element matching <code>&lt;configuration&gt;</code> will be read as the configuration. If this file is also a .NET .config file then you must specify a configuration section for the <code>log4net</code> element otherwise .NET will complain. Set the type for the section handler to <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemConfigurationIgnoreSectionHandlerClassTopic.asp">IgnoreSectionHandler</a>, for example: <pre class="code" escaped="true"><span class="lang">[XML]
</span>&lt;configSections&gt;
    &lt;section name="log4net" type="System.Configuration.IgnoreSectionHandler" /&gt;
&lt;/configSections&gt;
</pre>
            </p>
            <example> The following example configures log4net using a configuration file, of which the location is stored in the application's configuration file : </example>
            <pre class="code"><span class="lang">[C#]
</span>using log4net.Config;
using System.IO;
using System.Configuration;

...

XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
</pre>
            <p> In the <code>.config</code> file, the path to the log4net can be specified like this : </p>
            <pre class="code" escaped="true"><span class="lang">[XML]
</span>&lt;configuration&gt;
    &lt;appSettings&gt;
        &lt;add key="log4net-config-file" value="log.config" /&gt;
    &lt;/appSettings&gt;
&lt;/configuration&gt;
</pre>
            <h4 class="dtH4">See Also</h4><p><a href="log4net.Config.XmlConfigurator.html">XmlConfigurator Class</a> | <a href="log4net.Config.html">log4net.Config Namespace</a> | <a href="log4net.Config.XmlConfigurator.Configure_overloads.html">XmlConfigurator.Configure Overload List</a></p><hr /><div id="footer"><p><a href="http://logging.apache.org/log4net">Copyright 2001-2006 The Apache Software Foundation.</a></p><p>Generated from assembly log4net [1.2.10.0]</p></div></div>
  </body>
</html>