<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Retrieve text document</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.hw-getsrcbydestobj.html">hw_GetSrcByDestObj</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.hw-getusername.html">hw_getusername</a></div>
<div class="up"><a href="ref.hw.html">Hyperwave Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.hw-gettext" class="refentry">
<div class="refnamediv">
<h1 class="refname">hw_GetText</h1>
<p class="verinfo">(PHP 4)</p><p class="refpurpose"><span class="refname">hw_GetText</span> — <span class="dc-title">Retrieve text document</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.hw-gettext-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>hw_gettext</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$connection</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$objectID</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$rootID/prefix</code></span>
] )</div>
<p class="para rdfs-comment">
Returns the document with object ID <em><code class="parameter">objectID</code></em>. If
the document has anchors which can be inserted, they will be inserted
already.
</p>
<p class="para">
This function will only work for pure text documents. It will not open a
special data connection and therefore blocks the control connection during
the transfer.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.hw-gettext-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">connection</code></em></span>
<dd>
<p class="para">
The connection identifier.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">objectID</code></em></span>
<dd>
<p class="para">
The object identifier.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">rootID/prefix</code></em></span>
<dd>
<p class="para">
The optional parameter <em><code class="parameter">rootID/prefix</code></em> can be a
string or an integer. If it is an integer it determines how links are
inserted into the document. The default is 0 and will result in links
that are constructed from the name of the link's destination object.
This is useful for web applications. If a link points to an object
with name 'internet_movie' the HTML link will be <A
href="/internet_movie">. The actual location of the source and
destination object in the document hierarchy is disregarded. You
will have to set up your web browser, to rewrite that URL to for
example '/my_script.php/internet_movie'. 'my_script.php' will
have to evaluate $PATH_INFO and retrieve the document.
All links will have the prefix '/my_script.php/'. If you do not
want this you can set the optional parameter
<em><code class="parameter">rootID/prefix</code></em> to any prefix which
is used instead. Is this case it has to be a string.
</p>
<p class="para">
If <em><code class="parameter">rootID/prefix</code></em> is an integer and unequal to 0
the link is constructed from all the names starting at the object with
the id <em><code class="parameter">rootID/prefix</code></em> separated by a slash
relative to the current object.
</p>
<p class="para">
If for example the above document 'internet_movie' is located
at 'a-b-c-internet_movie' with '-' being the separator between
hierarchy levels on the Hyperwave server and the source document is
located at 'a-b-d-source' the resulting HTML link would be:
<A HREF="../c/internet_movie">. This is useful if you want
to download the whole server content onto disk and map
the document hierarchy onto the file system.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.hw-gettext-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the text document.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.hw-gettext-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.hw-pipedocument.html" class="function" rel="rdfs-seeAlso">hw_pipedocument()</a> - Retrieve any document</span></li>
<li class="member"> <span class="function"><a href="function.hw-free-document.html" class="function" rel="rdfs-seeAlso">hw_free_document()</a> - Frees hw_document</span></li>
<li class="member"> <span class="function"><a href="function.hw-document-bodytag.html" class="function" rel="rdfs-seeAlso">hw_document_bodytag()</a> - Body tag of hw_document</span></li>
<li class="member"> <span class="function"><a href="function.hw-document-size.html" class="function" rel="rdfs-seeAlso">hw_document_size()</a> - Size of hw_document</span></li>
<li class="member"> <span class="function"><a href="function.hw-output-document.html" class="function" rel="rdfs-seeAlso">hw_output_document()</a> - Prints hw_document</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.hw-getsrcbydestobj.html">hw_GetSrcByDestObj</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.hw-getusername.html">hw_getusername</a></div>
<div class="up"><a href="ref.hw.html">Hyperwave Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
