• 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 replace_first_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.replace_hpp" title="Header &lt;boost/algorithm/string/replace.hpp&gt;">
10<link rel="prev" href="replace_range.html" title="Function template replace_range">
11<link rel="next" href="replace_first.html" title="Function template replace_first">
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="replace_range.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.replace_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_first.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.algorithm.replace_first_copy"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Function replace_first_copy</span></h2>
30<p>boost::algorithm::replace_first_copy — Replace first 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.replace_hpp" title="Header &lt;boost/algorithm/string/replace.hpp&gt;">boost/algorithm/string/replace.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> Range1T<span class="special">,</span> <span class="keyword">typename</span> Range2T<span class="special">,</span>
37         <span class="keyword">typename</span> Range3T<span class="special">&gt;</span>
38  <span class="identifier">OutputIteratorT</span>
39  <span class="identifier">replace_first_copy</span><span class="special">(</span><span class="identifier">OutputIteratorT</span> Output<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Range1T</span> <span class="special">&amp;</span> Input<span class="special">,</span>
40                     <span class="keyword">const</span> <span class="identifier">Range2T</span> <span class="special">&amp;</span> Search<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Range3T</span> <span class="special">&amp;</span> Format<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> Range1T<span class="special">,</span> <span class="keyword">typename</span> Range2T<span class="special">&gt;</span>
42  <span class="identifier">SequenceT</span> <span class="identifier">replace_first_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>
43                               <span class="keyword">const</span> <span class="identifier">Range1T</span> <span class="special">&amp;</span> Search<span class="special">,</span>
44                               <span class="keyword">const</span> <span class="identifier">Range2T</span> <span class="special">&amp;</span> Format<span class="special">)</span><span class="special">;</span></pre></div>
45<div class="refsect1">
46<a name="id-1.3.3.9.19.6.4"></a><h2>Description</h2>
47<p>Replace the first match of the search substring in the input with the format string. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</p>
48<p>
49
50</p>
51<div class="note"><table border="0" summary="Note">
52<tr>
53<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
54<th align="left">Note</th>
55</tr>
56<tr><td align="left" valign="top"><p>The second variant of this function provides the strong exception-safety guarantee </p></td></tr>
57</table></div>
58<p>
59</p>
60<div class="variablelist"><table border="0" class="variablelist compact">
61<colgroup>
62<col align="left" valign="top">
63<col>
64</colgroup>
65<tbody>
66<tr>
67<td><p><span class="term">Parameters:</span></p></td>
68<td><div class="variablelist"><table border="0" class="variablelist compact">
69<colgroup>
70<col align="left" valign="top">
71<col>
72</colgroup>
73<tbody>
74<tr>
75<td><p><span class="term"><code class="computeroutput">Format</code></span></p></td>
76<td><p>A substitute string </p></td>
77</tr>
78<tr>
79<td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
80<td><p>An input string </p></td>
81</tr>
82<tr>
83<td><p><span class="term"><code class="computeroutput">Output</code></span></p></td>
84<td><p>An output iterator to which the result will be copied </p></td>
85</tr>
86<tr>
87<td><p><span class="term"><code class="computeroutput">Search</code></span></p></td>
88<td><p>A substring to be searched for </p></td>
89</tr>
90</tbody>
91</table></div></td>
92</tr>
93<tr>
94<td><p><span class="term">Returns:</span></p></td>
95<td><p>An output iterator pointing just after the last inserted character or a modified copy of the input</p></td>
96</tr>
97</tbody>
98</table></div>
99</div>
100</div>
101<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
102<td align="left"></td>
103<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
104                Software License, Version 1.0. (See accompanying file
105                <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>)
106            </p>
107</div></td>
108</tr></table>
109<hr>
110<div class="spirit-nav">
111<a accesskey="p" href="replace_range.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.replace_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_first.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
112</div>
113</body>
114</html>
115