sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WS

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249381 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-12-29 22:27:08 +00:00
parent 2605f98aca
commit f5eef30132
62 changed files with 1684 additions and 1696 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
reference/hw/functions/hw-array2objrec.xml
View file

@ -1,27 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-array2objrec" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Array2Objrec</refname>
<refpurpose>Convert attributes from object array to object record</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_array2objrec</methodname>
<methodparam><type>array</type><parameter>object_array</parameter></methodparam>
</methodsynopsis>
<para>
Converts an <parameter>object_array</parameter> into an object record.
Multiple attributes like 'Title' in different languages are treated
properly.
</para>
<para>
See also <function>hw_objrec2array</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-array2objrec" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Array2Objrec</refname>
<refpurpose>Convert attributes from object array to object record</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_array2objrec</methodname>
<methodparam><type>array</type><parameter>object_array</parameter></methodparam>
</methodsynopsis>
<para>
Converts an <parameter>object_array</parameter> into an object record.
Multiple attributes like 'Title' in different languages are treated
properly.
</para>
<para>
See also <function>hw_objrec2array</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

40
reference/hw/functions/hw-changeobject.xml
View file

@ -1,26 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id='function.hw-changeobject' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_changeobject</refname>
<refpurpose>
Changes attributes of an object (obsolete)
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_changeobject</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>objid</parameter></methodparam>
<methodparam><type>array</type><parameter>attributes</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry xml:id='function.hw-changeobject' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_changeobject</refname>
<refpurpose>Changes attributes of an object (obsolete)</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_changeobject</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>objid</parameter></methodparam>
<methodparam><type>array</type><parameter>attributes</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

40
reference/hw/functions/hw-children.xml
View file

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-children" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Children</refname>
<refpurpose>Object ids of children</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_children</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object ids. Each id
belongs to a child of the collection with ID
<parameter>objectID</parameter>.
The array contains all children both documents and collections.</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-children" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Children</refname>
<refpurpose>Object ids of children</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_children</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object ids. Each id belongs to a child of the
collection with ID <parameter>objectID</parameter>.
The array contains all children both documents and collections.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

41
reference/hw/functions/hw-childrenobj.xml
View file

@ -1,25 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-childrenobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_ChildrenObj</refname>
<refpurpose>Object records of children</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_childrenobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object records. Each object record
belongs to a child of the collection with ID
<parameter>objectID</parameter>.
The array contains all children both documents and collections.</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-childrenobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_ChildrenObj</refname>
<refpurpose>Object records of children</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_childrenobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object records. Each object record
belongs to a child of the collection with ID
<parameter>objectID</parameter>.
The array contains all children both documents and collections.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/hw/functions/hw-close.xml
View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-close" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Close</refname>
<refpurpose>Closes the Hyperwave connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_close</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns &false; if connection is not a valid connection index,
otherwise &true;. Closes down the connection to a Hyperwave server
with the given connection index.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-close" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Close</refname>
<refpurpose>Closes the Hyperwave connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_close</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns &false; if connection is not a valid connection index,
otherwise &true;. Closes down the connection to a Hyperwave server
with the given connection index.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

66
reference/hw/functions/hw-connect.xml
View file

@ -1,38 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-connect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Connect</refname>
<refpurpose>Opens a connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_connect</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Opens a connection to a Hyperwave server and returns a connection
index on success, or &false; if the connection
could not be made. Each of the arguments should be a quoted string,
except for the port number. The <parameter>username</parameter> and
<parameter>password</parameter> arguments are
optional and can be left out. In such a case no identification with
the server will be done. It is similar to identify as user anonymous.
This function returns a connection
index that is needed by other Hyperwave functions. You can have
multiple connections open at once. Keep in mind, that the password
is not encrypted.
</para>
<para>
See also <function>hw_pconnect</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-connect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Connect</refname>
<refpurpose>Opens a connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_connect</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Opens a connection to a Hyperwave server and returns a connection
index on success, or &false; if the connection
could not be made. Each of the arguments should be a quoted string,
except for the port number. The <parameter>username</parameter> and
<parameter>password</parameter> arguments are
optional and can be left out. In such a case no identification with
the server will be done. It is similar to identify as user anonymous.
This function returns a connection
index that is needed by other Hyperwave functions. You can have
multiple connections open at once. Keep in mind, that the password
is not encrypted.
</para>
<para>
See also <function>hw_pconnect</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

36
reference/hw/functions/hw-connection-info.xml
View file

@ -1,24 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<refentry xml:id='function.hw-connection-info' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_connection_info</refname>
<refpurpose>
Prints information about the connection to Hyperwave server
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>hw_connection_info</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry xml:id='function.hw-connection-info' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_connection_info</refname>
<refpurpose>Prints information about the connection to Hyperwave server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>hw_connection_info</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

54
reference/hw/functions/hw-cp.xml
View file

@ -1,32 +1,32 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-cp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_cp</refname>
<refpurpose>Copies objects</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_cp</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>array</type><parameter>object_id_array</parameter></methodparam>
<methodparam><type>int</type><parameter>destination_id</parameter></methodparam>
</methodsynopsis>
<para>
Copies the objects with object ids as specified in the second
parameter to the collection
with the id <parameter>destination id</parameter>.
</para>
<para>
The value return is the number of copied objects.
</para>
<para>
See also <function>hw_mv</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-cp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_cp</refname>
<refpurpose>Copies objects</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_cp</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>array</type><parameter>object_id_array</parameter></methodparam>
<methodparam><type>int</type><parameter>destination_id</parameter></methodparam>
</methodsynopsis>
<para>
Copies the objects with object ids as specified in the second
parameter to the collection
with the id <parameter>destination id</parameter>.
</para>
<para>
The value return is the number of copied objects.
</para>
<para>
See also <function>hw_mv</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/hw/functions/hw-deleteobject.xml
View file

@ -1,30 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-deleteobject" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Deleteobject</refname>
<refpurpose>Deletes object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_deleteobject</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>object_to_delete</parameter></methodparam>
</methodsynopsis>
<para>
Deletes the object with the given object id in the second
parameter. It will delete all instances of the object.
</para>
<para>
Returns &true; if no error occurs otherwise &false;.
</para>
<para>
See also <function>hw_mv</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-deleteobject" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Deleteobject</refname>
<refpurpose>Deletes object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_deleteobject</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>object_to_delete</parameter></methodparam>
</methodsynopsis>
<para>
Deletes the object with the given object id in the second
parameter. It will delete all instances of the object.
</para>
<para>
Returns &true; if no error occurs otherwise &false;.
</para>
<para>
See also <function>hw_mv</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/hw/functions/hw-docbyanchor.xml
View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-docbyanchor" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_DocByAnchor</refname>
<refpurpose>Object id object belonging to anchor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_docbyanchor</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>anchorID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an th object id of the document to
which <parameter>anchorID</parameter> belongs.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-docbyanchor" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_DocByAnchor</refname>
<refpurpose>Object id object belonging to anchor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_docbyanchor</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>anchorID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an th object id of the document to
which <parameter>anchorID</parameter> belongs.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/hw/functions/hw-docbyanchorobj.xml
View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-docbyanchorobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_DocByAnchorObj</refname>
<refpurpose>Object record object belonging to anchor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_docbyanchorobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>anchorID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an th object record of the document to
which <parameter>anchorID</parameter> belongs.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-docbyanchorobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_DocByAnchorObj</refname>
<refpurpose>Object record object belonging to anchor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_docbyanchorobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>anchorID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an th object record of the document to
which <parameter>anchorID</parameter> belongs.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/hw/functions/hw-document-attributes.xml
View file

@ -1,30 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-document-attributes" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_Attributes</refname>
<refpurpose>Object record of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_document_attributes</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Returns the object record of the document.
</para>
<para>
For backward compatibility, <function>hw_documentattributes</function>
is also accepted. This is deprecated, however.
</para>
<para>
See also <function>hw_document_bodytag</function>,
and <function>hw_document_size</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-document-attributes" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_Attributes</refname>
<refpurpose>Object record of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_document_attributes</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Returns the object record of the document.
</para>
<para>
For backward compatibility, <function>hw_documentattributes</function>
is also accepted. This is deprecated, however.
</para>
<para>
See also <function>hw_document_bodytag</function>,
and <function>hw_document_size</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

54
reference/hw/functions/hw-document-bodytag.xml
View file

@ -1,32 +1,32 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-document-bodytag" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_BodyTag</refname>
<refpurpose>Body tag of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_document_bodytag</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>prefix</parameter></methodparam>
</methodsynopsis>
<para>
Returns the BODY tag of the document. If the document is an HTML
document the BODY tag should be printed before the document.
</para>
<para>
See also <function>hw_document_attributes</function>,
and <function>hw_document_size</function>.
</para>
<para>
For backward compatibility, <function>hw_documentbodytag</function>
is also accepted. This is deprecated, however.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-document-bodytag" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_BodyTag</refname>
<refpurpose>Body tag of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_document_bodytag</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>prefix</parameter></methodparam>
</methodsynopsis>
<para>
Returns the BODY tag of the document. If the document is an HTML
document the BODY tag should be printed before the document.
</para>
<para>
See also <function>hw_document_attributes</function>,
and <function>hw_document_size</function>.
</para>
<para>
For backward compatibility, <function>hw_documentbodytag</function>
is also accepted. This is deprecated, however.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/hw/functions/hw-document-content.xml
View file

@ -1,29 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-document-content" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_Content</refname>
<refpurpose>Returns content of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_document_content</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Returns the content of the document. If the document is an HTML
document the content is everything after the BODY tag. Information
from the HEAD and BODY tag is in the stored in the object record.
</para>
<para>
See also <function>hw_document_attributes</function>,
<function>hw_document_size</function>,
and <function>hw_document_setcontent</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-document-content" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_Content</refname>
<refpurpose>Returns content of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_document_content</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Returns the content of the document. If the document is an HTML
document the content is everything after the BODY tag. Information
from the HEAD and BODY tag is in the stored in the object record.
</para>
<para>
See also <function>hw_document_attributes</function>,
<function>hw_document_size</function>,
and <function>hw_document_setcontent</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

58
reference/hw/functions/hw-document-setcontent.xml
View file

@ -1,34 +1,34 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-document-setcontent" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_SetContent</refname>
<refpurpose>Sets/replaces content of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_document_setcontent</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
<para>
Sets or replaces the content of the document. If the document is an HTML
document the content is everything after the BODY tag. Information
from the HEAD and BODY tag is in the stored in the object record.
If you provide this information in the content of the document too,
the Hyperwave server will change the object record accordingly when
the document is inserted. Probably not a very good idea.
If this functions fails the document will retain its old content.
</para>
<para>
See also <function>hw_document_attributes</function>,
<function>hw_document_size</function>,
and <function>hw_document_content</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-document-setcontent" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_SetContent</refname>
<refpurpose>Sets/replaces content of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_document_setcontent</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
<para>
Sets or replaces the content of the document. If the document is an HTML
document the content is everything after the BODY tag. Information
from the HEAD and BODY tag is in the stored in the object record.
If you provide this information in the content of the document too,
the Hyperwave server will change the object record accordingly when
the document is inserted. Probably not a very good idea.
If this functions fails the document will retain its old content.
</para>
<para>
See also <function>hw_document_attributes</function>,
<function>hw_document_size</function>,
and <function>hw_document_content</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/hw/functions/hw-document-size.xml
View file

@ -1,29 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-document-size" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_Size</refname>
<refpurpose>Size of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_document_size</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Returns the size in bytes of the document.</para>
<para>
See also <function>hw_document_bodytag</function>,
and <function>hw_document_attributes</function>.
</para>
<para>
For backward compatibility, <function>hw_documentsize</function>
is also accepted. This is deprecated, however.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-document-size" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_Size</refname>
<refpurpose>Size of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_document_size</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Returns the size in bytes of the document.</para>
<para>
See also <function>hw_document_bodytag</function>,
and <function>hw_document_attributes</function>.
</para>
<para>
For backward compatibility, <function>hw_documentsize</function>
is also accepted. This is deprecated, however.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

40
reference/hw/functions/hw-dummy.xml
View file

@ -1,26 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<refentry xml:id='function.hw-dummy' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_dummy</refname>
<refpurpose>
Hyperwave dummy function
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_dummy</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>id</parameter></methodparam>
<methodparam><type>int</type><parameter>msgid</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry xml:id='function.hw-dummy' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_dummy</refname>
<refpurpose>Hyperwave dummy function</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_dummy</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>id</parameter></methodparam>
<methodparam><type>int</type><parameter>msgid</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

62
reference/hw/functions/hw-edittext.xml
View file

@ -1,36 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-edittext" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_EditText</refname>
<refpurpose>Retrieve text document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_edittext</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Uploads the text document to the server. The object record
of the document may not be modified while the document
is edited.
This function will only works for pure text documents. It will
not open a special data connection and therefore blocks the
control connection during the transfer.
</para>
<para>
See also <function>hw_pipedocument</function>,
<function>hw_free_document</function>,
<function>hw_document_bodytag</function>,
<function>hw_document_size</function>,
<function>hw_output_document</function>, and
<function>hw_gettext</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-edittext" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_EditText</refname>
<refpurpose>Retrieve text document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_edittext</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Uploads the text document to the server. The object record
of the document may not be modified while the document
is edited.
This function will only works for pure text documents. It will
not open a special data connection and therefore blocks the
control connection during the transfer.
</para>
<para>
See also <function>hw_pipedocument</function>,
<function>hw_free_document</function>,
<function>hw_document_bodytag</function>,
<function>hw_document_size</function>,
<function>hw_output_document</function>, and
<function>hw_gettext</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

36
reference/hw/functions/hw-error.xml
View file

@ -1,23 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-error" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Error</refname>
<refpurpose>Error number</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_error</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns the last error number. If the return value is 0 no error has
occurred. The error relates to the last command.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-error" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Error</refname>
<refpurpose>Error number</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_error</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns the last error number. If the return value is 0 no error has
occurred. The error relates to the last command.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/hw/functions/hw-errormsg.xml
View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-errormsg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_ErrorMsg</refname>
<refpurpose>Returns error message</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_errormsg</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string containing the last error message or 'No Error'. If &false;
is returned, this function failed.
The message relates to the last command.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-errormsg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_ErrorMsg</refname>
<refpurpose>Returns error message</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_errormsg</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string containing the last error message or 'No Error'. If &false;
is returned, this function failed.
The message relates to the last command.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

34
reference/hw/functions/hw-free-document.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-free-document" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Free_Document</refname>
<refpurpose>Frees hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_free_document</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Frees the memory occupied by the Hyperwave document.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-free-document" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Free_Document</refname>
<refpurpose>Frees hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_free_document</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Frees the memory occupied by the Hyperwave document.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/hw/functions/hw-getanchors.xml
View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getanchors" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetAnchors</refname>
<refpurpose>Object ids of anchors of document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getanchors</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object ids with anchors of the document
with object ID <parameter>objectID</parameter>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getanchors" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetAnchors</refname>
<refpurpose>Object ids of anchors of document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getanchors</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object ids with anchors of the document
with object ID <parameter>objectID</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/hw/functions/hw-getanchorsobj.xml
View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getanchorsobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetAnchorsObj</refname>
<refpurpose>Object records of anchors of document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getanchorsobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object records with anchors of the document
with object ID <parameter>objectID</parameter>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getanchorsobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetAnchorsObj</refname>
<refpurpose>Object records of anchors of document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getanchorsobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object records with anchors of the document
with object ID <parameter>objectID</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/hw/functions/hw-getandlock.xml
View file

@ -1,30 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getandlock" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetAndLock</refname>
<refpurpose>Return object record and lock object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_getandlock</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns the object record for the object with ID
<parameter>objectID</parameter>.
It will also lock the object, so other users cannot access
it until it is unlocked.
</para>
<para>
See also <function>hw_unlock</function>,
and <function>hw_getobject</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getandlock" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetAndLock</refname>
<refpurpose>Return object record and lock object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_getandlock</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns the object record for the object with ID
<parameter>objectID</parameter>.
It will also lock the object, so other users cannot access
it until it is unlocked.
</para>
<para>
See also <function>hw_unlock</function>,
and <function>hw_getobject</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

49
reference/hw/functions/hw-getchildcoll.xml
View file

@ -1,29 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getchildcoll" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetChildColl</refname>
<refpurpose>Object ids of child collections</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getchildcoll</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object ids. Each object ID
belongs to a child collection of the collection with ID
<parameter>objectID</parameter>. The function will not
return child documents.</para>
<para>
See also <function>hw_children</function>,
and <function>hw_getchilddoccoll</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getchildcoll" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetChildColl</refname>
<refpurpose>Object ids of child collections</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getchildcoll</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object ids. Each object ID
belongs to a child collection of the collection with ID
<parameter>objectID</parameter>. The function will not
return child documents.
</para>
<para>
See also <function>hw_children</function>,
and <function>hw_getchilddoccoll</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/hw/functions/hw-getchildcollobj.xml
View file

@ -1,30 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getchildcollobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetChildCollObj</refname>
<refpurpose>Object records of child collections</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getchildcollobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object records. Each object records
belongs to a child collection of the collection with ID
<parameter>objectID</parameter>. The function will not return
child documents.
</para>
<para>
See also <function>hw_childrenobj</function>,
and <function>hw_getchilddoccollobj</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getchildcollobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetChildCollObj</refname>
<refpurpose>Object records of child collections</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getchildcollobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object records. Each object records
belongs to a child collection of the collection with ID
<parameter>objectID</parameter>. The function will not return
child documents.
</para>
<para>
See also <function>hw_childrenobj</function>,
and <function>hw_getchilddoccollobj</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/hw/functions/hw-getchilddoccoll.xml
View file

@ -1,27 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getchilddoccoll" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetChildDocColl</refname>
<refpurpose>Object ids of child documents of collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getchilddoccoll</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns array of object ids for child documents of a collection.
</para>
<para>
See also <function>hw_children</function>,
and <function>hw_getchildcoll</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getchilddoccoll" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetChildDocColl</refname>
<refpurpose>Object ids of child documents of collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getchilddoccoll</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns array of object ids for child documents of a collection.
</para>
<para>
See also <function>hw_children</function>,
and <function>hw_getchildcoll</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

43
reference/hw/functions/hw-getchilddoccollobj.xml
View file

@ -1,26 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getchilddoccollobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetChildDocCollObj</refname>
<refpurpose>Object records of child documents of collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getchilddoccollobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object records for child documents of a collection.</para>
<para>
See also <function>hw_childrenobj</function>,
and <function>hw_getchildcollobj</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getchilddoccollobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetChildDocCollObj</refname>
<refpurpose>Object records of child documents of collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getchilddoccollobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object records for child documents of a collection.
</para>
<para>
See also <function>hw_childrenobj</function>,
and <function>hw_getchildcollobj</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

94
reference/hw/functions/hw-getobject.xml
View file

@ -1,54 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getobject" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetObject</refname>
<refpurpose>Object record</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>hw_getobject</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>mixed</type><parameter>objectID</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
Returns the object record for the object with ID
<parameter>objectID</parameter> if the second parameter is an integer.
If the second parameter is an array of integer the function will
return an array of object records. In such a case the last
parameter is also evaluated which is a query string.
</para>
<para>
The query string has the following syntax:</para>
<simpara>
&lt;expr> ::= "(" &lt;expr> ")" |</simpara> <simpara>
"!" &lt;expr> | /* NOT */</simpara><simpara>
&lt;expr> "||" &lt;expr> | /* OR */</simpara><simpara>
&lt;expr> "&amp;&amp;" &lt;expr> | /* AND */</simpara><simpara>
&lt;attribute> &lt;operator> &lt;value></simpara><simpara>
<refentry xml:id="function.hw-getobject" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetObject</refname>
<refpurpose>Object record</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>hw_getobject</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>mixed</type><parameter>objectID</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
Returns the object record for the object with ID
<parameter>objectID</parameter> if the second parameter is an integer.
If the second parameter is an array of integer the function will
return an array of object records. In such a case the last
parameter is also evaluated which is a query string.
</para>
<para>
The query string has the following syntax:</para>
<simpara>
&lt;expr> ::= "(" &lt;expr> ")" |</simpara> <simpara>
"!" &lt;expr> | /* NOT */</simpara><simpara>
&lt;expr> "||" &lt;expr> | /* OR */</simpara><simpara>
&lt;expr> "&amp;&amp;" &lt;expr> | /* AND */</simpara><simpara>
&lt;attribute> &lt;operator> &lt;value></simpara><simpara>
&lt;attribute> ::= /* any attribute name (Title, Author, DocumentType ...) */</simpara><simpara>
&lt;attribute> ::= /* any attribute name (Title, Author, DocumentType ...) */</simpara><simpara>
&lt;operator> ::= "=" | /* equal */</simpara><simpara>
"&lt;" | /* less than (string compare) */</simpara><simpara>
">" | /* greater than (string compare) */</simpara><simpara>
"~" /* regular expression matching */</simpara><simpara></simpara>
<para>
The query allows to further select certain objects from the list
of given objects. Unlike the other
query functions, this query may use not indexed attributes. How many
object records are returned depends on the query and if access to
the object is allowed.
</para>
<para>
See also <function>hw_getandlock</function>,
and <function>hw_getobjectbyquery</function>.
</para>
</refsect1>
</refentry>
&lt;operator> ::= "=" | /* equal */</simpara><simpara>
"&lt;" | /* less than (string compare) */</simpara><simpara>
">" | /* greater than (string compare) */</simpara><simpara>
"~" /* regular expression matching */</simpara><simpara></simpara>
<para>
The query allows to further select certain objects from the list
of given objects. Unlike the other
query functions, this query may use not indexed attributes. How many
object records are returned depends on the query and if access to
the object is allowed.
</para>
<para>
See also <function>hw_getandlock</function>,
and <function>hw_getobjectbyquery</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

56
reference/hw/functions/hw-getobjectbyquery.xml
View file

@ -1,33 +1,33 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getobjectbyquery" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetObjectByQuery</refname>
<refpurpose>Search object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyquery</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>max_hits</parameter></methodparam>
</methodsynopsis>
<para>
Searches for objects on the whole server and returns an array of
object ids. The maximum number of matches is limited to
<parameter>max_hits</parameter>. If <parameter>max_hits</parameter>
is set to -1 the maximum number of matches is unlimited.
</para>
<para>
The query will only work with indexed attributes.
</para>
<para>
See also <function>hw_getobjectbyqueryobj</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getobjectbyquery" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetObjectByQuery</refname>
<refpurpose>Search object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyquery</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>max_hits</parameter></methodparam>
</methodsynopsis>
<para>
Searches for objects on the whole server and returns an array of
object ids. The maximum number of matches is limited to
<parameter>max_hits</parameter>. If <parameter>max_hits</parameter>
is set to -1 the maximum number of matches is unlimited.
</para>
<para>
The query will only work with indexed attributes.
</para>
<para>
See also <function>hw_getobjectbyqueryobj</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

60
reference/hw/functions/hw-getobjectbyquerycoll.xml
View file

@ -1,35 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getobjectbyquerycoll" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetObjectByQueryColl</refname>
<refpurpose>Search object in collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyquerycoll</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>max_hits</parameter></methodparam>
</methodsynopsis>
<para>
Searches for objects in collection with ID
<parameter>objectID</parameter> and returns an array of
object ids. The maximum number of matches is limited to
<parameter>max_hits</parameter>.
If <parameter>max_hits</parameter>
is set to -1 the maximum number of matches is unlimited.
</para>
<para>
The query will only work with indexed attributes.</para>
<para>
See also <function>hw_getobjectbyquerycollobj</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getobjectbyquerycoll" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetObjectByQueryColl</refname>
<refpurpose>Search object in collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyquerycoll</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>max_hits</parameter></methodparam>
</methodsynopsis>
<para>
Searches for objects in collection with ID
<parameter>objectID</parameter> and returns an array of
object ids. The maximum number of matches is limited to
<parameter>max_hits</parameter>.
If <parameter>max_hits</parameter>
is set to -1 the maximum number of matches is unlimited.
</para>
<para>
The query will only work with indexed attributes.</para>
<para>
See also <function>hw_getobjectbyquerycollobj</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

62
reference/hw/functions/hw-getobjectbyquerycollobj.xml
View file

@ -1,36 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getobjectbyquerycollobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetObjectByQueryCollObj</refname>
<refpurpose>Search object in collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyquerycollobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>max_hits</parameter></methodparam>
</methodsynopsis>
<para>
Searches for objects in collection with ID
<parameter>objectID</parameter> and returns an array of
object records. The maximum number of matches is limited to
<parameter>max_hits</parameter>.
If <parameter>max_hits</parameter>
is set to -1 the maximum number of matches is unlimited.
</para>
<para>
The query will only work with indexed attributes.
</para>
<para>
See also <function>hw_getobjectbyquerycoll</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getobjectbyquerycollobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetObjectByQueryCollObj</refname>
<refpurpose>Search object in collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyquerycollobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>max_hits</parameter></methodparam>
</methodsynopsis>
<para>
Searches for objects in collection with ID
<parameter>objectID</parameter> and returns an array of
object records. The maximum number of matches is limited to
<parameter>max_hits</parameter>.
If <parameter>max_hits</parameter>
is set to -1 the maximum number of matches is unlimited.
</para>
<para>
The query will only work with indexed attributes.
</para>
<para>
See also <function>hw_getobjectbyquerycoll</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

56
reference/hw/functions/hw-getobjectbyqueryobj.xml
View file

@ -1,33 +1,33 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getobjectbyqueryobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetObjectByQueryObj</refname>
<refpurpose>Search object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyqueryobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>max_hits</parameter></methodparam>
</methodsynopsis>
<para>
Searches for objects on the whole server and returns an array of
object records. The maximum number of matches is limited to
<parameter>max_hits</parameter>. If <parameter>max_hits</parameter>
is set to -1 the maximum number of matches is unlimited.
</para>
<para>
The query will only work with indexed attributes.
</para>
<para>
See also <function>hw_getobjectbyquery</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getobjectbyqueryobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetObjectByQueryObj</refname>
<refpurpose>Search object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyqueryobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>max_hits</parameter></methodparam>
</methodsynopsis>
<para>
Searches for objects on the whole server and returns an array of
object records. The maximum number of matches is limited to
<parameter>max_hits</parameter>. If <parameter>max_hits</parameter>
is set to -1 the maximum number of matches is unlimited.
</para>
<para>
The query will only work with indexed attributes.
</para>
<para>
See also <function>hw_getobjectbyquery</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/hw/functions/hw-getparents.xml
View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getparents" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetParents</refname>
<refpurpose>Object ids of parents</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getparents</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an indexed array of object ids. Each object id belongs to
a parent of the object with ID <parameter>objectID</parameter>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getparents" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetParents</refname>
<refpurpose>Object ids of parents</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getparents</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an indexed array of object ids. Each object id belongs to
a parent of the object with ID <parameter>objectID</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

42
reference/hw/functions/hw-getparentsobj.xml
View file

@ -1,26 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getparentsobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetParentsObj</refname>
<refpurpose>Object records of parents</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getparentsobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an indexed array of object records plus an associated array with statistical
information about the object records. The associated array is the
last entry of the returned array. Each object record belongs to
a parent of the object with ID <parameter>objectID</parameter>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getparentsobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetParentsObj</refname>
<refpurpose>Object records of parents</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getparentsobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an indexed array of object records plus an associated array with statistical
information about the object records. The associated array is the
last entry of the returned array. Each object record belongs to
a parent of the object with ID <parameter>objectID</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

42
reference/hw/functions/hw-getrellink.xml
View file

@ -1,27 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<refentry xml:id='function.hw-getrellink' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_getrellink</refname>
<refpurpose>
Get link from source to dest relative to rootid
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_getrellink</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>rootid</parameter></methodparam>
<methodparam><type>int</type><parameter>sourceid</parameter></methodparam>
<methodparam><type>int</type><parameter>destid</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry xml:id='function.hw-getrellink' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_getrellink</refname>
<refpurpose>Get link from source to dest relative to rootid</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_getrellink</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>rootid</parameter></methodparam>
<methodparam><type>int</type><parameter>sourceid</parameter></methodparam>
<methodparam><type>int</type><parameter>destid</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

64
reference/hw/functions/hw-getremote.xml
View file

@ -1,37 +1,37 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getremote" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetRemote</refname>
<refpurpose>Gets a remote document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_getremote</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<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
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.
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 PHP instead
of Hyperwave to access external sources. Adding database support
by a Hyperwave gateway should be more difficult than doing it in PHP.
</para>
<para>
See also <function>hw_getremotechildren</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getremote" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetRemote</refname>
<refpurpose>Gets a remote document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_getremote</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<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
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.
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 PHP instead
of Hyperwave to access external sources. Adding database support
by a Hyperwave gateway should be more difficult than doing it in PHP.
</para>
<para>
See also <function>hw_getremotechildren</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

76
reference/hw/functions/hw-getremotechildren.xml
View file

@ -1,43 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getremotechildren" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_getremotechildren</refname>
<refpurpose>Gets children of remote document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>hw_getremotechildren</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
</methodsynopsis>
<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 formatted 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 exactly 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 PHP instead of Hyperwave to access
external
sources. Adding database support by a Hyperwave gateway should be more
difficult than doing it in PHP.
</para>
<para>
See also <function>hw_getremote</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getremotechildren" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_getremotechildren</refname>
<refpurpose>Gets children of remote document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>hw_getremotechildren</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
</methodsynopsis>
<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 formatted 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 exactly 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 PHP instead of Hyperwave to access
external
sources. Adding database support by a Hyperwave gateway should be more
difficult than doing it in PHP.
</para>
<para>
See also <function>hw_getremote</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

45
reference/hw/functions/hw-getsrcbydestobj.xml
View file

@ -1,27 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-getsrcbydestobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetSrcByDestObj</refname>
<refpurpose>Returns anchors pointing at object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getsrcbydestobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns the object records of all anchors pointing to the object with ID
<parameter>objectID</parameter>. The object can either be a document
or an anchor of type destination.</para>
<para>
See also <function>hw_getanchors</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getsrcbydestobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetSrcByDestObj</refname>
<refpurpose>Returns anchors pointing at object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_getsrcbydestobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns the object records of all anchors pointing to the object with ID
<parameter>objectID</parameter>. The object can either be a document
or an anchor of type destination.
</para>
<para>
See also <function>hw_getanchors</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

126
reference/hw/functions/hw-gettext.xml
View file

@ -1,69 +1,67 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-gettext" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetText</refname>
<refpurpose>Retrieve text document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_gettext</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>
rootID/prefix
</parameter></methodparam>
</methodsynopsis>
<para>
Returns the document with object ID
<parameter>objectID</parameter>. If the document
has anchors which can be inserted, they will be inserted already.
The optional parameter <parameter>rootID/prefix</parameter> 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
&lt;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.php3/internet_movie'. 'my_script.php3' will
have to evaluate $PATH_INFO and retrieve the document.
All links will have the prefix '/my_script.php3/'. If you do not
want this you can set the optional parameter
<parameter>rootID/prefix</parameter> to any prefix which
is used instead. Is this case it has to be a string.
</para>
<para>
If <parameter>rootID/prefix</parameter> is an integer and
unequal to 0 the link is constructed from all the names
starting at the object with the id <parameter>rootID/prefix</parameter>
separated by a slash relative to the current object.
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:
&lt;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.
</para>
<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.
</para>
<para>
See also <function>hw_pipedocument</function>,
<function>hw_free_document</function>,
<function>hw_document_bodytag</function>,
<function>hw_document_size</function>,
and <function>hw_output_document</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-gettext" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetText</refname>
<refpurpose>Retrieve text document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_gettext</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>rootID/prefix</parameter></methodparam>
</methodsynopsis>
<para>
Returns the document with object ID
<parameter>objectID</parameter>. If the document
has anchors which can be inserted, they will be inserted already.
The optional parameter <parameter>rootID/prefix</parameter> 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
&lt;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.php3/internet_movie'. 'my_script.php3' will
have to evaluate $PATH_INFO and retrieve the document.
All links will have the prefix '/my_script.php3/'. If you do not
want this you can set the optional parameter
<parameter>rootID/prefix</parameter> to any prefix which
is used instead. Is this case it has to be a string.
</para>
<para>
If <parameter>rootID/prefix</parameter> is an integer and
unequal to 0 the link is constructed from all the names
starting at the object with the id <parameter>rootID/prefix</parameter>
separated by a slash relative to the current object.
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:
&lt;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.
</para>
<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.
</para>
<para>
See also <function>hw_pipedocument</function>,
<function>hw_free_document</function>,
<function>hw_document_bodytag</function>,
<function>hw_document_size</function>,
and <function>hw_output_document</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

34
reference/hw/functions/hw-getusername.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<refentry xml:id="function.hw-getusername" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_getusername</refname>
<refpurpose>Name of currently logged in user</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_getusername</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns the username of the connection.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-getusername" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_getusername</refname>
<refpurpose>Name of currently logged in user</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_getusername</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns the username of the connection.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

52
reference/hw/functions/hw-identify.xml
View file

@ -1,31 +1,31 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-identify" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Identify</refname>
<refpurpose>Identifies as user</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_identify</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Identifies as user with <parameter>username</parameter> and
<parameter>password</parameter>. Identification
is only valid for the current session. I do not think this
function will be needed very often. In most cases it will
be easier to identify with the opening of the connection.
</para>
<para>
See also <function>hw_connect</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-identify" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Identify</refname>
<refpurpose>Identifies as user</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_identify</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Identifies as user with <parameter>username</parameter> and
<parameter>password</parameter>. Identification
is only valid for the current session. I do not think this
function will be needed very often. In most cases it will
be easier to identify with the opening of the connection.
</para>
<para>
See also <function>hw_connect</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

62
reference/hw/functions/hw-incollections.xml
View file

@ -1,36 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-incollections" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_InCollections</refname>
<refpurpose>Check if object ids in collections</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_incollections</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>array</type><parameter>object_id_array</parameter></methodparam>
<methodparam><type>array</type><parameter>collection_id_array</parameter></methodparam>
<methodparam><type>int</type><parameter>return_collections</parameter></methodparam>
</methodsynopsis>
<para>
Checks whether a set of objects (documents or collections)
specified by the <parameter>object_id_array</parameter> is part of
the collections listed in <parameter>collection_id_array</parameter>.
When the fourth parameter <parameter>return_collections</parameter> is 0,
the subset of object ids that is part of the collections (i.e.,
the documents or collections that are children of one or more
collections of collection ids or their subcollections, recursively)
is returned as an array. When the fourth parameter is 1, however, the
set of collections that have one or more objects of this subset as
children are returned as an array. This option allows a client to,
e.g., highlight the part of the collection hierarchy that contains
the matches of a previous query, in a graphical overview.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-incollections" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_InCollections</refname>
<refpurpose>Check if object ids in collections</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_incollections</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>array</type><parameter>object_id_array</parameter></methodparam>
<methodparam><type>array</type><parameter>collection_id_array</parameter></methodparam>
<methodparam><type>int</type><parameter>return_collections</parameter></methodparam>
</methodsynopsis>
<para>
Checks whether a set of objects (documents or collections)
specified by the <parameter>object_id_array</parameter> is part of
the collections listed in <parameter>collection_id_array</parameter>.
When the fourth parameter <parameter>return_collections</parameter> is 0,
the subset of object ids that is part of the collections (i.e.,
the documents or collections that are children of one or more
collections of collection ids or their subcollections, recursively)
is returned as an array. When the fourth parameter is 1, however, the
set of collections that have one or more objects of this subset as
children are returned as an array. This option allows a client to,
e.g., highlight the part of the collection hierarchy that contains
the matches of a previous query, in a graphical overview.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

40
reference/hw/functions/hw-info.xml
View file

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Info</refname>
<refpurpose>Info about connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_info</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns information about the current connection. The returned string
has the following format: &lt;Serverstring&gt;, &lt;Host&gt;,
&lt;Port&gt;, &lt;Username&gt;, &lt;Port of Client&gt;,
&lt;Byte swapping&gt;
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Info</refname>
<refpurpose>Info about connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_info</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns information about the current connection. The returned string
has the following format: &lt;Serverstring&gt;, &lt;Host&gt;,
&lt;Port&gt;, &lt;Username&gt;, &lt;Port of Client&gt;,
&lt;Byte swapping&gt;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

42
reference/hw/functions/hw-inscoll.xml
View file

@ -1,26 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-inscoll" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_InsColl</refname>
<refpurpose>Insert collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_inscoll</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
<methodparam><type>array</type><parameter>object_array</parameter></methodparam>
</methodsynopsis>
<para>
Inserts a new collection with attributes as in
<parameter>object_array</parameter> into
collection with object ID <parameter>objectID</parameter>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-inscoll" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_InsColl</refname>
<refpurpose>Insert collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_inscoll</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
<methodparam><type>array</type><parameter>object_array</parameter></methodparam>
</methodsynopsis>
<para>
Inserts a new collection with attributes as in
<parameter>object_array</parameter> into
collection with object ID <parameter>objectID</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

60
reference/hw/functions/hw-insdoc.xml
View file

@ -1,35 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-insdoc" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_InsDoc</refname>
<refpurpose>Insert document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_insdoc</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>parentID</parameter></methodparam>
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
Inserts a new document with attributes as in
<parameter>object_record</parameter> into collection with object ID
<parameter>parentID</parameter>. This function inserts either
an object record only or an object record and a pure ascii text in
<parameter>text</parameter> if <parameter>text</parameter> is given.
If you want to insert a general document of any kind use
<function>hw_insertdocument</function> instead.
</para>
<para>
See also <function>hw_insertdocument</function>,
and <function>hw_inscoll</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-insdoc" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_InsDoc</refname>
<refpurpose>Insert document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_insdoc</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>parentID</parameter></methodparam>
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
Inserts a new document with attributes as in
<parameter>object_record</parameter> into collection with object ID
<parameter>parentID</parameter>. This function inserts either
an object record only or an object record and a pure ascii text in
<parameter>text</parameter> if <parameter>text</parameter> is given.
If you want to insert a general document of any kind use
<function>hw_insertdocument</function> instead.
</para>
<para>
See also <function>hw_insertdocument</function>,
and <function>hw_inscoll</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

42
reference/hw/functions/hw-insertanchors.xml
View file

@ -1,27 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<refentry xml:id='function.hw-insertanchors' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_insertanchors</refname>
<refpurpose>
Inserts only anchors into text
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_insertanchors</methodname>
<methodparam><type>int</type><parameter>hwdoc</parameter></methodparam>
<methodparam><type>array</type><parameter>anchorecs</parameter></methodparam>
<methodparam><type>array</type><parameter>dest</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>urlprefixes</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry xml:id='function.hw-insertanchors' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_insertanchors</refname>
<refpurpose>Inserts only anchors into text</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_insertanchors</methodname>
<methodparam><type>int</type><parameter>hwdoc</parameter></methodparam>
<methodparam><type>array</type><parameter>anchorecs</parameter></methodparam>
<methodparam><type>array</type><parameter>dest</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>urlprefixes</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

58
reference/hw/functions/hw-insertdocument.xml
View file

@ -1,34 +1,34 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-insertdocument" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_InsertDocument</refname>
<refpurpose>Upload any document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_insertdocument</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>parent_id</parameter></methodparam>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Uploads a document into the collection with
<parameter>parent_id</parameter>.
The document has to be created before with
<function>hw_new_document</function>. Make sure that
the object record of the new document contains at least
the attributes: Type, DocumentType, Title and Name. Possibly
you also want to set the MimeType. The functions returns the
object id of the new document or &false;.
</para>
<para>
See also <function>hw_pipedocument</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-insertdocument" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_InsertDocument</refname>
<refpurpose>Upload any document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_insertdocument</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>parent_id</parameter></methodparam>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Uploads a document into the collection with
<parameter>parent_id</parameter>.
The document has to be created before with
<function>hw_new_document</function>. Make sure that
the object record of the new document contains at least
the attributes: Type, DocumentType, Title and Name. Possibly
you also want to set the MimeType. The functions returns the
object id of the new document or &false;.
</para>
<para>
See also <function>hw_pipedocument</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

66
reference/hw/functions/hw-insertobject.xml
View file

@ -1,38 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-insertobject" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_InsertObject</refname>
<refpurpose>Inserts an object record</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_insertobject</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>object_rec</parameter></methodparam>
<methodparam><type>string</type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
<para>
Inserts an object into the server. The object can be
any valid hyperwave object. See the HG-CSP documentation
for a detailed information on how the parameters have to be.
</para>
<para>
Note: If you want to insert an Anchor, the attribute Position
has always been set either to a start/end value or to
'invisible'. Invisible positions are needed if the annotation
has no corresponding link in the annotation text.
</para>
<para>
See also <function>hw_pipedocument</function>,
<function>hw_insertdocument</function>,
<function>hw_insdoc</function>,
and <function>hw_inscoll</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-insertobject" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_InsertObject</refname>
<refpurpose>Inserts an object record</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_insertobject</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>object_rec</parameter></methodparam>
<methodparam><type>string</type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
<para>
Inserts an object into the server. The object can be
any valid hyperwave object. See the HG-CSP documentation
for a detailed information on how the parameters have to be.
</para>
<para>
Note: If you want to insert an Anchor, the attribute Position
has always been set either to a start/end value or to
'invisible'. Invisible positions are needed if the annotation
has no corresponding link in the annotation text.
</para>
<para>
See also <function>hw_pipedocument</function>,
<function>hw_insertdocument</function>,
<function>hw_insdoc</function>,
and <function>hw_inscoll</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

62
reference/hw/functions/hw-mapid.xml
View file

@ -1,36 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-mapid" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_mapid</refname>
<refpurpose>Maps global id on virtual local id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_mapid</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>server_id</parameter></methodparam>
<methodparam><type>int</type><parameter>object_id</parameter></methodparam>
</methodsynopsis>
<para>
Maps a global object id on any hyperwave server, even those
you did not connect to with <function>hw_connect</function>,
onto a virtual object id. This virtual object id can then be
used as any other object id, e.g. to obtain the object record
with <function>hw_getobject</function>. The server id is the
first part of the global object id (GOid) of the object which
is actually the IP number as an integer.
</para>
<para>
Note: In order to use this function you will have to set
the F_DISTRIBUTED flag, which can currently only be set at
compile time in hg_comm.c. It is not set by default. Read
the comment at the beginning of hg_comm.c
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-mapid" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_mapid</refname>
<refpurpose>Maps global id on virtual local id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_mapid</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>server_id</parameter></methodparam>
<methodparam><type>int</type><parameter>object_id</parameter></methodparam>
</methodsynopsis>
<para>
Maps a global object id on any hyperwave server, even those
you did not connect to with <function>hw_connect</function>,
onto a virtual object id. This virtual object id can then be
used as any other object id, e.g. to obtain the object record
with <function>hw_getobject</function>. The server id is the
first part of the global object id (GOid) of the object which
is actually the IP number as an integer.
</para>
<para>
Note: In order to use this function you will have to set
the F_DISTRIBUTED flag, which can currently only be set at
compile time in hg_comm.c. It is not set by default. Read
the comment at the beginning of hg_comm.c
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

280
reference/hw/functions/hw-modifyobject.xml
View file

@ -1,64 +1,64 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-modifyobject" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Modifyobject</refname>
<refpurpose>Modifies object record</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_modifyobject</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>object_to_change</parameter></methodparam>
<methodparam><type>array</type><parameter>remove</parameter></methodparam>
<methodparam><type>array</type><parameter>add</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
This command allows to remove, add, or modify individual attributes
of an object record. The object is specified by the Object ID
<parameter>object_to_change</parameter>. The first array
<parameter>remove</parameter> is a list of attributes to remove.
The second array <parameter>add</parameter> is a list of attributes
to add. In order to modify an attribute one will have to remove
the old one and add a new one. <function>hw_modifyobject</function>
will always remove the attributes before it adds attributes unless
the value of the attribute to remove is not a string or array.
</para>
<para>
The last parameter determines if the modification is performed
recursively. 1 means recursive modification. If some of the objects
cannot be modified they will be skipped without notice.
<function>hw_error</function> may not indicate an error though
some of the objects could not be modified.
</para>
<para>
The keys of both arrays are the attributes name. The value of each
array element can either be an array, a string or anything else.
If it is an array
each attribute value is constructed by the key of each element plus
a colon and the value of each element. If it is a string it is taken
as the attribute value. An empty string will result in a complete
removal of that attribute. If the value is neither a string nor an
array but something else, e.g. an integer, no operation at all will
be performed on the attribute. This is necessary if you want to
add a completely new attribute not just a new value for an existing
attribute. If the remove array contained
an empty string for that attribute, the attribute would be tried to be
removed which would fail since it doesn't exist. The following addition of
a new value for that attribute would also fail. Setting the value
for that attribute to e.g. 0 would not even try to remove it and
the addition will work.
</para>
<para>
If you would like to change the attribute 'Name' with the current
value 'books' into 'articles' you will have to create two arrays
and call <function>hw_modifyobject</function>.
<example>
<title>modifying an attribute</title>
<programlisting role="php">
<refentry xml:id="function.hw-modifyobject" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Modifyobject</refname>
<refpurpose>Modifies object record</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_modifyobject</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>object_to_change</parameter></methodparam>
<methodparam><type>array</type><parameter>remove</parameter></methodparam>
<methodparam><type>array</type><parameter>add</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
This command allows to remove, add, or modify individual attributes
of an object record. The object is specified by the Object ID
<parameter>object_to_change</parameter>. The first array
<parameter>remove</parameter> is a list of attributes to remove.
The second array <parameter>add</parameter> is a list of attributes
to add. In order to modify an attribute one will have to remove
the old one and add a new one. <function>hw_modifyobject</function>
will always remove the attributes before it adds attributes unless
the value of the attribute to remove is not a string or array.
</para>
<para>
The last parameter determines if the modification is performed
recursively. 1 means recursive modification. If some of the objects
cannot be modified they will be skipped without notice.
<function>hw_error</function> may not indicate an error though
some of the objects could not be modified.
</para>
<para>
The keys of both arrays are the attributes name. The value of each
array element can either be an array, a string or anything else.
If it is an array
each attribute value is constructed by the key of each element plus
a colon and the value of each element. If it is a string it is taken
as the attribute value. An empty string will result in a complete
removal of that attribute. If the value is neither a string nor an
array but something else, e.g. an integer, no operation at all will
be performed on the attribute. This is necessary if you want to
add a completely new attribute not just a new value for an existing
attribute. If the remove array contained
an empty string for that attribute, the attribute would be tried to be
removed which would fail since it doesn't exist. The following addition of
a new value for that attribute would also fail. Setting the value
for that attribute to e.g. 0 would not even try to remove it and
the addition will work.
</para>
<para>
If you would like to change the attribute 'Name' with the current
value 'books' into 'articles' you will have to create two arrays
and call <function>hw_modifyobject</function>.
<example>
<title>modifying an attribute</title>
<programlisting role="php">
<![CDATA[
<?php
// $connect is an existing connection to the Hyperwave server
@ -68,15 +68,15 @@
$hw_modifyobject($connect, $objid, $remarr, $addarr);
?>
]]>
</programlisting>
</example>
In order to delete/add a name=value pair from/to the object record just
pass the remove/add array and set the last/third parameter to an empty
array. If the attribute is the first one with that name to add, set
attribute value in the remove array to an integer.
<example>
<title>adding a completely new attribute</title>
<programlisting role="php">
</programlisting>
</example>
In order to delete/add a name=value pair from/to the object record just
pass the remove/add array and set the last/third parameter to an empty
array. If the attribute is the first one with that name to add, set
attribute value in the remove array to an integer.
<example>
<title>adding a completely new attribute</title>
<programlisting role="php">
<![CDATA[
<?php
// $connect is an existing connection to the Hyperwave server
@ -86,22 +86,22 @@
$hw_modifyobject($connect, $objid, $remarr, $addarr);
?>
]]>
</programlisting>
</example>
</para>
<para>
<note>
<simpara>
Multilingual attributes, e.g. 'Title', can be modified in two
ways. Either by providing the attributes value in its native
form 'language':'title' or by providing an array with elements
for each language as described above. The above example would
than be:
</simpara>
</note>
<example>
<title>modifying Title attribute</title>
<programlisting role="php">
</programlisting>
</example>
</para>
<para>
<note>
<simpara>
Multilingual attributes, e.g. 'Title', can be modified in two
ways. Either by providing the attributes value in its native
form 'language':'title' or by providing an array with elements
for each language as described above. The above example would
than be:
</simpara>
</note>
<example>
<title>modifying Title attribute</title>
<programlisting role="php">
<![CDATA[
<?php
$remarr = array("Title" => "en:Books");
@ -109,12 +109,12 @@
$hw_modifyobject($connect, $objid, $remarr, $addarr);
?>
]]>
</programlisting>
</example>
or
<example>
<title>modifying Title attribute</title>
<programlisting role="php">
</programlisting>
</example>
or
<example>
<title>modifying Title attribute</title>
<programlisting role="php">
<![CDATA[
<?php
$remarr = array("Title" => array("en" => "Books"));
@ -122,13 +122,13 @@
$hw_modifyobject($connect, $objid, $remarr, $addarr);
?>
]]>
</programlisting>
</example>
This removes the English title 'Books' and adds the English title
'Articles' and the German title 'Artikel'.
<example>
<title>removing attribute</title>
<programlisting role="php">
</programlisting>
</example>
This removes the English title 'Books' and adds the English title
'Articles' and the German title 'Artikel'.
<example>
<title>removing attribute</title>
<programlisting role="php">
<![CDATA[
<?php
$remarr = array("Title" => "");
@ -136,49 +136,49 @@
$hw_modifyobject($connect, $objid, $remarr, $addarr);
?>
]]>
</programlisting>
</example>
<note>
<simpara>
This will remove all attributes with the name 'Title' and adds
a new 'Title' attribute. This comes in handy if you want to
remove attributes recursively.
</simpara>
</note>
<note>
<simpara>
If you need to delete all attributes with a certain name you
will have to pass an empty string as the attribute value.
</simpara>
</note>
<note>
<simpara>
Only the attributes 'Title', 'Description' and 'Keyword' will
properly handle the language prefix. If those attributes don't carry
a language prefix, the prefix 'xx' will be assigned.
</simpara>
</note>
<note>
<simpara>
The 'Name' attribute is somewhat special. In some cases it cannot
be complete removed. You will get an error message 'Change of base
attribute' (not clear when this happens). Therefore you will always
have to add a new Name first and than remove the old one.
</simpara>
</note>
<note>
<simpara>
You may not surround this function by calls to
<function>hw_getandlock</function> and <function>hw_unlock</function>.
<function>hw_modifyobject</function> does this internally.
</simpara>
</note>
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>
</programlisting>
</example>
<note>
<simpara>
This will remove all attributes with the name 'Title' and adds
a new 'Title' attribute. This comes in handy if you want to
remove attributes recursively.
</simpara>
</note>
<note>
<simpara>
If you need to delete all attributes with a certain name you
will have to pass an empty string as the attribute value.
</simpara>
</note>
<note>
<simpara>
Only the attributes 'Title', 'Description' and 'Keyword' will
properly handle the language prefix. If those attributes don't carry
a language prefix, the prefix 'xx' will be assigned.
</simpara>
</note>
<note>
<simpara>
The 'Name' attribute is somewhat special. In some cases it cannot
be complete removed. You will get an error message 'Change of base
attribute' (not clear when this happens). Therefore you will always
have to add a new Name first and than remove the old one.
</simpara>
</note>
<note>
<simpara>
You may not surround this function by calls to
<function>hw_getandlock</function> and <function>hw_unlock</function>.
<function>hw_modifyobject</function> does this internally.
</simpara>
</note>
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

66
reference/hw/functions/hw-mv.xml
View file

@ -1,38 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-mv" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_mv</refname>
<refpurpose>Moves objects</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_mv</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>array</type><parameter>object_id_array</parameter></methodparam>
<methodparam><type>int</type><parameter>source_id</parameter></methodparam>
<methodparam><type>int</type><parameter>destination_id</parameter></methodparam>
</methodsynopsis>
<para>
Moves the objects with object ids as specified in the second
parameter from the collection with id <parameter>source_id</parameter>
to the collection with the id <parameter>destination_id</parameter>.
If the destination id is 0 the objects will
be unlinked from the source collection. If this is the last instance
of that object it will be deleted. If you want to delete all instances
at once, use <function>hw_deleteobject</function>.
</para>
<para>
The value returned is the number of moved objects.
</para>
<para>
See also <function>hw_cp</function>,
and <function>hw_deleteobject</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-mv" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_mv</refname>
<refpurpose>Moves objects</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_mv</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>array</type><parameter>object_id_array</parameter></methodparam>
<methodparam><type>int</type><parameter>source_id</parameter></methodparam>
<methodparam><type>int</type><parameter>destination_id</parameter></methodparam>
</methodsynopsis>
<para>
Moves the objects with object ids as specified in the second
parameter from the collection with id <parameter>source_id</parameter>
to the collection with the id <parameter>destination_id</parameter>.
If the destination id is 0 the objects will
be unlinked from the source collection. If this is the last instance
of that object it will be deleted. If you want to delete all instances
at once, use <function>hw_deleteobject</function>.
</para>
<para>
The value returned is the number of moved objects.
</para>
<para>
See also <function>hw_cp</function>,
and <function>hw_deleteobject</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

62
reference/hw/functions/hw-new-document.xml
View file

@ -1,36 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-new-document" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_New_Document</refname>
<refpurpose>Create new document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_new_document</methodname>
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
<methodparam><type>string</type><parameter>document_data</parameter></methodparam>
<methodparam><type>int</type><parameter>document_size</parameter></methodparam>
</methodsynopsis>
<para>
Returns a new Hyperwave document with document data set to
<parameter>document_data</parameter> and object record set to
<parameter>object_record</parameter>. The length of the
<parameter>document_data</parameter> has to passed in
<parameter>document_size</parameter>This function does not
insert the document into the Hyperwave server.
</para>
<para>
See also <function>hw_free_document</function>,
<function>hw_document_size</function>,
<function>hw_document_bodytag</function>,
<function>hw_output_document</function>,
and <function>hw_insertdocument</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-new-document" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_New_Document</refname>
<refpurpose>Create new document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_new_document</methodname>
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
<methodparam><type>string</type><parameter>document_data</parameter></methodparam>
<methodparam><type>int</type><parameter>document_size</parameter></methodparam>
</methodsynopsis>
<para>
Returns a new Hyperwave document with document data set to
<parameter>document_data</parameter> and object record set to
<parameter>object_record</parameter>. The length of the
<parameter>document_data</parameter> has to passed in
<parameter>document_size</parameter>This function does not
insert the document into the Hyperwave server.
</para>
<para>
See also <function>hw_free_document</function>,
<function>hw_document_size</function>,
<function>hw_document_bodytag</function>,
<function>hw_output_document</function>,
and <function>hw_insertdocument</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

70
reference/hw/functions/hw-objrec2array.xml
View file

@ -1,41 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-objrec2array" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_objrec2array</refname>
<refpurpose>Convert attributes from object record to object array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_objrec2array</methodname>
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>
format
</parameter></methodparam>
</methodsynopsis>
<para>
Converts an <parameter>object_record</parameter> into an object array.
The keys of the resulting array are the attributes names.
Multi-value attributes like 'Title' in different languages form its own
array. The keys of this array are the left part to the colon of the
attribute value. This left part must be two characters long.
Other multi-value attributes without a prefix form an indexed array.
If the optional parameter is missing the
attributes 'Title', 'Description'
and 'Keyword' are treated as language attributes and the attributes
'Group', 'Parent' and 'HtmlAttr' as non-prefixed multi-value attributes.
By passing an array holding the type for each attribute you can
alter this behaviour. The array is an associated array with the attribute
name as its key and the value being one of
<literal>HW_ATTR_LANG</literal> or <literal>HW_ATTR_NONE</literal>.
</para>
<para>
See also <function>hw_array2objrec</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-objrec2array" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_objrec2array</refname>
<refpurpose>Convert attributes from object record to object array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_objrec2array</methodname>
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>
Converts an <parameter>object_record</parameter> into an object array.
The keys of the resulting array are the attributes names.
Multi-value attributes like 'Title' in different languages form its own
array. The keys of this array are the left part to the colon of the
attribute value. This left part must be two characters long.
Other multi-value attributes without a prefix form an indexed array.
If the optional parameter is missing the
attributes 'Title', 'Description'
and 'Keyword' are treated as language attributes and the attributes
'Group', 'Parent' and 'HtmlAttr' as non-prefixed multi-value attributes.
By passing an array holding the type for each attribute you can
alter this behaviour. The array is an associated array with the attribute
name as its key and the value being one of
<literal>HW_ATTR_LANG</literal> or <literal>HW_ATTR_NONE</literal>.
</para>
<para>
See also <function>hw_array2objrec</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

42
reference/hw/functions/hw-output-document.xml
View file

@ -1,26 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-output-document" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Output_Document</refname>
<refpurpose>Prints hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_output_document</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Prints the document without the BODY tag.
</para>
<para>
For backward compatibility, <function>hw_outputdocument</function> is
also accepted. This is deprecated, however.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-output-document" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Output_Document</refname>
<refpurpose>Prints hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_output_document</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Prints the document without the BODY tag.
</para>
<para>
For backward compatibility, <function>hw_outputdocument</function> is
also accepted. This is deprecated, however.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

63
reference/hw/functions/hw-pconnect.xml
View file

@ -1,36 +1,37 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-pconnect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_pConnect</refname>
<refpurpose>Make a persistent database connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_pconnect</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Returns a connection index on success, or &false; if the connection
could not be made. Opens a persistent connection to a Hyperwave
server. Each of the arguments should be a quoted string,
except for the port number. The <parameter>username</parameter>
and <parameter>password</parameter> arguments are
optional and can be left out. In such a case no identification with
the server will be done. It is similar to identify as user anonymous.
This function returns a connection
index that is needed by other Hyperwave functions. You can have
multiple persistent connections open at once.</para>
<para>
See also <function>hw_connect</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-pconnect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_pConnect</refname>
<refpurpose>Make a persistent database connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_pconnect</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Returns a connection index on success, or &false; if the connection
could not be made. Opens a persistent connection to a Hyperwave
server. Each of the arguments should be a quoted string,
except for the port number. The <parameter>username</parameter>
and <parameter>password</parameter> arguments are
optional and can be left out. In such a case no identification with
the server will be done. It is similar to identify as user anonymous.
This function returns a connection
index that is needed by other Hyperwave functions. You can have
multiple persistent connections open at once.
</para>
<para>
See also <function>hw_connect</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

59
reference/hw/functions/hw-pipedocument.xml
View file

@ -1,34 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-pipedocument" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_PipeDocument</refname>
<refpurpose>Retrieve any document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_pipedocument</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>url_prefixes</parameter></methodparam>
</methodsynopsis>
<para>
Returns the Hyperwave document with object ID
<parameter>objectID</parameter>. If the document
has anchors which can be inserted, they will have been inserted already.
The document will be transferred via a special data connection which
does not block the control connection.</para>
<para>
See also <function>hw_gettext</function> for more on link insertion,
<function>hw_free_document</function>,
<function>hw_document_size</function>,
<function>hw_document_bodytag</function>,
and <function>hw_output_document</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-pipedocument" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_PipeDocument</refname>
<refpurpose>Retrieve any document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_pipedocument</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>url_prefixes</parameter></methodparam>
</methodsynopsis>
<para>
Returns the Hyperwave document with object ID
<parameter>objectID</parameter>. If the document
has anchors which can be inserted, they will have been inserted already.
The document will be transferred via a special data connection which
does not block the control connection.
</para>
<para>
See also <function>hw_gettext</function> for more on link insertion,
<function>hw_free_document</function>,
<function>hw_document_size</function>,
<function>hw_document_bodytag</function>,
and <function>hw_output_document</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/hw/functions/hw-root.xml
View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-root" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Root</refname>
<refpurpose>Root object id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_root</methodname>
<methodparam><parameter/></methodparam>
</methodsynopsis>
<para>
Returns the object ID of the hyperroot collection. Currently this
is always 0. The child collection of the hyperroot is the root
collection of the connected server.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-root" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Root</refname>
<refpurpose>Root object id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_root</methodname>
<methodparam><parameter/></methodparam>
</methodsynopsis>
<para>
Returns the object ID of the hyperroot collection. Currently this
is always 0. The child collection of the hyperroot is the root
collection of the connected server.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/hw/functions/hw-setlinkroot.xml
View file

@ -1,25 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<refentry xml:id='function.hw-setlinkroot' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_setlinkroot</refname>
<refpurpose>
Set the id to which links are calculated
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_setlinkroot</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>rootid</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry xml:id='function.hw-setlinkroot' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_setlinkroot</refname>
<refpurpose>Set the id to which links are calculated</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>hw_setlinkroot</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>rootid</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

36
reference/hw/functions/hw-stat.xml
View file

@ -1,24 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<refentry xml:id='function.hw-stat' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_stat</refname>
<refpurpose>
Returns status string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_stat</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry xml:id='function.hw-stat' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_stat</refname>
<refpurpose>Returns status string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_stat</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

42
reference/hw/functions/hw-unlock.xml
View file

@ -1,26 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-unlock" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Unlock</refname>
<refpurpose>Unlock object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_unlock</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Unlocks a document, so other users regain access.
</para>
<para>
See also <function>hw_getandlock</function>.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-unlock" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Unlock</refname>
<refpurpose>Unlock object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>hw_unlock</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Unlocks a document, so other users regain access.
</para>
<para>
See also <function>hw_getandlock</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

40
reference/hw/functions/hw-who.xml
View file

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry xml:id="function.hw-who" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Who</refname>
<refpurpose>List of currently logged in users</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_who</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of users currently logged into the Hyperwave server.
Each entry in this array is an array itself containing the elements id,
name, system, onSinceDate, onSinceTime, TotalTime and self. 'self'
is 1 if this entry belongs to the user who initiated the request.
</para>
</refsect1>
</refentry>
<refentry xml:id="function.hw-who" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Who</refname>
<refpurpose>List of currently logged in users</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_who</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of users currently logged into the Hyperwave server.
Each entry in this array is an array itself containing the elements id,
name, system, onSinceDate, onSinceTime, TotalTime and self. 'self'
is 1 if this entry belongs to the user who initiated the request.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: