Source of: /manual/en/function.hw-getremote.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.hw.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.hw-getremote.php',
1 => 'hw_GetRemote',
),
'up' =>
array (
0 => 'ref.hw.php',
1 => 'Hyperwave Functions',
),
'prev' =>
array (
0 => 'function.hw-getrellink.php',
1 => 'hw_getrellink',
),
'next' =>
array (
0 => 'function.hw-getremotechildren.php',
1 => 'hw_getremotechildren',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.hw-getremote" class="refentry">
<div class="refnamediv">
<h1 class="refname">hw_GetRemote</h1>
<p class="verinfo">(PHP 4)</p><p class="refpurpose"><span class="refname">hw_GetRemote</span> — <span class="dc-title">Gets a remote document</span></p>
</div>
<a name="function.hw-getremote.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>hw_getremote</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$connection</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$objectID</tt></span>
)</div>
<p class="para rdfs-comment">
Gets a remote document.
</p>
<p class="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.
</p>
<p class="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.
</p>
<p class="para">
Calling <b>hw_getremote()</b> 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.
</p>
</div>
<a name="function.hw-getremote.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">connection</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The connection identifier.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">objectID</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The object identifier.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.hw-getremote.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a remote document.
</p>
</div>
<a name="function.hw-getremote.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.hw-getremotechildren.php" class="function" rel="rdfs-seeAlso">hw_getremotechildren()</a> - Gets children of remote document</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
