<?xml version='1.0' encoding='iso-8859-1' ?>
<!-- $Revision: 1.10 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-checkout">
 <refnamediv>
  <refname>hw_api->checkout</refname>
  <refpurpose>Checks out an object</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <classsynopsis>
   <ooclass><classname>hw_api</classname></ooclass>
   <methodsynopsis>
    <type>bool</type><methodname>checkout</methodname>
    <methodparam><type>array</type><parameter>parameter</parameter></methodparam>
   </methodsynopsis>
  </classsynopsis>
  <para>
   This function checks out an object or a whole hierarchy of objects.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parameter</parameter></term>
     <listitem>
      <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:
       <variablelist>
        <varlistentry>
         <term><constant>HW_API_CHECKIN_NORMAL</constant></term>
         <listitem>
          <simpara>
           Checks out an object. The object must be a document.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><constant>HW_API_CHECKIN_RECURSIVE</constant></term>
         <listitem>
          <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.
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="function.hwapi-checkin" /></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->