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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.hw-getremote" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>hw_GetRemote</refname>
  <refpurpose>Gets a remote document</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>hw_getremote</methodname>
   <methodparam><type>int</type><parameter>connection</parameter></methodparam>
   <methodparam><type>int</type><parameter>objectID</parameter></methodparam>
  </methodsynopsis>
  <para>
   Gets a remote document.
  </para>
  <para>
   Remote documents in Hyperwave notation are documents retrieved from an
   external source. Common remote documents are for example external web
   pages or queries in a database.
  </para>
  <para>
   In order to be able to access external sources through remote documents
   Hyperwave introduces the HGI (Hyperwave Gateway Interface) which is
   similar to the CGI. Currently, only ftp, http-servers and some databases
   can be accessed by the HGI.
  </para>
  <para>
   Calling <function>hw_getremote</function> returns the document from
   the external source.  If you want to use this function you should be
   very familiar with HGIs.  You should also consider to use PHP instead
   of Hyperwave to access external sources. Adding database support
   by a Hyperwave gateway should be more difficult than doing it in PHP.
  </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>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a remote document.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>hw_getremotechildren</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
-->