<!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>Change stream options</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="streamwrapper.stream-seek.html">streamWrapper::stream_seek</a></div>
<div class="next" style="text-align: right; float: right;"><a href="streamwrapper.stream-stat.html">streamWrapper::stream_stat</a></div>
<div class="up"><a href="class.streamwrapper.html">streamWrapper</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="streamwrapper.stream-set-option" class="refentry">
<div class="refnamediv">
<h1 class="refname">streamWrapper::stream_set_option</h1>
<p class="verinfo">(PHP 5 >= 5.3.0)</p><p class="refpurpose"><span class="refname">streamWrapper::stream_set_option</span> — <span class="dc-title">Change stream options</span></p>
</div>
<div class="refsect1 description" id="refsect1-streamwrapper.stream-set-option-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>streamWrapper::stream_set_option</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$option</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$arg1</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$arg2</code></span>
)</div>
<p class="para rdfs-comment">
This method is called to set options on the stream.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-streamwrapper.stream-set-option-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">option</code></em></span>
<dd>
<p class="para">
One of:
<ul class="simplelist">
<li class="member"><strong><code>STREAM_OPTION_BLOCKING</code></strong> (The method was called in response to <span class="function"><a href="function.stream-set-blocking.html" class="function">stream_set_blocking()</a></span>)</li>
<li class="member"><strong><code>STREAM_OPTION_READ_TIMEOUT</code></strong> (The method was called in response to <span class="function"><a href="function.stream-set-timeout.html" class="function">stream_set_timeout()</a></span>)</li>
<li class="member"><strong><code>STREAM_OPTION_WRITE_BUFFER</code></strong> (The method was called in response to <span class="function"><a href="function.stream-set-write-buffer.html" class="function">stream_set_write_buffer()</a></span>)</li>
</ul>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">arg1</code></em></span>
<dd>
<p class="para">
If <em><code class="parameter">option</code></em> is
<ul class="simplelist">
<li class="member"><strong><code>STREAM_OPTION_BLOCKING</code></strong>: requested blocking mode (1 meaning block 0 not blocking).</li>
<li class="member"><strong><code>STREAM_OPTION_READ_TIMEOUT</code></strong>: the timeout in seconds.</li>
<li class="member"><strong><code>STREAM_OPTION_WRITE_BUFFER</code></strong>: buffer mode (<strong><code>STREAM_BUFFER_NONE</code></strong> or <strong><code>STREAM_BUFFER_FULL</code></strong>).</li>
</ul>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">arg2</code></em></span>
<dd>
<p class="para">
If <em><code class="parameter">option</code></em> is
<ul class="simplelist">
<li class="member"><strong><code>STREAM_OPTION_BLOCKING</code></strong>: This option is not set.</li>
<li class="member"><strong><code>STREAM_OPTION_READ_TIMEOUT</code></strong>: the timeout in microseconds.</li>
<li class="member"><strong><code>STREAM_OPTION_WRITE_BUFFER</code></strong>: the requested buffer size.</li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-streamwrapper.stream-set-option-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
If <em><code class="parameter">option</code></em> is not implemented, <strong><code>FALSE</code></strong> should be
returned.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-streamwrapper.stream-set-option-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.stream-set-blocking.html" class="function" rel="rdfs-seeAlso">stream_set_blocking()</a> - Set blocking/non-blocking mode on a stream</span></li>
<li class="member"> <span class="function"><a href="function.stream-set-timeout.html" class="function" rel="rdfs-seeAlso">stream_set_timeout()</a> - Set timeout period on a stream</span></li>
<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>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="streamwrapper.stream-seek.html">streamWrapper::stream_seek</a></div>
<div class="next" style="text-align: right; float: right;"><a href="streamwrapper.stream-stat.html">streamWrapper::stream_stat</a></div>
<div class="up"><a href="class.streamwrapper.html">streamWrapper</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
