php-doc-en/reference/hwapi/functions/hwapi-remove.xml

58 lines
2.3 KiB
XML
Raw Normal View History

<?xml version='1.0' encoding='iso-8859-1' ?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
<refentry id="function.hwapi-remove">
<refnamediv>
<refname>hw_api->remove</refname>
<refpurpose>Efface un objet</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>object</type><methodname>remove</methodname>
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
<para>
<function>hw_api->remove</function> efface un objet avec un parent
sp&eacute;cifique. Les collections seront effac&eacute;es r&eacute;cursivement. Vous pouvez
passez un objet optionnel de requ&ecirc;te pour filtrer les objets qui
seront filtr&eacute;s. Un objet sera effac&eacute; physiquement si c'est sa derni&egrave;re
instance. Le param&egrave;tre <parameter>parameter</parameter> est un tableau
qui contient les &eacute;l&eacute;ments obligatoires 'objectidentifier' et 'parentidentifier'.
Si vous souhaitez effacer un utilisateur ou un gropue, 'parentidentifier'
peut &ecirc;tre omis. L'&eacute;l&eacute;ment optionnel 'mode' d&eacute;termine comme l'effacement
est r&eacute;alis&eacute;. En mode normal, l'objet sera effac&eacute; phyisiquement lorsque
toutes ses instances seront supprim&eacute;es. En mode physique, toutes les
instances d'un objet seront supprim&eacute;es imm&eacute;diatement. En mode
removelinks toutes les r&eacute;f&eacute;rences vers et depuis l'objet seront aussi
effac&eacute;es. En mode nonrecursive, l'effacement n'est pas r&eacute;cusrsif.
Effacer une collection qui n'est pas vide causera une erreur.
</para>
<para>
Voir aussi
<function>hwapi_move</function>.
</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
-->