<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.streamwrapper.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'streamwrapper.stream-set-option.php',
    1 => 'streamWrapper::stream_set_option',
    2 => 'Change stream options',
  ),
  'up' => 
  array (
    0 => 'class.streamwrapper.php',
    1 => 'streamWrapper',
  ),
  'prev' => 
  array (
    0 => 'streamwrapper.stream-seek.php',
    1 => 'streamWrapper::stream_seek',
  ),
  'next' => 
  array (
    0 => 'streamwrapper.stream-stat.php',
    1 => 'streamWrapper::stream_stat',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/stream/streamwrapper/stream-set-option.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="streamwrapper.stream-set-option" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">streamWrapper::stream_set_option</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">streamWrapper::stream_set_option</span> &mdash; <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="methodname"><strong>streamWrapper::stream_set_option</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$option</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$arg1</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$arg2</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></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><code class="parameter">option</code></dt>
     <dd>
      <p class="para">
       One of:
       <ul class="simplelist">
        <li><strong><code><a href="stream.constants.php#constant.stream-option-blocking">STREAM_OPTION_BLOCKING</a></code></strong> (The method was called in response to <span class="function"><a href="function.stream-set-blocking.php" class="function">stream_set_blocking()</a></span>)</li>
        <li><strong><code><a href="stream.constants.php#constant.stream-option-read-timeout">STREAM_OPTION_READ_TIMEOUT</a></code></strong> (The method was called in response to <span class="function"><a href="function.stream-set-timeout.php" class="function">stream_set_timeout()</a></span>)</li>
        <li><strong><code><a href="stream.constants.php#constant.stream-option-read-buffer">STREAM_OPTION_READ_BUFFER</a></code></strong> (The method was called in response to  <span class="function"><a href="function.stream-set-read-buffer.php" class="function">stream_set_read_buffer()</a></span>)</li>
        <li><strong><code><a href="stream.constants.php#constant.stream-option-write-buffer">STREAM_OPTION_WRITE_BUFFER</a></code></strong> (The method was called in response to  <span class="function"><a href="function.stream-set-write-buffer.php" class="function">stream_set_write_buffer()</a></span>)</li>
       </ul>
      </p>
     </dd>
    
    
     <dt><code class="parameter">arg1</code></dt>
     <dd>
      <p class="para">
       If <code class="parameter">option</code> is
       <ul class="simplelist">
        <li><strong><code><a href="stream.constants.php#constant.stream-option-blocking">STREAM_OPTION_BLOCKING</a></code></strong>: requested blocking mode (1 meaning block 0 not blocking).</li>
        <li><strong><code><a href="stream.constants.php#constant.stream-option-read-timeout">STREAM_OPTION_READ_TIMEOUT</a></code></strong>: the timeout in seconds.</li>
        <li><strong><code><a href="stream.constants.php#constant.stream-option-read-buffer">STREAM_OPTION_READ_BUFFER</a></code></strong>: buffer mode (<strong><code><a href="stream.constants.php#constant.stream-buffer-none">STREAM_BUFFER_NONE</a></code></strong> or <strong><code><a href="stream.constants.php#constant.stream-buffer-full">STREAM_BUFFER_FULL</a></code></strong>).</li>
        <li><strong><code><a href="stream.constants.php#constant.stream-option-write-buffer">STREAM_OPTION_WRITE_BUFFER</a></code></strong>: buffer mode (<strong><code><a href="stream.constants.php#constant.stream-buffer-none">STREAM_BUFFER_NONE</a></code></strong> or <strong><code><a href="stream.constants.php#constant.stream-buffer-full">STREAM_BUFFER_FULL</a></code></strong>).</li>
       </ul>
      </p>
     </dd>
    
    
     <dt><code class="parameter">arg2</code></dt>
     <dd>
      <p class="para">
       If <code class="parameter">option</code> is
       <ul class="simplelist">
        <li><strong><code><a href="stream.constants.php#constant.stream-option-blocking">STREAM_OPTION_BLOCKING</a></code></strong>: This option is not set.</li>
        <li><strong><code><a href="stream.constants.php#constant.stream-option-read-timeout">STREAM_OPTION_READ_TIMEOUT</a></code></strong>: the timeout in microseconds.</li>
        <li><strong><code><a href="stream.constants.php#constant.stream-option-read-buffer">STREAM_OPTION_READ_BUFFER</a></code></strong>: the requested buffer size.</li>
        <li><strong><code><a href="stream.constants.php#constant.stream-option-write-buffer">STREAM_OPTION_WRITE_BUFFER</a></code></strong>: the requested buffer size.</li>
       </ul>
      </p>
     </dd>
    
   </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><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
   If <code class="parameter">option</code> is not implemented, <strong><code><a href="reserved.constants.php#constant.false">false</a></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><span class="function"><a href="function.stream-set-blocking.php" class="function" rel="rdfs-seeAlso">stream_set_blocking()</a> - Set blocking/non-blocking mode on a stream</span></li>
    <li><span class="function"><a href="function.stream-set-timeout.php" class="function" rel="rdfs-seeAlso">stream_set_timeout()</a> - Set timeout period on a stream</span></li>
    <li><span class="function"><a href="function.stream-set-write-buffer.php" class="function" rel="rdfs-seeAlso">stream_set_write_buffer()</a> - Sets write file buffering on the given stream</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>