<?xml version='1.0' encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-remove">
 <refnamediv>
  <refname>hw_api->remove</refname>
  <refpurpose>Delete an object</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <classsynopsis>
   <ooclass><classname>hw_api</classname></ooclass>
   <methodsynopsis>
    <type>bool</type><methodname>remove</methodname>
    <methodparam><type>array</type><parameter>parameter</parameter></methodparam>
   </methodsynopsis>
  </classsynopsis>
  <para>
   Removes an object from the specified parent. Collections
   will be removed recursively. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parameter</parameter></term>
     <listitem>
      <para>
       You can pass an optional object query to remove only those objects
       which match the query. An object will be deleted physically if it is
       the last instance. 
      </para>
      <para>
       The parameter array contains the required elements 'objectidentifier'
       and 'parentidentifier'. If you want to remove a user or group
       'parentidentifier' can be skipped.
      </para>
      <para>
       The optional parameter 'mode' determines how the deletion is
       performed. In normal mode the object will not be removed physically
       until all instances are removed. In physical mode all instances of the
       object will be deleted immediately. In removelinks mode all references
       to and from the objects will be deleted as well. In nonrecursive the
       deletion is not performed recursive. Removing a collection which is
       not empty will cause an error.
      </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-move" /></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:"~/.phpdoc/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
-->