File: log4net.Util.OptionConverter.SubstituteVariables.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 (66 lines) | stat: -rw-r--r-- 4,097 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
<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>OptionConverter.SubstituteVariables 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">OptionConverter.SubstituteVariablesMethod</h1>
      </div>
    </div>
    <div id="nstext">
      <p> Performs variable substitution in string <i>val</i> from the values of keys found in <i>props</i>. </p>
      <div class="syntax">
        <span class="lang">[VisualBasic]</span>
        <br />PublicSharedFunctionSubstituteVariables( _<br />ByVal <i>value</i>As<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemStringClassTopic.asp">String</a>,_<br />ByVal <i>props</i>As<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemCollectionsIDictionaryClassTopic.asp">IDictionary</a>_<br />)As<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemStringClassTopic.asp">String</a></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/frlrfSystemStringClassTopic.asp">string</a>SubstituteVariables(<br /><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemStringClassTopic.asp">string</a><i>value</i>,<br /><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemCollectionsIDictionaryClassTopic.asp">IDictionary</a><i>props</i><br />);</div>
      <h4 class="dtH4">Parameters</h4>
      <dl>
        <dt>
          <i>value</i>
        </dt>
        <dd>The string on which variable substitution is performed.</dd>
        <dt>
          <i>props</i>
        </dt>
        <dd>The dictionary to use to lookup variables.</dd>
      </dl>
      <h4 class="dtH4">Return Value</h4>
      <p>The result of the substitutions.</p>
      <h4 class="dtH4">Remarks</h4>
            <p> The variable substitution delimiters are <b>${</b> and <b>}</b>. </p>
            <p> For example, if props contains <code>key=value</code>, then the call </p>
            <p>
            <pre class="code"><span class="lang">[C#]
</span>string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
</pre>
            </p>
            <p> will set the variable <code>s</code> to "Value of key is value.". </p>
            <p> If no value could be found for the specified key, then substitution defaults to an empty string. </p>
            <p> For example, if system properties contains no value for the key "nonExistentKey", then the call </p>
            <p>
            <pre class="code"><span class="lang">[C#]
</span>string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
</pre>
            </p>
            <p> will set <s>s</s> to "Value of nonExistentKey is []". </p>
            <p> An Exception is thrown if <i>value</i> contains a start delimiter "${" which is not balanced by a stop delimiter "}". </p>
            <h4 class="dtH4">See Also</h4><p><a href="log4net.Util.OptionConverter.html">OptionConverter 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>