php-doc-en/reference/hw/functions/hw-mv.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.hw-mv" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>hw_mv</refname>
  <refpurpose>Moves objects</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <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 specified objects from a collection to another.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       The connection identifier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>object_id_array</parameter></term>
     <listitem>
      <para>
       An array of object ids.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>source_id</parameter></term>
     <listitem>
      <para>
       The source collection id.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>destination_id</parameter></term>
     <listitem>
      <para>
       The target collection id. If set to 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>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the number of moved objects.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>hw_cp</function></member>
    <member><function>hw_deleteobject</function></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
-->