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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template char_decor</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.char_decorator_hpp" title="Header &lt;boost/log/expressions/formatters/char_decorator.hpp&gt;">
   9 <link rel="prev" href="char_decor_idp44517248.html" title="Function template char_decor">
  10 <link rel="next" href="csv_decor.html" title="Global csv_decor">
  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="char_decor_idp44517248.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.char_decorator_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="csv_decor.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.expressions.char_decor_idp44522416"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Function template char_decor</span></h2>
  22 <p>boost::log::expressions::char_decor</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.char_decorator_hpp" title="Header &lt;boost/log/expressions/formatters/char_decorator.hpp&gt;">boost/log/expressions/formatters/char_decorator.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FromRangeT<span class="special">,</span> <span class="keyword">typename</span> ToRangeT<span class="special">&gt;</span>
  29   <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">char_decor</span><span class="special">(</span><span class="identifier">FromRangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span> from<span class="special">,</span> <span class="identifier">ToRangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span> to<span class="special">)</span><span class="special">;</span></pre></div>
  30 <div class="refsect1">
  31 <a name="idp101989904"></a><h2>Description</h2>
  32 <p>The function returns a decorator generator object. The generator provides <code class="computeroutput">operator[]</code> that can be used to construct the actual decorator.</p>
  33 <p>
  34 </p>
  35 <div class="note"><table border="0" summary="Note">
  36 <tr>
  37 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
  38 <th align="left">Note</th>
  39 </tr>
  40 <tr><td align="left" valign="top"><p>The <span class="emphasis"><em>from</em></span> and <span class="emphasis"><em>to</em></span> sequences mush be of the same size. Every <code class="computeroutput">from[i]</code> substring occurrence in the output will be replaced with <code class="computeroutput">to[i]</code>. </p></td></tr>
  41 </table></div>
  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">from</code></span></p></td>
  59 <td><p>A sequence of strings that will be sought in the output. </p></td>
  60 </tr>
  61 <tr>
  62 <td><p><span class="term"><code class="computeroutput">to</code></span></p></td>
  63 <td><p>A sequence of strings that will be used as replacements.</p></td>
  64 </tr>
  65 </tbody>
  66 </table></div></td>
  67 </tr></tbody>
  68 </table></div>
  69 </div>
  70 </div>
  71 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  72 <td align="left"></td>
  73 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  74         Distributed under the Boost Software License, Version 1.0. (See accompanying
  75         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>).
  76       </p>
  77 </div></td>
  78 </tr></table>
  79 <hr>
  80 <div class="spirit-nav">
  81 <a accesskey="p" href="char_decor_idp44517248.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.char_decorator_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="csv_decor.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  82 </div>
  83 </body>
  84 </html>