<!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>Pump data into an active hashing context from an open stream</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.hash-update-file.html">hash_update_file</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.hash-update.html">hash_update</a></div>
<div class="up"><a href="ref.hash.html">Hash Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.hash-update-stream" class="refentry">
<div class="refnamediv">
<h1 class="refname">hash_update_stream</h1>
<p class="verinfo">(PHP 5 >= 5.1.2, PHP 7, PECL hash >= 1.1)</p><p class="refpurpose"><span class="refname">hash_update_stream</span> — <span class="dc-title">Pump data into an active hashing context from an open stream</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.hash-update-stream-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>hash_update_stream</strong></span>
( <span class="methodparam"><span class="type"><a href="class.hashcontext.html" class="type HashContext">HashContext</a></span> <code class="parameter">$context</code></span>
, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$handle</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$length</code><span class="initializer"> = -1</span></span>
] )</div>
</div>
<div class="refsect1 parameters" id="refsect1-function.hash-update-stream-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">context</code></dt>
<dd>
<p class="para">
Hashing context returned by <span class="function"><a href="function.hash-init.html" class="function">hash_init()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">handle</code></dt>
<dd>
<p class="para">
Open file handle as returned by any stream creation function.
</p>
</dd>
<dt>
<code class="parameter">length</code></dt>
<dd>
<p class="para">
Maximum number of characters to copy from <code class="parameter">handle</code>
into the hashing context.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.hash-update-stream-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Actual number of bytes added to the hashing context from <code class="parameter">handle</code>.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.hash-update-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>7.2.0</td>
<td>
Accept <a href="class.hashcontext.html" class="classname">HashContext</a> instead of resource.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.hash-update-stream-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="zlib-encode.example.basic">
<p><strong>Example #1 <span class="function"><strong>hash_update_stream()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">tmpfile</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">'The quick brown fox jumped over the lazy dog.'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">rewind</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$ctx </span><span style="color: #007700">= </span><span style="color: #0000BB">hash_init</span><span style="color: #007700">(</span><span style="color: #DD0000">'md5'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">hash_update_stream</span><span style="color: #007700">(</span><span style="color: #0000BB">$ctx</span><span style="color: #007700">, </span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">hash_final</span><span style="color: #007700">(</span><span style="color: #0000BB">$ctx</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
5c6ffbdd40d9556b73a21e63c3e0e904
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.hash-update-stream-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.hash-init.html" class="function" rel="rdfs-seeAlso">hash_init()</a> - Initialize an incremental hashing context</span></li>
<li class="member"><span class="function"><a href="function.hash-update.html" class="function" rel="rdfs-seeAlso">hash_update()</a> - Pump data into an active hashing context</span></li>
<li class="member"><span class="function"><a href="function.hash-final.html" class="function" rel="rdfs-seeAlso">hash_final()</a> - Finalize an incremental hash and return resulting digest</span></li>
<li class="member"><span class="function"><a href="function.hash.html" class="function" rel="rdfs-seeAlso">hash()</a> - Generate a hash value (message digest)</span></li>
<li class="member"><span class="function"><a href="function.hash-file.html" class="function" rel="rdfs-seeAlso">hash_file()</a> - Generate a hash value using the contents of a given 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.hash-update-file.html">hash_update_file</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.hash-update.html">hash_update</a></div>
<div class="up"><a href="ref.hash.html">Hash Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
