Source of: /manual/en/function.hwapi-lock.php


<?php

include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';

$TOC = array();

$PARENTS = array();

include_once dirname(__FILE__) ."/toc/ref.hwapi.inc";

$setup = array (

  'home' => 

  array (

    0 => 'index.php',

    1 => 'PHP Manual',

  ),

  'head' => 

  array (

    0 => 'UTF-8',

    1 => 'en',

  ),

  'this' => 

  array (

    0 => 'function.hwapi-lock.php',

    1 => 'hw_api->lock',

  ),

  'up' => 

  array (

    0 => 'ref.hwapi.php',

    1 => 'Hyperwave API Functions',

  ),

  'prev' => 

  array (

    0 => 'function.hwapi-link.php',

    1 => 'hw_api->link',

  ),

  'next' => 

  array (

    0 => 'function.hwapi-move.php',

    1 => 'hw_api->move',

  ),

);

$setup["toc"] = $TOC;

$setup["parents"] = $PARENTS;

manual_setup($setup);



manual_header();

?>

<div id="function.hwapi-lock" class="refentry">

 <div class="refnamediv">

  <h1 class="refname">hw_api-&gt;lock</h1>

  <p class="verinfo">(PHP 4, PHP 5 &lt; 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api-&gt;lock</span> &mdash; <span class="dc-title">Locks an object</span></p>



 </div>

 

 <a name="function.hwapi-lock.description"></a><div class="refsect1 description">

  <h3 class="title">Description</h3>

  <div class="classsynopsis">

   <div class="ooclass"><b class="classname">hw_api</b></div>

   <div class="methodsynopsis dc-description">

    <span class="type">bool</span> <span class="methodname"><b>lock</b></span>

     ( <span class="methodparam"><span class="type">array</span> <tt class="parameter">$parameter</tt></span>

    )</div>



  </div>

  <p class="para">

   Locks an object for exclusive editing by the user calling this function.

   The object can be only unlocked by this user or the system user.

  </p>

 </div>





 <a name="function.hwapi-lock.parameters"></a><div class="refsect1 parameters">

  <h3 class="title">Parameters</h3>

  <p class="para">

   </p><dl>



    <dt class="varlistentry">



     <span class="term"><i><tt class="parameter">parameter</tt></i>

</span>



     </dt><dd class="listitem">



      <p class="para">

       The parameter array contains the required element &#039;objectIdentifier&#039;

       and the optional parameters &#039;mode&#039; and &#039;objectquery&#039;.

      </p>

      <p class="para">

       &#039;mode&#039; determines how an object is locked.

       <b><tt class="constant">HW_API_LOCK_NORMAL</tt></b> means, an object is locked

       until it is unlocked. <b><tt class="constant">HW_API_LOCK_RECURSIVE</tt></b> is

       only valid for collection and locks all objects within the collection

       and possible subcollections. <b><tt class="constant">HW_API_LOCK_SESSION</tt></b>

       means, an object is locked only as long as the session is valid.

      </p>

     </dd>



    

   </dl>

<p>

  </p>

 </div>





 <a name="function.hwapi-lock.returnvalues"></a><div class="refsect1 returnvalues">

  <h3 class="title">Return Values</h3>

  <p class="para">

   Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.

  </p>

 </div>





 <a name="function.hwapi-lock.seealso"></a><div class="refsect1 seealso">

  <h3 class="title">See Also</h3>

  <p class="para">

   </p><ul class="simplelist">

    <li class="member"><a href="function.hwapi-unlock.php" class="xref">hw_api->unlock</a></li>

   </ul><p>

  </p>

 </div>







</div><?php manual_footer(); ?>
Our source is open

Source of: /manual/en/function.hwapi-lock.php
