<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.hw-insertdocument" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>hw_InsertDocument</refname>
  <refpurpose>Upload any document</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>hw_insertdocument</methodname>
   <methodparam><type>int</type><parameter>connection</parameter></methodparam>
   <methodparam><type>int</type><parameter>parent_id</parameter></methodparam>
   <methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
  </methodsynopsis>
  <para>
   Uploads a document into the given collection.
  </para>
  <para>
   The document has to be created before with
   <function>hw_new_document</function>. Make sure that the object record of
   the new document contains at least the attributes: Type, DocumentType,
   Title and Name. Possibly you also want to set the MimeType.
  </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>parent_id</parameter></term>
     <listitem>
      <para>
       The collection identifier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>hw_document</parameter></term>
     <listitem>
      <para>
       The document identifier.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The functions returns the object id of the new document or &false;.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>hw_pipedocument</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
-->