File: log4net.Util.ThreadContextStack.Push.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 (52 lines) | stat: -rw-r--r-- 3,239 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
<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>ThreadContextStack.Push Method</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">ThreadContextStack.PushMethod</h1>
      </div>
    </div>
    <div id="nstext">
      <p> Pushes a new context message into this stack. </p>
      <div class="syntax">
        <span class="lang">[VisualBasic]</span>
        <br />PublicFunctionPush( _<br />ByVal <i>message</i>As<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemStringClassTopic.asp">String</a>_<br />)As<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIDisposableClassTopic.asp">IDisposable</a></div>
      <div class="syntax">
        <span class="lang">[C#]</span>
        <br />public<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIDisposableClassTopic.asp">IDisposable</a>Push(<br /><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemStringClassTopic.asp">string</a><i>message</i><br />);</div>
      <h4 class="dtH4">Parameters</h4>
      <dl>
        <dt>
          <i>message</i>
        </dt>
        <dd>The new context message.</dd>
      </dl>
      <h4 class="dtH4">Return Value</h4>
      <p> An <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIDisposableClassTopic.asp">IDisposable</a> that can be used to clean up the context stack. </p>
      <h4 class="dtH4">Remarks</h4>
            <p> Pushes a new context onto this stack. An <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIDisposableClassTopic.asp">IDisposable</a> is returned that can be used to clean up this stack. This can be easily combined with the <code>using</code> keyword to scope the context. </p>
            <h4 class="dtH4">Example</h4><p>Simple example of using the <code>Push</code> method with the <code>using</code> keyword. <pre class="code"><span class="lang">[C#]
</span>using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
{
    log.Warn("This should have an ThreadContext Stack message");
}
</pre>
            </p><h4 class="dtH4">See Also</h4><p><a href="log4net.Util.ThreadContextStack.html">ThreadContextStack Class</a> | <a href="log4net.Util.html">log4net.Util Namespace</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>