doc/html/boost/algorithm/regex_formatter.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template regex_formatter</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../string_algo/reference.html#header.boost.algorithm.string.regex_find_format_hpp" title="Header &lt;boost/algorithm/string/regex_find_format.hpp&gt;">
   9 <link rel="prev" href="regex_finder.html" title="Function template regex_finder">
  10 <link rel="next" href="replace_range_copy.html" title="Function replace_range_copy">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="regex_finder.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.regex_find_format_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="replace_range_copy.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.algorithm.regex_formatter"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template regex_formatter</span></h2>
  29 <p>boost::algorithm::regex_formatter &#8212; Regex formatter. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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="../../string_algo/reference.html#header.boost.algorithm.string.regex_find_format_hpp" title="Header &lt;boost/algorithm/string/regex_find_format.hpp&gt;">boost/algorithm/string/regex_find_format.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> TraitsT<span class="special">,</span> <span class="keyword">typename</span> AllocT<span class="special">&gt;</span>
  36   <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">regex_formatter</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span><span class="special">,</span> <span class="identifier">AllocT</span> <span class="special">&gt;</span> <span class="special">&amp;</span> Format<span class="special">,</span>
  37                               <span class="identifier">match_flag_type</span> Flags <span class="special">=</span> <span class="identifier">format_default</span><span class="special">)</span><span class="special">;</span></pre></div>
  38 <div class="refsect1">
  39 <a name="id3293543"></a><h2>Description</h2>
  40 <p>Construct the <code class="computeroutput">regex_formatter</code>. Regex formatter uses the regex engine to format a match found by the <code class="computeroutput">regex_finder</code>. This formatted it designed to closely cooperate with <code class="computeroutput">regex_finder</code>.</p>
  41 <p>
  42
  43 </p>
  44 <div class="variablelist"><table border="0">
  45 <col align="left" valign="top">
  46 <tbody>
  47 <tr>
  48 <td><p><span class="term">Parameters:</span></p></td>
  49 <td><div class="variablelist"><table border="0">
  50 <col align="left" valign="top">
  51 <tbody>
  52 <tr>
  53 <td><p><span class="term"><code class="computeroutput">Flags</code></span></p></td>
  54 <td><p>Format flags </p></td>
  55 </tr>
  56 <tr>
  57 <td><p><span class="term"><code class="computeroutput">Format</code></span></p></td>
  58 <td><p>Regex format definition </p></td>
  59 </tr>
  60 </tbody>
  61 </table></div></td>
  62 </tr>
  63 <tr>
  64 <td><p><span class="term">Returns:</span></p></td>
  65 <td><p>An instance of the <code class="computeroutput">regex_formatter</code> functor </p></td>
  66 </tr>
  67 </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; 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
  74                 Software License, Version 1.0. (See accompanying file
  75                 <code class="filename">LICENSE_1_0.txt</code> 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="regex_finder.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.regex_find_format_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="replace_range_copy.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  82 </div>
  83 </body>
  84 </html>