Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/doc/html/replace_head_copy.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 17 years ago

added boost
File size: 4.9 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Function replace_head_copy</title>
5<link rel="stylesheet" href="boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7<link rel="start" href="index.html" title="The Boost C++ Libraries">
8<link rel="up" href="string_algo/reference.html#id2553153" title="Header &lt;boost/algorithm/string/replace.hpp&gt;">
9<link rel="prev" href="ireplace_all.html" title="Function template ireplace_all">
10<link rel="next" href="replace_head.html" title="Function template replace_head">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
15<td align="center"><a href="../../index.htm">Home</a></td>
16<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../people/people.htm">People</a></td>
18<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="ireplace_all.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id2553153"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="replace_head.html"><img src="images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="replace_head_copy"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function replace_head_copy</span></h2>
29<p>boost::algorithm::replace_head_copy &#8212; Replace head 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">
33<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> OutputIteratorT, <span class="bold"><strong>typename</strong></span> Range1T, <span class="bold"><strong>typename</strong></span> Range2T&gt; 
34  <span class="type">OutputIteratorT</span> 
35  replace_head_copy(OutputIteratorT Output, <span class="bold"><strong>const</strong></span> Range1T &amp; Input,
36                    <span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>int</strong></span> N, <span class="bold"><strong>const</strong></span> Range2T &amp; Format);
37<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> SequenceT, <span class="bold"><strong>typename</strong></span> RangeT&gt; 
38  <span class="type">SequenceT</span> replace_head_copy(<span class="bold"><strong>const</strong></span> SequenceT &amp; Input, <span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>int</strong></span> N,
39                              <span class="bold"><strong>const</strong></span> RangeT &amp; Format);</pre></div>
40<div class="refsect1" lang="en">
41<a name="id2771167"></a><h2>Description</h2>
42<p>Replace the head of the input with the given format string. The head is a prefix of a string of given size. If the sequence is shorter then required, whole string if considered to be the head. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</p>
43<p></p>
44<div class="variablelist">
45<p class="title"><b>Parameters</b></p>
46<dl>
47<dt><span class="term">Format</span></dt>
48<dd><p>A substitute string </p></dd>
49<dt><span class="term">Input</span></dt>
50<dd><p>An input string </p></dd>
51<dt><span class="term">N</span></dt>
52<dd><p>Length of the head </p></dd>
53<dt><span class="term">Output</span></dt>
54<dd><p>An output iterator to which the result will be copied </p></dd>
55</dl>
56</div>
57<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
58
59    An output iterator pointing just after the last inserted character or a modified copy of the input<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Notes</span></b>:
60
61    The second variant of this function provides the strong exception-safety guarantee </p>
62</div>
63</div>
64<table width="100%"><tr>
65<td align="left"></td>
66<td align="right"><small>Copyright © 2002-2004 Pavol Droba</small></td>
67</tr></table>
68<hr>
69<div class="spirit-nav">
70<a accesskey="p" href="ireplace_all.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id2553153"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="replace_head.html"><img src="images/next.png" alt="Next"></a>
71</div>
72</body>
73</html>
Note: See TracBrowser for help on using the repository browser.