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