<!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>Set read file buffering on the given stream</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-set-chunk-size.html">stream_set_chunk_size</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-set-timeout.html">stream_set_timeout</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-set-read-buffer" class="refentry">
<div class="refnamediv">
<h1 class="refname">stream_set_read_buffer</h1>
<p class="verinfo">(PHP 5 >= 5.3.3)</p><p class="refpurpose"><span class="refname">stream_set_read_buffer</span> — <span class="dc-title">Set read file buffering on the given stream</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.stream-set-read-buffer-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>stream_set_read_buffer</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$stream</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$buffer</code></span>
)</div>
<p class="para rdfs-comment">
Sets the read buffer. It's the equivalent of <span class="function"><a href="function.stream-set-write-buffer.html" class="function">stream_set_write_buffer()</a></span>,
but for read operations.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.stream-set-read-buffer-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">stream</code></em></span>
<dd>
<p class="para">
The file pointer.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">buffer</code></em></span>
<dd>
<p class="para">
The number of bytes to buffer. If <em><code class="parameter">buffer</code></em>
is 0 then read operations are unbuffered. This ensures that all reads
with <span class="function"><a href="function.fread.html" class="function">fread()</a></span> are completed before other processes are
allowed to read from that input stream.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.stream-set-read-buffer-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns 0 on success, or <acronym title="End Of File">EOF</acronym> if the request
cannot be honored.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.stream-set-read-buffer-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.stream-set-write-buffer.html" class="function" rel="rdfs-seeAlso">stream_set_write_buffer()</a> - Sets write file buffering on the given stream</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-set-chunk-size.html">stream_set_chunk_size</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-set-timeout.html">stream_set_timeout</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>
