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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template max_size_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.max_size_decorator_hpp" title="Header &lt;boost/log/expressions/formatters/max_size_decorator.hpp&gt;">
   9 <link rel="prev" href="max_size_idm45711347800960.html" title="Function template max_size_decor">
  10 <link rel="next" href="max_size_idm45711347789264.html" title="Function template max_size_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="max_size_idm45711347800960.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.max_size_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="max_size_idm45711347789264.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.expressions.max_size_idm45711347796688"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Function template max_size_decor</span></h2>
  22 <p>boost::log::expressions::max_size_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.max_size_decorator_hpp" title="Header &lt;boost/log/expressions/formatters/max_size_decorator.hpp&gt;">boost/log/expressions/formatters/max_size_decorator.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
  29   <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">max_size_decor</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> max_size<span class="special">,</span>
  30                              <span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span> overflow_marker<span class="special">)</span><span class="special">;</span></pre></div>
  31 <div class="refsect1">
  32 <a name="idm45554745230064"></a><h2>Description</h2>
  33 <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>
  34 <p>
  35
  36 </p>
  37 <div class="variablelist"><table border="0" class="variablelist compact">
  38 <colgroup>
  39 <col align="left" valign="top">
  40 <col>
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td><p><span class="term">Parameters:</span></p></td>
  45 <td><div class="variablelist"><table border="0" class="variablelist compact">
  46 <colgroup>
  47 <col align="left" valign="top">
  48 <col>
  49 </colgroup>
  50 <tbody>
  51 <tr>
  52 <td><p><span class="term"><code class="computeroutput">max_size</code></span></p></td>
  53 <td><p>The maximum number of characters (i.e. string element objects) that the decorated formatter can produce. </p></td>
  54 </tr>
  55 <tr>
  56 <td><p><span class="term"><code class="computeroutput">overflow_marker</code></span></p></td>
  57 <td><p>The marker string which is appended to the output if the <span class="emphasis"><em>max_size</em></span> limit is exceeded. Must be a non-null pointer to a zero-terminated string.</p></td>
  58 </tr>
  59 </tbody>
  60 </table></div></td>
  61 </tr>
  62 <tr>
  63 <td><p><span class="term">Requires:</span></p></td>
  64 <td><p>The <span class="emphasis"><em>overflow_marker</em></span> length must not exceed the <span class="emphasis"><em>max_size</em></span> limit. </p></td>
  65 </tr>
  66 </tbody>
  67 </table></div>
  68 </div>
  69 </div>
  70 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  71 <td align="left"></td>
  72 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  73         Distributed under the Boost Software License, Version 1.0. (See accompanying
  74         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>).
  75       </p>
  76 </div></td>
  77 </tr></table>
  78 <hr>
  79 <div class="spirit-nav">
  80 <a accesskey="p" href="max_size_idm45711347800960.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.max_size_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="max_size_idm45711347789264.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  81 </div>
  82 </body>
  83 </html>