doc/html/boost/algorithm/ireplace_first_copy.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function ireplace_first_copy</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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.replace_hpp" title="Header &lt;boost/algorithm/string/replace.hpp&gt;">
   9 <link rel="prev" href="replace_first.html" title="Function template replace_first">
  10 <link rel="next" href="ireplace_first.html" title="Function template ireplace_first">
  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="replace_first.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="ireplace_first.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.algorithm.ireplace_first_copy"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function ireplace_first_copy</span></h2>
  29 <p>boost::algorithm::ireplace_first_copy &#8212; Replace first algorithm ( case insensitive ) </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.replace_hpp" title="Header &lt;boost/algorithm/string/replace.hpp&gt;">boost/algorithm/string/replace.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> Range1T<span class="special">,</span> <span class="keyword">typename</span> Range2T<span class="special">,</span>
  36          <span class="keyword">typename</span> Range3T<span class="special">&gt;</span>
  37   <span class="identifier">OutputIteratorT</span>
  38   <span class="identifier">ireplace_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>
  39                       <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>
  40                       <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&amp;</span> Loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><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> Range2T<span class="special">,</span> <span class="keyword">typename</span> Range1T<span class="special">&gt;</span>
  42   <span class="identifier">SequenceT</span> <span class="identifier">ireplace_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">Range2T</span> <span class="special">&amp;</span> Search<span class="special">,</span>
  44                                 <span class="keyword">const</span> <span class="identifier">Range1T</span> <span class="special">&amp;</span> Format<span class="special">,</span>
  45                                 <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&amp;</span> Loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div>
  46 <div class="refsect1">
  47 <a name="idp438013408"></a><h2>Description</h2>
  48 <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. Searching is case insensitive.</p>
  49 <p>
  50
  51 </p>
  52 <div class="note"><table border="0" summary="Note">
  53 <tr>
  54 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  55 <th align="left">Note</th>
  56 </tr>
  57 <tr><td align="left" valign="top"><p>The second variant of this function provides the strong exception-safety guarantee </p></td></tr>
  58 </table></div>
  59 <p>
  60 </p>
  61 <div class="variablelist"><table border="0" class="variablelist compact">
  62 <colgroup>
  63 <col align="left" valign="top">
  64 <col>
  65 </colgroup>
  66 <tbody>
  67 <tr>
  68 <td><p><span class="term">Parameters:</span></p></td>
  69 <td><div class="variablelist"><table border="0" class="variablelist compact">
  70 <colgroup>
  71 <col align="left" valign="top">
  72 <col>
  73 </colgroup>
  74 <tbody>
  75 <tr>
  76 <td><p><span class="term"><code class="computeroutput">Format</code></span></p></td>
  77 <td><p>A substitute string </p></td>
  78 </tr>
  79 <tr>
  80 <td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
  81 <td><p>An input string </p></td>
  82 </tr>
  83 <tr>
  84 <td><p><span class="term"><code class="computeroutput">Loc</code></span></p></td>
  85 <td><p>A locale used for case insensitive comparison </p></td>
  86 </tr>
  87 <tr>
  88 <td><p><span class="term"><code class="computeroutput">Output</code></span></p></td>
  89 <td><p>An output iterator to which the result will be copied </p></td>
  90 </tr>
  91 <tr>
  92 <td><p><span class="term"><code class="computeroutput">Search</code></span></p></td>
  93 <td><p>A substring to be searched for </p></td>
  94 </tr>
  95 </tbody>
  96 </table></div></td>
  97 </tr>
  98 <tr>
  99 <td><p><span class="term">Returns:</span></p></td>
 100 <td><p>An output iterator pointing just after the last inserted character or a modified copy of the input</p></td>
 101 </tr>
 102 </tbody>
 103 </table></div>
 104 </div>
 105 </div>
 106 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 107 <td align="left"></td>
 108 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
 109                 Software License, Version 1.0. (See accompanying file
 110                 <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>)
 111             </p>
 112 </div></td>
 113 </tr></table>
 114 <hr>
 115 <div class="spirit-nav">
 116 <a accesskey="p" href="replace_first.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="ireplace_first.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 117 </div>
 118 </body>
 119 </html>