doc/html/boost/algorithm/find_format_all_copy.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function find_format_all_copy</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.find_format_hpp" title="Header &lt;boost/algorithm/string/find_format.hpp&gt;">
   9 <link rel="prev" href="find_format.html" title="Function template find_format">
  10 <link rel="next" href="find_format_all.html" title="Function template find_format_all">
  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="find_format.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.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="find_format_all.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.algorithm.find_format_all_copy"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function find_format_all_copy</span></h2>
  29 <p>boost::algorithm::find_format_all_copy &#8212; Generic replace all algorithm. </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.find_format_hpp" title="Header &lt;boost/algorithm/string/find_format.hpp&gt;">boost/algorithm/string/find_format.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OutputIteratorT<span class="special">,</span> <span class="keyword">typename</span> RangeT<span class="special">,</span> <span class="keyword">typename</span> FinderT<span class="special">,</span>
  36          <span class="keyword">typename</span> FormatterT<span class="special">&gt;</span>
  37   <span class="identifier">OutputIteratorT</span>
  38   <span class="identifier">find_format_all_copy</span><span class="special">(</span><span class="identifier">OutputIteratorT</span> Output<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RangeT</span> <span class="special">&amp;</span> Input<span class="special">,</span>
  39                        <span class="identifier">FinderT</span> Finder<span class="special">,</span> <span class="identifier">FormatterT</span> Formatter<span class="special">)</span><span class="special">;</span>
  40 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SequenceT<span class="special">,</span> <span class="keyword">typename</span> FinderT<span class="special">,</span> <span class="keyword">typename</span> FormatterT<span class="special">&gt;</span>
  41   <span class="identifier">SequenceT</span> <span class="identifier">find_format_all_copy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SequenceT</span> <span class="special">&amp;</span> Input<span class="special">,</span> <span class="identifier">FinderT</span> Finder<span class="special">,</span>
  42                                  <span class="identifier">FormatterT</span> Formatter<span class="special">)</span><span class="special">;</span></pre></div>
  43 <div class="refsect1">
  44 <a name="id3271474"></a><h2>Description</h2>
  45 <p>Use the Finder to search for a substring. Use the Formatter to format this substring and replace it in the input. Repeat this for all matching substrings. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</p>
  46 <p>
  47
  48 </p>
  49 <div class="note"><table border="0" summary="Note">
  50 <tr>
  51 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  52 <th align="left">Note</th>
  53 </tr>
  54 <tr><td align="left" valign="top"><p>The second variant of this function provides the strong exception-safety guarantee </p></td></tr>
  55 </table></div>
  56 <p>
  57 </p>
  58 <div class="variablelist"><table border="0">
  59 <col align="left" valign="top">
  60 <tbody>
  61 <tr>
  62 <td><p><span class="term">Parameters:</span></p></td>
  63 <td><div class="variablelist"><table border="0">
  64 <col align="left" valign="top">
  65 <tbody>
  66 <tr>
  67 <td><p><span class="term"><code class="computeroutput">Finder</code></span></p></td>
  68 <td><p>A Finder object used to search for a match to be replaced </p></td>
  69 </tr>
  70 <tr>
  71 <td><p><span class="term"><code class="computeroutput">Formatter</code></span></p></td>
  72 <td><p>A Formatter object used to format a match </p></td>
  73 </tr>
  74 <tr>
  75 <td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
  76 <td><p>An input sequence </p></td>
  77 </tr>
  78 <tr>
  79 <td><p><span class="term"><code class="computeroutput">Output</code></span></p></td>
  80 <td><p>An output iterator to which the result will be copied </p></td>
  81 </tr>
  82 </tbody>
  83 </table></div></td>
  84 </tr>
  85 <tr>
  86 <td><p><span class="term">Returns:</span></p></td>
  87 <td><p>An output iterator pointing just after the last inserted character or a modified copy of the input</p></td>
  88 </tr>
  89 </tbody>
  90 </table></div>
  91 </div>
  92 </div>
  93 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  94 <td align="left"></td>
  95 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
  96                 Software License, Version 1.0. (See accompanying file
  97                 <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>)
  98             </p>
  99 </div></td>
 100 </tr></table>
 101 <hr>
 102 <div class="spirit-nav">
 103 <a accesskey="p" href="find_format.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.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="find_format_all.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 104 </div>
 105 </body>
 106 </html>