doc/html/boost/algorithm/replace_regex_copy.html

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