libs/log/doc/html/boost/log/expressions/format_n_idm45185966082672.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function format_named_scope</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
   8 <link rel="up" href="../../../expressions.html#header.boost.log.expressions.formatters.named_scope_hpp" title="Header &lt;boost/log/expressions/formatters/named_scope.hpp&gt;">
   9 <link rel="prev" href="format_n_idm45185966091072.html" title="Function template format_named_scope">
  10 <link rel="next" href="stream_type.html" title="Type definition stream_type">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td></tr></table>
  14 <hr>
  15 <div class="spirit-nav">
  16 <a accesskey="p" href="format_n_idm45185966091072.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.named_scope_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stream_type.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.expressions.format_n_idm45185966082672"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Function format_named_scope</span></h2>
  22 <p>boost::log::expressions::format_named_scope</p>
  23 </div>
  24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  25 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../expressions.html#header.boost.log.expressions.formatters.named_scope_hpp" title="Header &lt;boost/log/expressions/formatters/named_scope.hpp&gt;">boost/log/expressions/formatters/named_scope.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span><span class="special">...</span> ArgsT<span class="special">&gt;</span>
  29   <span class="identifier">unspecified</span> <span class="identifier">format_named_scope</span><span class="special">(</span><span class="identifier">attribute_name</span> <span class="keyword">const</span> <span class="special">&amp;</span> name<span class="special">,</span>
  30                                  <span class="identifier">ArgsT</span><span class="special">...</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span>
  31 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> DescriptorT<span class="special">,</span> <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="special">&gt;</span> <span class="keyword">class</span> ActorT<span class="special">,</span>
  32          <span class="keyword">typename</span><span class="special">...</span> ArgsT<span class="special">&gt;</span>
  33   <span class="identifier">unspecified</span> <span class="identifier">format_named_scope</span><span class="special">(</span><a class="link" href="attribute_keyword.html" title="Struct template attribute_keyword">attribute_keyword</a><span class="special">&lt;</span> <span class="identifier">DescriptorT</span><span class="special">,</span> <span class="identifier">ActorT</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> keyword<span class="special">,</span>
  34                                  <span class="identifier">ArgsT</span><span class="special">...</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> FallbackPolicyT<span class="special">,</span> <span class="keyword">typename</span> TagT<span class="special">,</span>
  36          <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="special">&gt;</span> <span class="keyword">class</span> ActorT<span class="special">,</span> <span class="keyword">typename</span><span class="special">...</span> ArgsT<span class="special">&gt;</span>
  37   <span class="identifier">unspecified</span> <span class="identifier">format_named_scope</span><span class="special">(</span><a class="link" href="attribute_actor.html" title="Class template attribute_actor">attribute_actor</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">FallbackPolicyT</span><span class="special">,</span> <span class="identifier">TagT</span><span class="special">,</span> <span class="identifier">ActorT</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> placeholder<span class="special">,</span>
  38                                  <span class="identifier">ArgsT</span><span class="special">...</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span></pre></div>
  39 <div class="refsect1">
  40 <a name="idm46436912890416"></a><h2>Description</h2>
  41 <p>Formatter generator. Construct the named scope formatter with the specified formatting parameters.</p>
  42 <p>
  43 </p>
  44 <div class="variablelist"><table border="0" class="variablelist compact">
  45 <colgroup>
  46 <col align="left" valign="top">
  47 <col>
  48 </colgroup>
  49 <tbody><tr>
  50 <td><p><span class="term">Parameters:</span></p></td>
  51 <td><div class="variablelist"><table border="0" class="variablelist compact">
  52 <colgroup>
  53 <col align="left" valign="top">
  54 <col>
  55 </colgroup>
  56 <tbody>
  57 <tr>
  58 <td><p><span class="term"><code class="computeroutput">args</code></span></p></td>
  59 <td>
  60 <p>An set of named parameters. Supported parameters: </p>
  61 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  62 <li class="listitem"><p><code class="computeroutput">format</code> - A format string for named scopes. The string can contain "%n", "%f" and "%l" placeholders for the scope name, file and line number, respectively. This parameter is mandatory. </p></li>
  63 <li class="listitem"><p><code class="computeroutput">delimiter</code> - A string that is used to delimit the formatted scope names. Default: "-&gt;" or "&lt;-", depending on the iteration direction. </p></li>
  64 <li class="listitem"><p><code class="computeroutput">incomplete_marker</code> - A string that is used to indicate that the list was printed incomplete because of depth limitation. Default: "...". </p></li>
  65 <li class="listitem"><p><code class="computeroutput">empty_marker</code> - A string that is output in case if the scope list is empty. Default: "", i.e. nothing is output. </p></li>
  66 <li class="listitem"><p><code class="computeroutput">iteration</code> - Iteration direction, see <code class="computeroutput">scope_iteration_direction</code> enumeration. Default: forward. </p></li>
  67 <li class="listitem"><p><code class="computeroutput">depth</code> - Iteration depth. Default: unlimited. </p></li>
  68 </ul></div>
  69 <p>
  70 </p>
  71 </td>
  72 </tr>
  73 <tr>
  74 <td><p><span class="term"><code class="computeroutput">name</code></span></p></td>
  75 <td><p>Attribute name </p></td>
  76 </tr>
  77 </tbody>
  78 </table></div></td>
  79 </tr></tbody>
  80 </table></div>
  81 </div>
  82 </div>
  83 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  84 <td align="left"></td>
  85 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  86         Distributed under the Boost Software License, Version 1.0. (See accompanying
  87         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>).
  88       </p>
  89 </div></td>
  90 </tr></table>
  91 <hr>
  92 <div class="spirit-nav">
  93 <a accesskey="p" href="format_n_idm45185966091072.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.named_scope_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stream_type.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  94 </div>
  95 </body>
  96 </html>