What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

hw_gettext
Prev	XXVIII. Hyperwave Functions	Next

hw_gettext

Name

hw_gettext — Fetches a text document.

Synopsis

int hw_gettext(hw_link, object_id[, root_id/prefix]); resource hw_link: Connection ID to Hyperwave server int object_id: Object ID of document to fetch mixed root_id/prefix (optional): Anchor prefix or relative root object ID

Returns

Document ID; FALSE on failure

Description

This function returns a text-only document from the server, with anchors inserted. The document to fetch is specified by the object_id parameter.

If root_id/prefix is a string, the anchors inserted into the document have this string prepended to them.

If root_id/prefix is a nonzero integer, it's taken as the object ID of the object on which to base the inserted anchors.

hw_gettext() works only with plain-text documents, and uses the control connection to the server to fetch them. This means that the connection is blocked and cannot be used for anything else while the transfer is occurring. If you want to retrieve documents of any type and not tie up the control connection while fetching, use hw_pipedocument() instead.

Version

PHP 3 since 3.0.3, PHP 4

Example

Example 502. Return a plain text document

if (($doc_id = hw_gettext($hw_link, 89985, 'some_script_name.php')) === FALSE) {
    echo "Could not get document; reason: " . hw_errormsg($hw_link) . ".\n";
} else {
    hw_output_document($doc_id);
}

if (($doc_id = hw_gettext($hw_link, 89985, 27)) === FALSE) {
    echo "Could not get document; reason: " . hw_errormsg($hw_link) . ".\n";
} else {
    hw_output_document($doc_id);
}

Prev	Home	Next
hw_getsrcbydestobj	Up	hw_getusername

PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.