<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.syncreaderwriter.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'syncreaderwriter.writelock.php',
    1 => 'SyncReaderWriter::writelock',
    2 => 'Waits for an exclusive write lock',
  ),
  'up' => 
  array (
    0 => 'class.syncreaderwriter.php',
    1 => 'SyncReaderWriter',
  ),
  'prev' => 
  array (
    0 => 'syncreaderwriter.readunlock.php',
    1 => 'SyncReaderWriter::readunlock',
  ),
  'next' => 
  array (
    0 => 'syncreaderwriter.writeunlock.php',
    1 => 'SyncReaderWriter::writeunlock',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/sync/syncreaderwriter/writelock.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="syncreaderwriter.writelock" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SyncReaderWriter::writelock</h1>
  <p class="verinfo">(PECL sync &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">SyncReaderWriter::writelock</span> &mdash; <span class="dc-title">Waits for an exclusive write lock</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-syncreaderwriter.writelock-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>SyncReaderWriter::writelock</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$wait</code><span class="initializer"> = -1</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Obtains an exclusive write lock on a <span class="classname"><a href="class.syncreaderwriter.php" class="classname">SyncReaderWriter</a></span> object.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-syncreaderwriter.writelock-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">wait</code></dt>
    <dd>
     <span class="simpara">
      The number of milliseconds to wait for a lock.
      A value of -1 is infinite.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-syncreaderwriter.writelock-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   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.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-syncreaderwriter.writelock-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 <span class="function"><strong>SyncReaderWriter::writelock()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$readwrite </span><span style="color: #007700">= new </span><span style="color: #0000BB">SyncReaderWriter</span><span style="color: #007700">(</span><span style="color: #DD0000">"FileCacheLock"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$readwrite</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">writelock</span><span style="color: #007700">();<br /></span><span style="color: #FF8000">/* ... */<br /></span><span style="color: #0000BB">$readwrite</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">writeunlock</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-syncreaderwriter.writelock-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="syncreaderwriter.writeunlock.php" class="methodname" rel="rdfs-seeAlso">SyncReaderWriter::writeunlock()</a> - Releases a write lock</span></li>
  </ul>
 </div>


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