<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Copies data from one stream to another</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-context-set-params.html">stream_context_set_params</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-encoding.html">stream_encoding</a></div>
<div class="up"><a href="ref.stream.html">Stream Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.stream-copy-to-stream" class="refentry">
<div class="refnamediv">
<h1 class="refname">stream_copy_to_stream</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">stream_copy_to_stream</span> — <span class="dc-title">Copies data from one stream to another</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.stream-copy-to-stream-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>stream_copy_to_stream</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$source</code></span>
, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$dest</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$maxlength</code><span class="initializer"> = -1</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$offset</code><span class="initializer"> = 0</span></span>
]] )</div>
<p class="para rdfs-comment">
Makes a copy of up to <em><code class="parameter">maxlength</code></em> bytes
of data from the current position (or from the
<em><code class="parameter">offset</code></em> position, if specified) in
<em><code class="parameter">source</code></em> to <em><code class="parameter">dest</code></em>. If
<em><code class="parameter">maxlength</code></em> is not specified, all remaining content in
<em><code class="parameter">source</code></em> will be copied.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.stream-copy-to-stream-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">source</code></em></span>
<dd>
<p class="para">
The source stream
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">dest</code></em></span>
<dd>
<p class="para">
The destination stream
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">maxlength</code></em></span>
<dd>
<p class="para">
Maximum bytes to copy
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">offset</code></em></span>
<dd>
<p class="para">
The offset where to start to copy data
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.stream-copy-to-stream-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the total count of bytes copied.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.stream-copy-to-stream-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.1.0</td>
<td>
Added the <em><code class="parameter">offset</code></em> parameter
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.stream-copy-to-stream-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4015">
<p><strong>Example #1 A <span class="function"><strong>stream_copy_to_stream()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$src </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://www.example.com'</span><span style="color: #007700">, </span><span style="color: #DD0000">'r'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$dest1 </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'first1k.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'w'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$dest2 </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'remainder.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'w'</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">stream_copy_to_stream</span><span style="color: #007700">(</span><span style="color: #0000BB">$src</span><span style="color: #007700">, </span><span style="color: #0000BB">$dest1</span><span style="color: #007700">, </span><span style="color: #0000BB">1024</span><span style="color: #007700">) . </span><span style="color: #DD0000">" bytes copied to first1k.txt\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">stream_copy_to_stream</span><span style="color: #007700">(</span><span style="color: #0000BB">$src</span><span style="color: #007700">, </span><span style="color: #0000BB">$dest2</span><span style="color: #007700">) . </span><span style="color: #DD0000">" bytes copied to remainder.txt\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.stream-copy-to-stream-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.copy.html" class="function" rel="rdfs-seeAlso">copy()</a> - Copies file</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-context-set-params.html">stream_context_set_params</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-encoding.html">stream_encoding</a></div>
<div class="up"><a href="ref.stream.html">Stream Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
