<!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>Checks out an object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="hwapi.checkin.html">hw_api::checkin</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.children.html">hw_api::children</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.checkout" class="refentry">
<div class="refnamediv">
<h1 class="refname">hw_api::checkout</h1>
<p class="verinfo">(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api::checkout</span> — <span class="dc-title">Checks out an object</span></p>
</div>
<div class="refsect1 description" id="refsect1-hwapi.checkout-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>hw_api::checkout</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$parameter</code></span>
)</div>
<p class="para rdfs-comment">
This function checks out an object or a whole hierarchy of objects.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-hwapi.checkout-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 parameters array contains the required element
'objectIdentifier' and the optional element 'version', 'mode'
and 'objectQuery'. 'mode' can be one of the following values:
<dl>
<dt>
<span class="term"><strong><code>HW_API_CHECKIN_NORMAL</code></strong></span>
<dd>
<span class="simpara">
Checks out an object. The object must be a document.
</span>
</dd>
</dt>
<dt>
<span class="term"><strong><code>HW_API_CHECKIN_RECURSIVE</code></strong></span>
<dd>
<span class="simpara">
If the object to check out is a collection, all children will be
checked out recursively if they are documents. Trying to check out
a collection would result in an error.
</span>
</dd>
</dt>
</dl>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-hwapi.checkout-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.checkout-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="hwapi.checkin.html" class="xref">hw_api::checkin</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.checkin.html">hw_api::checkin</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.children.html">hw_api::children</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>
