2002-04-15 00:12:54 +00:00
|
|
|
<?xml version='1.0' encoding='iso-8859-1' ?>
|
2003-06-02 17:00:51 +00:00
|
|
|
<!-- $Revision: 1.4 $ -->
|
2002-04-15 00:12:54 +00:00
|
|
|
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
|
|
|
|
<refentry id="function.hwapi-remove">
|
|
|
|
|
<refnamediv>
|
|
|
|
|
<refname>hw_api->remove</refname>
|
2003-06-02 17:00:51 +00:00
|
|
|
<refpurpose>Delete an object</refpurpose>
|
2002-04-15 00:12:54 +00:00
|
|
|
</refnamediv>
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Description</title>
|
|
|
|
|
<methodsynopsis>
|
|
|
|
|
<type>object</type><methodname>remove</methodname>
|
|
|
|
|
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
|
|
|
|
</methodsynopsis>
|
|
|
|
|
<para>
|
2003-06-02 17:00:51 +00:00
|
|
|
Removes an object from the specified parent. Collections
|
|
|
|
|
will be removed recursively. 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. The parameter array
|
|
|
|
|
contains the required elements 'objectidentifier' and 'parentidentifier'.
|
|
|
|
|
If you want to remove a user or group 'parentidentifier' can be skiped.
|
|
|
|
|
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 imediately. 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.
|
2002-04-15 00:12:54 +00:00
|
|
|
</para>
|
|
|
|
|
<para>
|
2003-06-02 17:00:51 +00:00
|
|
|
See also <function>hwapi_move</function>.
|
2002-04-15 00:12:54 +00:00
|
|
|
</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
|
|
|
|
|
-->
|
