[PHP-DEV] CVS update: php3/doc/functions From: steinm (php-dev <email protected>)
Date: 03/30/99

Date: Tuesday March 30, 1999 @ 1:23
Author: steinm

Update of /repository/php3/doc/functions
In directory asf:/u/temp/cvs-serv14685/doc/functions

Modified Files:
        hw.sgml
Log Message:
- more documentation, may now work on win32 (can't test)

Index: php3/doc/functions/hw.sgml
diff -c php3/doc/functions/hw.sgml:1.13 php3/doc/functions/hw.sgml:1.14
*** php3/doc/functions/hw.sgml:1.13 Mon Mar 8 07:57:31 1999
--- php3/doc/functions/hw.sgml Tue Mar 30 01:23:41 1999
***************
*** 725,730 ****
--- 725,798 ----
     </refsect1>
    </refentry>
  
+ <refentry id="function.hw-getremote">
+ <refnamediv>
+ <refname>hw_GetRemote</refname>
+ <refpurpose>Gets a remote document</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>int <function>hw_getremote</function></funcdef>
+ <paramdef>int <parameter>connection</parameter></paramdef>
+ <paramdef>int <parameter>objectID</parameter></paramdef>
+ </funcsynopsis>
+ <para>
+ Returns a remote document. 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.
+ In order to be able to access external sources throught 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.
+ 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 php3 instead of Hyperwave to access
+ external
+ sources. Adding database support by a Hyperwave gateway should be more
+ difficult than doing it in php3.
+ <para>
+ See also <function>hw_GetRemoteChildren</function>.
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.hw-getremotechildren">
+ <refnamediv>
+ <refname>hw_GetRemoteChildren</refname>
+ <refpurpose>Gets children of remote document</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>int <function>hw_getremotechildren</function></funcdef>
+ <paramdef>int <parameter>connection</parameter></paramdef>
+ <paramdef>string <parameter>object record</parameter></paramdef>
+ </funcsynopsis>
+ <para>
+ Returns the children of a remote document. Children of a remote
+ document are remote documents itself.
+ This makes sense
+ if a database query has to be narrowed and is explained in
+ Hyperwave Programmers' Guide. If the number of children is 1 the
+ function will return the document itself formated by the Hyperwave
+ Gateway Interface (HGI). If the number of children
+ is greater than 1 it will return an array of object record with
+ each maybe the input value for another call to
+ <function>hw_GetRemoteChildren</function>. Those object records are
+ virtual and do not exist in the Hyperwave server, therefore they
+ do not have a valid object ID. How exactely such an object record
+ looks like is up to the HGI.
+ If you want to use this function you should be very familiar with HGIs.
+ You should also consider to use php3 instead of Hyperwave to access
+ external
+ sources. Adding database support by a Hyperwave gateway should be more
+ difficult than doing it in php3.
+ <para>
+ See also <function>hw_GetRemote</function>.
+ </refsect1>
+ </refentry>
+
    <refentry id="function.hw-getsrcbydestobj">
     <refnamediv>
      <refname>hw_GetSrcByDestObj</refname> 

--
PHP Development Mailing List   http://www.php.net/
To unsubscribe send an empty message to php-dev-unsubscribe <email protected>
For help: php-dev-help <email protected>