<!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>Locks an object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="hwapi.link.html">hw_api::link</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.move.html">hw_api::move</a></div>
<div class="up"><a href="ref.hwapi.html">Hyperwave API Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="hwapi.lock" class="refentry">
<div class="refnamediv">
<h1 class="refname">hw_api::lock</h1>
<p class="verinfo">(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api::lock</span> — <span class="dc-title">Locks an object</span></p>
</div>
<div class="refsect1 description" id="refsect1-hwapi.lock-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>hw_api::lock</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$parameter</code></span>
)</div>
<p class="para rdfs-comment">
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>
<div class="refsect1 parameters" id="refsect1-hwapi.lock-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">parameter</code></em></span>
<dd>
<p class="para">
The parameter array contains the required element 'objectIdentifier'
and the optional parameters 'mode' and 'objectquery'.
</p>
<p class="para">
'mode' determines how an object is locked.
<strong><code>HW_API_LOCK_NORMAL</code></strong> means, an object is locked
until it is unlocked. <strong><code>HW_API_LOCK_RECURSIVE</code></strong> is
only valid for collection and locks all objects within the collection
and possible subcollections. <strong><code>HW_API_LOCK_SESSION</code></strong>
means, an object is locked only as long as the session is valid.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-hwapi.lock-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.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-hwapi.lock-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="hwapi.unlock.html" class="xref">hw_api::unlock</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="hwapi.link.html">hw_api::link</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.move.html">hw_api::move</a></div>
<div class="up"><a href="ref.hwapi.html">Hyperwave API Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
