<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.hw-pipedocument" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>hw_PipeDocument</refname>
  <refpurpose>Retrieve any document</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>hw_pipedocument</methodname>
   <methodparam><type>int</type><parameter>connection</parameter></methodparam>
   <methodparam><type>int</type><parameter>objectID</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>url_prefixes</parameter></methodparam>
  </methodsynopsis>
  <para>
   Gets the Hyperwave document with the given object ID. If the document has
   anchors which can be inserted, they will have been inserted already.
  </para>
  <para>
   The document will be transferred via a special data connection which
   does not block the control connection.
  </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>objectID</parameter></term>
     <listitem>
      <para>
       The object identifier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>url_prefixes</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the Hyperwave document.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>hw_gettext</function></member>
    <member><function>hw_free_document</function></member>
    <member><function>hw_document_size</function></member>
    <member><function>hw_document_bodytag</function></member>
    <member><function>hw_output_document</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
-->