php-doc-en/reference/hw/functions/hw-mv.xml
2003-02-18 15:38:50 +00:00

56 lines
1.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry id="function.hw-mv">
<refnamediv>
<refname>hw_mv</refname>
<refpurpose>Moves objects</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_mv</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>array</type><parameter>object_id_array</parameter></methodparam>
<methodparam><type>int</type><parameter>source_id</parameter></methodparam>
<methodparam><type>int</type><parameter>destination_id</parameter></methodparam>
</methodsynopsis>
<para>
Moves the objects with object ids as specified in the second
parameter from the collection with id <parameter>source_id</parameter>
to the collection with the id <parameter>destination_id</parameter>.
If the destination id is 0 the objects will
be unlinked from the source collection. If this is the last instance
of that object it will be deleted. If you want to delete all instances
at once, use <function>hw_deleteobject</function>.
</para>
<para>
The value returned is the number of moved objects.
</para>
<para>
See also <function>hw_cp</function>,
and <function>hw_deleteobject</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
-->