<?xml version='1.0' encoding='iso-8859-1' ?> <!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 --> <refentry id="function.hwapi-content"> <refnamediv> <refname>hw_api->content</refname> <refpurpose>Returns content of an object</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>object</type><methodname>content</methodname> <methodparam><type>array</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> This function returns the content of a document as an object of type <classname>hw_api_content</classname>. The parameter array contains the required elements 'objectidentifier' and the optional element 'mode'. The mode can be one of the constants HW_API_CONTENT_ALLLINKS, HW_API_CONTENT_REACHABLELINKS or HW_API_CONTENT_PLAIN. HW_API_CONTENT_ALLLINKS means to insert all anchors even if the destination is not reachable. HW_API_CONTENT_REACHABLELINKS tells <function>hw_api_content</function> to insert only reachable links and HW_API_CONTENT_PLAIN will lead to document without any links. </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:"../../../../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 -->