• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Function find_format_copy</title>
6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<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;">
10<link rel="prev" href="find_token.html" title="Function template find_token">
11<link rel="next" href="find_format.html" title="Function template find_format">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
16<td align="center"><a href="../../../../index.html">Home</a></td>
17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<a accesskey="p" href="find_token.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.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.algorithm.find_format_copy"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Function find_format_copy</span></h2>
30<p>boost::algorithm::find_format_copy — Generic replace algorithm. </p>
31</div>
32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33<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;
34
35</span>
36<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>
37         <span class="keyword">typename</span> FormatterT<span class="special">&gt;</span>
38  <span class="identifier">OutputIteratorT</span>
39  <span class="identifier">find_format_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>
40                   <span class="identifier">FinderT</span> Finder<span class="special">,</span> <span class="identifier">FormatterT</span> Formatter<span class="special">)</span><span class="special">;</span>
41<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>
42  <span class="identifier">SequenceT</span> <span class="identifier">find_format_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>
43                             <span class="identifier">FormatterT</span> Formatter<span class="special">)</span><span class="special">;</span></pre></div>
44<div class="refsect1">
45<a name="id-1.3.3.9.10.4.4"></a><h2>Description</h2>
46<p>Use the Finder to search for a substring. Use the Formatter to format this substring and replace it in the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</p>
47<p>
48
49</p>
50<div class="note"><table border="0" summary="Note">
51<tr>
52<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
53<th align="left">Note</th>
54</tr>
55<tr><td align="left" valign="top"><p>The second variant of this function provides the strong exception-safety guarantee </p></td></tr>
56</table></div>
57<p>
58</p>
59<div class="variablelist"><table border="0" class="variablelist compact">
60<colgroup>
61<col align="left" valign="top">
62<col>
63</colgroup>
64<tbody>
65<tr>
66<td><p><span class="term">Parameters:</span></p></td>
67<td><div class="variablelist"><table border="0" class="variablelist compact">
68<colgroup>
69<col align="left" valign="top">
70<col>
71</colgroup>
72<tbody>
73<tr>
74<td><p><span class="term"><code class="computeroutput">Finder</code></span></p></td>
75<td><p>A Finder object used to search for a match to be replaced </p></td>
76</tr>
77<tr>
78<td><p><span class="term"><code class="computeroutput">Formatter</code></span></p></td>
79<td><p>A Formatter object used to format a match </p></td>
80</tr>
81<tr>
82<td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
83<td><p>An input sequence </p></td>
84</tr>
85<tr>
86<td><p><span class="term"><code class="computeroutput">Output</code></span></p></td>
87<td><p>An output iterator to which the result will be copied </p></td>
88</tr>
89</tbody>
90</table></div></td>
91</tr>
92<tr>
93<td><p><span class="term">Returns:</span></p></td>
94<td><p>An output iterator pointing just after the last inserted character or a modified copy of the input</p></td>
95</tr>
96</tbody>
97</table></div>
98</div>
99</div>
100<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
101<td align="left"></td>
102<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
103                Software License, Version 1.0. (See accompanying file
104                <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>)
105            </p>
106</div></td>
107</tr></table>
108<hr>
109<div class="spirit-nav">
110<a accesskey="p" href="find_token.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.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
111</div>
112</body>
113</html>
114