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

Switch to new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249567 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-12-31 15:15:32 +00:00
parent 32f579f335
commit 3287c151b3
51 changed files with 2639 additions and 829 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

116
reference/com/functions/com-event-sink.xml
View file

@ -1,62 +1,95 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.com-event-sink" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>com_event_sink</refname>
<refpurpose>Connect events from a COM object to a PHP object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>com_event_sink</methodname>
<methodparam><type>variant</type><parameter>comobject</parameter></methodparam>
<methodparam><type>object</type><parameter>sinkobject</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>sinkinterface</parameter></methodparam>
</methodsynopsis>
<para>
Instructs COM to sink events generated by
<parameter>comobject</parameter> into the PHP object
<parameter>sinkobject</parameter>. PHP will attempt to use the default
dispinterface type specified by the typelibrary associated with
<parameter>comobject</parameter>, but you may override this choice by
setting <parameter>sinkinterface</parameter> to the name of the
dispinterface that you want to use.
<parameter>sinkobject</parameter>.
</para>
<para>
<parameter>sinkobject</parameter> should be an instance of a class with
methods named after those of the desired dispinterface; you may use
<function>com_print_typeinfo</function> to help generate a template class
for this purpose.
</para>
<para>
Be careful how you use this feature; if you are doing something similar
to the example below, then it doesn't really make sense to run it in a
web server context.
</para>
<example>
<title>COM event sink example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>comobject</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sinkobject</parameter></term>
<listitem>
<para>
<parameter>sinkobject</parameter> should be an instance of a class with
methods named after those of the desired dispinterface; you may use
<function>com_print_typeinfo</function> to help generate a template class
for this purpose.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sinkinterface</parameter></term>
<listitem>
<para>
PHP will attempt to use the default dispinterface type specified by
the typelibrary associated with <parameter>comobject</parameter>, but
you may override this choice by setting
<parameter>sinkinterface</parameter> to the name of the dispinterface
that you want to use.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>COM event sink example</title>
<programlisting role="php">
<![CDATA[
<?php
class IEEventSinker {
var $terminated = false;
var $terminated = false;
function ProgressChange($progress, $progressmax) {
echo "Download progress: $progress / $progressmax\n";
}
function ProgressChange($progress, $progressmax) {
echo "Download progress: $progress / $progressmax\n";
}
function DocumentComplete(&$dom, $url) {
echo "Document $url complete\n";
}
function DocumentComplete(&$dom, $url) {
echo "Document $url complete\n";
}
function OnQuit() {
echo "Quit!\n";
$this->terminated = true;
}
function OnQuit() {
echo "Quit!\n";
$this->terminated = true;
}
}
$ie = new COM("InternetExplorer.Application");
// note that you don't need the & for PHP 5!
@ -70,15 +103,18 @@ while(!$sink->terminated) {
$ie = null;
?>
]]>
</programlisting>
</example>
<para>
See also <function>com_print_typeinfo</function>,
<function>com_message_pump</function>.
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>com_print_typeinfo</function></member>
<member><function>com_message_pump</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

62
reference/com/functions/com-get-active-object.xml
View file

@ -1,18 +1,17 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.com-get-active-object" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>com_get_active_object</refname>
<refpurpose>Returns a handle to an already running instance of a COM object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>variant</type><methodname>com_get_active_object</methodname>
<methodparam><type>string</type><parameter>progid</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>code_page</parameter></methodparam>
</methodsynopsis>
<para>
<function>com_get_active_object</function> is similar to creating a new
instance of a <xref linkend="class.com"/> object, except that it will
@ -22,24 +21,52 @@
exposes the COM library function GetActiveObject() to get a handle on a
running instance.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<parameter>progid</parameter> must be either the ProgID or CLSID for the
object that you want to access (for example
<literal>Word.Application</literal>). <parameter>code_page</parameter>
acts in precisely the same way that it does for the <xref
linkend="class.com"/> class.
<variablelist>
<varlistentry>
<term><parameter>progid</parameter></term>
<listitem>
<para>
<parameter>progid</parameter> must be either the ProgID or CLSID for
the object that you want to access (for example
<literal>Word.Application</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>code_page</parameter></term>
<listitem>
<para>
Acts in precisely the same way that it does for the <xref
linkend="class.com"/> class.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If the requested object is running, it will be returned to your script
just like any other COM object. Otherwise a <literal>com_exception</literal>
will be raised. There are a variety of reasons why
this function might fail, the most common being that the object is not
already running. In that situation, the exception error code will be
<constant>MK_E_UNAVAILABLE</constant>; you can use the
<literal>getCode</literal> method of the exception object to check the
exception code.
just like any other COM object.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
There are a variety of reasons why this function might fail, the most
common being that the object is not already running. In that situation,
the exception error code will be <constant>MK_E_UNAVAILABLE</constant>;
you can use the <literal>getCode</literal> method of the exception object
to check the exception code.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<para>
Using <function>com_get_active_object</function> in a web server context
@ -51,7 +78,6 @@
involved.
</para>
</warning>
</refsect1>
</refentry>

110
reference/com/functions/com-load-typelib.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/com.xml, last change in rev 1.27 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id='function.com-load-typelib' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>com_load_typelib</refname>
<refpurpose>Loads a Typelib</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>com_load_typelib</methodname>
<methodparam><type>string</type><parameter>typelib_name</parameter></methodparam>
@ -15,55 +14,74 @@
</methodsynopsis>
<para>
Loads a type-library and registers its constants in the engine, as though
they were defined using <function>define</function>. The
<parameter>case_insensitive</parameter> behaves in the same way as the
parameter with the same name in the <function>define</function> function.
they were defined using <function>define</function>.
</para>
<para>
<parameter>typelib_name</parameter> can be one of the following:
<itemizedlist>
<listitem>
<para>
The filename of a <literal>.tlb</literal> file or the executable module
that contains the type library.
</para>
</listitem>
<listitem>
<para>
The type library GUID, followed by its version number, for example
<literal>{00000200-0000-0010-8000-00AA006D2EA4},2,0</literal>.
</para>
</listitem>
<listitem>
<para>
The type library name, e.g. <literal>Microsoft OLE DB ActiveX Data
Objects 1.0 Library</literal>.
</para>
</listitem>
</itemizedlist>
PHP will attempt to resolve the type library in this order, as the
process gets more and more expensive as you progress down the list;
searching for the type library by name is handled by physically
enumerating the registry until we find a match.
Note that it is much more efficient to use the <xref
linkend="ini.com.typelib-file"/> configuration setting to pre-load and
register the constants, although not so flexible.
</para>
<para>
Note that it is much more efficient to use the
<xref linkend="ini.com.typelib-file"/>
configuration setting to pre-load and register the constants,
although not so flexible.
If you have turned on <xref linkend="ini.com.autoregister-typelib"/>, then
PHP will attempt to automatically register the constants associated with a
COM object when you instantiate it. This depends on the interfaces
provided by the COM object itself, and may not always be possible.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
If you have turned on <xref
linkend="ini.com.autoregister-typelib"/>,
then PHP will attempt to automatically register the constants associated
with a COM object when you instantiate it. This depends on the
interfaces provided by the COM object itself, and may not always be
possible.
<variablelist>
<varlistentry>
<term><parameter>typelib_name</parameter></term>
<listitem>
<para>
<parameter>typelib_name</parameter> can be one of the following:
<itemizedlist>
<listitem>
<para>
The filename of a <literal>.tlb</literal> file or the executable module
that contains the type library.
</para>
</listitem>
<listitem>
<para>
The type library GUID, followed by its version number, for example
<literal>{00000200-0000-0010-8000-00AA006D2EA4},2,0</literal>.
</para>
</listitem>
<listitem>
<para>
The type library name, e.g. <literal>Microsoft OLE DB ActiveX Data
Objects 1.0 Library</literal>.
</para>
</listitem>
</itemizedlist>
PHP will attempt to resolve the type library in this order, as the
process gets more and more expensive as you progress down the list;
searching for the type library by name is handled by physically
enumerating the registry until we find a match.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>case_insensitive</parameter></term>
<listitem>
<para>
The <parameter>case_insensitive</parameter> behaves in the same way as
the parameter with the same name in the <function>define</function>
function.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>

49
reference/com/functions/com-message-pump.xml
View file

@ -1,30 +1,20 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.com-message-pump" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>com_message_pump</refname>
<refpurpose>Process COM messages, sleeping for up to timeoutms milliseconds</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>com_message_pump</methodname>
<methodparam choice="opt"><type>int</type><parameter>timeoutms</parameter></methodparam>
</methodsynopsis>
<para>
This function will sleep for up to <parameter>timeoutms</parameter>
milliseconds, or until a message arrives in the queue. If a message or
messages arrives before the timeout, they will be dispatched, and the
function will return &true;. If the timeout occurs and no messages were
processed, the return value will be &false;. If you do not specify a
value for <parameter>timeoutms</parameter>, then 0 will be assumed. A 0
value means that no waiting will be performed; if there are messages
pending they will be dispatched as before; if there are no messages
pending, the function will return &false; immediately without sleeping.
milliseconds, or until a message arrives in the queue.
</para>
<para>
The purpose of this function is to route COM calls between apartments and
handle various synchronization issues. This allows your script to wait
@ -33,7 +23,36 @@
demonstrated by the example in the <function>com_event_sink</function>
function, until you are finished using event bound COM objects.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>timeoutms</parameter></term>
<listitem>
<para>
The timeout, in milliseconds.
</para>
<para>
If you do not specify a value for <parameter>timeoutms</parameter>,
then 0 will be assumed. A 0 value means that no waiting will be
performed; if there are messages pending they will be dispatched as
before; if there are no messages pending, the function will return
&false; immediately without sleeping.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If a message or messages arrives before the timeout, they will be
dispatched, and the function will return &true;. If the timeout occurs and
no messages were processed, the return value will be &false;.
</para>
</refsect1>
</refentry>

71
reference/com/functions/com-print-typeinfo.xml
View file

@ -1,44 +1,73 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.com-print-typeinfo" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>com_print_typeinfo</refname>
<refpurpose>Print out a PHP class definition for a dispatchable interface</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>com_print_typeinfo</methodname>
<methodparam><type>object</type><parameter>comobject</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>dispinterface</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>wantsink</parameter></methodparam>
</methodsynopsis>
<para>
The purpose of this function is to help generate a skeleton class for use
as an event sink. You may also use it to generate a dump of any COM
object, provided that it supports enough of the introspection
interfaces, and that you know the name of the interface you want to
display.
object, provided that it supports enough of the introspection interfaces,
and that you know the name of the interface you want to display.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<parameter>comobject</parameter> should be either an instance of a COM
object, or be the name of a typelibrary (which will be resolved according
to the rules set out in <function>com_load_typelib</function>).
<parameter>dispinterface</parameter> is the name of an IDispatch
descendant interface that you want to display. If
<parameter>wantsink</parameter> is &true;, the corresponding sink
interface will be displayed instead.
<variablelist>
<varlistentry>
<term><parameter>comobject</parameter></term>
<listitem>
<para>
<parameter>comobject</parameter> should be either an instance of a COM
object, or be the name of a typelibrary (which will be resolved according
to the rules set out in <function>com_load_typelib</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dispinterface</parameter></term>
<listitem>
<para>
The name of an IDispatch descendant interface that you want to display.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>wantsink</parameter></term>
<listitem>
<para>
If set to &true;, the corresponding sink interface will be displayed
instead.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also <function>com_event_sink</function>,
<function>com_load_typelib</function>.
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>com_event_sink</function></member>
<member><function>com_load_typelib</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

54
reference/com/functions/variant-add.xml
View file

@ -1,24 +1,21 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-add" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_add</refname>
<refpurpose>"Adds" two variant values together and returns the result</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_add</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Adds <parameter>left</parameter> to <parameter>right</parameter> using
the following rules (taken from the MSDN library), which correspond to
those of Visual Basic:
<table>
<title>Variant Addition Rules</title>
<tgroup cols="2">
@ -58,13 +55,44 @@
</tgroup>
</table>
</para>
<para>
See also <function>variant_sub</function>.
</para>
&com.variant-arith;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
&com.variant-arith;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the result.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>variant_sub</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

97
reference/com/functions/variant-and.xml
View file

@ -1,52 +1,81 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-and" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_and</refname>
<refpurpose>performs a bitwise AND operation between two variants and returns the result</refpurpose>
<refpurpose>Performs a bitwise AND operation between two variants</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_and</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Performs a bitwise AND operation, according to the following truth table;
note that this is slightly different from a regular AND operation.
Performs a bitwise AND operation.
Note that this is slightly different from a regular AND operation.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
&com.variant-arith;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<table>
<title>Variant AND Rules</title>
<tgroup cols="3">
<thead>
<row>
<entry>If <parameter>left</parameter> is</entry>
<entry>If <parameter>right</parameter> is</entry>
<entry>then the result is</entry>
</row>
</thead>
<tbody>
<row><entry>&true;</entry><entry>&true;</entry><entry>&true;</entry></row>
<row><entry>&true;</entry><entry>&false;</entry><entry>&false;</entry></row>
<row><entry>&true;</entry><entry>&null;</entry><entry>&null;</entry></row>
<row><entry>&false;</entry><entry>&true;</entry><entry>&false;</entry></row>
<row><entry>&false;</entry><entry>&false;</entry><entry>&false;</entry></row>
<row><entry>&false;</entry><entry>&null;</entry><entry>&false;</entry></row>
<row><entry>&null;</entry><entry>&true;</entry><entry>&null;</entry></row>
<row><entry>&null;</entry><entry>&false;</entry><entry>&false;</entry></row>
<row><entry>&null;</entry><entry>&null;</entry><entry>&null;</entry></row>
</tbody>
</tgroup>
</table>
</para>
<para>
See also <function>variant_or</function>.
<thead>
<row>
<entry>If <parameter>left</parameter> is</entry>
<entry>If <parameter>right</parameter> is</entry>
<entry>then the result is</entry>
</row>
</thead>
<tbody>
<row><entry>&true;</entry><entry>&true;</entry><entry>&true;</entry></row>
<row><entry>&true;</entry><entry>&false;</entry><entry>&false;</entry></row>
<row><entry>&true;</entry><entry>&null;</entry><entry>&null;</entry></row>
<row><entry>&false;</entry><entry>&true;</entry><entry>&false;</entry></row>
<row><entry>&false;</entry><entry>&false;</entry><entry>&false;</entry></row>
<row><entry>&false;</entry><entry>&null;</entry><entry>&false;</entry></row>
<row><entry>&null;</entry><entry>&true;</entry><entry>&null;</entry></row>
<row><entry>&null;</entry><entry>&false;</entry><entry>&false;</entry></row>
<row><entry>&null;</entry><entry>&null;</entry><entry>&null;</entry></row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>variant_or</function></member>
</simplelist>
</para>
&com.variant-arith;
</refsect1>
</refentry>

51
reference/com/functions/variant-div.xml
View file

@ -1,23 +1,49 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-div" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_div</refname>
<refpurpose>Returns the result from dividing two variants</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_div</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Divides <parameter>left</parameter> by <parameter>right</parameter> and
returns the result, subject to the following rules:
returns the result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
&com.variant-arith;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<table>
<title>Variant Division Rules</title>
<tgroup cols="2">
@ -69,9 +95,14 @@
</tgroup>
</table>
</para>
&com.variant-arith;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>variant_idiv</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

34
reference/com/functions/variant-get-type.xml
View file

@ -1,23 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.variant-get-type" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_get_type</refname>
<refpurpose>Returns the type of a variant object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>variant_get_type</methodname>
<methodparam><type>variant</type><parameter>variant</parameter></methodparam>
</methodsynopsis>
<para>
Returns the type of a variant object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>variant</parameter></term>
<listitem>
<para>
The variant object.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function returns an integer value that indicates the type of
<parameter>variant</parameter>, which can be an instance of
<xref linkend="class.com"/>,
<xref linkend="class.dotnet"/> or
<xref linkend="class.variant"/> classes. The return value
can be compared to one of the <constant>VT_XXX</constant> constants.
<xref linkend="class.com"/>, <xref linkend="class.dotnet"/> or
<xref linkend="class.variant"/> classes. The return value can be compared
to one of the <constant>VT_XXX</constant> constants.
</para>
<para>
The return value for COM and DOTNET objects will usually be

130
reference/com/functions/variant-idiv.xml
View file

@ -1,69 +1,97 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-idiv" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_idiv</refname>
<refpurpose>Converts variants to integers and then returns the result from dividing them</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_idiv</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Converts <parameter>left</parameter> and <parameter>right</parameter> to
integer values, and then performs integer division according the
following rules:
<table>
integer values, and then performs integer division.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
&com.variant-arith;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<table>
<title>Variant Integer Division Rules</title>
<tgroup cols="2">
<thead>
<row>
<entry>If</entry>
<entry>Then</entry>
</row>
</thead>
<tbody>
<row>
<entry>Both expressions are of the string, date, character, boolean type</entry>
<entry>Division and integer is returned</entry>
</row>
<row>
<entry>One expression is a string type and the other a
character</entry>
<entry>Division</entry>
</row>
<row>
<entry>One expression is numeric and the other is a string</entry>
<entry>Division</entry>
</row>
<row>
<entry>Both expressions are numeric</entry>
<entry>Division</entry>
</row>
<row>
<entry>Either expression is NULL</entry>
<entry>NULL is returned</entry>
</row>
<row>
<entry>Both expressions are empty</entry>
<entry>A com_exception with code <constant>DISP_E_DIVBYZERO</constant>
is thrown</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
See also <function>variant_div</function>.
</para>
&com.variant-arith;
<thead>
<row>
<entry>If</entry>
<entry>Then</entry>
</row>
</thead>
<tbody>
<row>
<entry>Both expressions are of the string, date, character, boolean type</entry>
<entry>Division and integer is returned</entry>
</row>
<row>
<entry>One expression is a string type and the other a
character</entry>
<entry>Division</entry>
</row>
<row>
<entry>One expression is numeric and the other is a string</entry>
<entry>Division</entry>
</row>
<row>
<entry>Both expressions are numeric</entry>
<entry>Division</entry>
</row>
<row>
<entry>Either expression is NULL</entry>
<entry>NULL is returned</entry>
</row>
<row>
<entry>Both expressions are empty</entry>
<entry>A com_exception with code <constant>DISP_E_DIVBYZERO</constant>
is thrown</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>variant_div</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

43
reference/com/functions/variant-imp.xml
View file

@ -1,21 +1,48 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-imp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_imp</refname>
<refpurpose>Performs a bitwise implication on two variants</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_imp</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Performs a bitwise implication operation, according to the following truth table:
Performs a bitwise implication operation.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
&com.variant-arith;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<table>
<title>Variant Implication Table</title>
<tgroup cols="3">
@ -39,9 +66,7 @@
</tbody>
</tgroup>
</table>
</para>
&com.variant-arith;
</para>
</refsect1>
</refentry>

60
reference/com/functions/variant-mul.xml
View file

@ -1,23 +1,49 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-mul" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_mul</refname>
<refpurpose>multiplies the values of the two variants and returns the result</refpurpose>
<refpurpose>Multiplies the values of the two variants</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_mul</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Multiplies <parameter>left</parameter> by <parameter>right</parameter> and
returns the result, subject to the following rules:
Multiplies <parameter>left</parameter> by <parameter>right</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
Boolean values are converted to -1 for &false; and 0 for &true;.
&com.variant-arith;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<table>
<title>Variant Multiplication Rules</title>
<tgroup cols="2">
@ -57,17 +83,15 @@
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
Boolean values are converted to -1 for &false; and 0 for &true;.
<simplelist>
<member><function>variant_div</function></member>
<member><function>variant_idiv</function></member>
</simplelist>
</para>
<para>
See also <function>variant_div</function>,
<function>variant_idiv</function>.
</para>
&com.variant-arith;
</refsect1>
</refentry>

50
reference/com/functions/variant-or.xml
View file

@ -1,21 +1,49 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-or" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_or</refname>
<refpurpose>Performs a logical disjunction on two variants</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_or</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Performs a bitwise OR operation, according to the following truth table;
note that this is slightly different from a regular OR operation.
Performs a bitwise OR operation.
Note that this is slightly different from a regular OR operation.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
&com.variant-arith;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<table>
<title>Variant OR Rules</title>
<tgroup cols="3">
@ -40,11 +68,15 @@
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>variant_and</function>,
<function>variant_xor</function>.
<simplelist>
<member><function>variant_and</function></member>
<member><function>variant_xor</function></member>
</simplelist>
</para>
&com.variant-arith;
</refsect1>
</refentry>

53
reference/com/functions/variant-sub.xml
View file

@ -1,23 +1,48 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-sub" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_sub</refname>
<refpurpose>subtracts the value of the right variant from the left variant value and returns the result</refpurpose>
<refpurpose>Subtracts the value of the right variant from the left variant value</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_sub</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Subtracts <parameter>right</parameter> from <parameter>left</parameter> using
the following rules:
Subtracts <parameter>right</parameter> from <parameter>left</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
&com.variant-arith;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<table>
<title>Variant Subtraction Rules</title>
<tgroup cols="2">
@ -57,12 +82,14 @@
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>variant_add</function>.
<simplelist>
<member><function>variant_add</function></member>
</simplelist>
</para>
&com.variant-arith;
</refsect1>
</refentry>

50
reference/com/functions/variant-xor.xml
View file

@ -1,21 +1,48 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-xor" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_xor</refname>
<refpurpose>Performs a logical exclusion on two variants</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_xor</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Performs a logical exclusion, according to the following truth table:
Performs a logical exclusion.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
&com.variant-arith;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<table>
<title>Variant XOR Rules</title>
<tgroup cols="3">
@ -36,12 +63,15 @@
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>variant_and</function>,
<function>variant_or</function>.
<simplelist>
<member><function>variant_or</function></member>
<member><function>variant_and</function></member>
</simplelist>
</para>
&com.variant-arith;
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_document_bodytag</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
@ -17,15 +16,48 @@
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>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hw_document</parameter></term>
<listitem>
<para>
The document identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>prefix</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the BODY tag as a string.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_document_attributes</function></member>
<member><function>hw_document_size</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>hw_document_setcontent</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
@ -22,10 +21,43 @@
the document is inserted. Probably not a very good idea.
If this functions fails the document will retain its old content.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_document_attributes</function>,
<function>hw_document_size</function>,
and <function>hw_document_content</function>.
<variablelist>
<varlistentry>
<term><parameter>hw_document</parameter></term>
<listitem>
<para>
The document identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_document_attributes</function></member>
<member><function>hw_document_size</function></member>
<member><function>hw_document_content</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,33 +1,67 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<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.
Uploads the text document to the server. The object record of the document
may not be modified while the document is edited.
</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>.
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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hw_document</parameter></term>
<listitem>
<para>
The document identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_pipedocument</function></member>
<member><function>hw_free_document</function></member>
<member><function>hw_document_bodytag</function></member>
<member><function>hw_document_size</function></member>
<member><function>hw_output_document</function></member>
<member><function>hw_gettext</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,21 +1,50 @@
<?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-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>
<refsect1 role="description">
&reftitle.description;
<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>.
Returns records with anchors of the document with object ID
<parameter>objectID</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of object records.
</para>
</refsect1>
</refentry>

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

@ -1,27 +1,59 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<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
Returns 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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_children</function>,
and <function>hw_getchilddoccoll</function>.
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of object ids.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_children</function></member>
<member><function>hw_getchilddoccoll</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,27 +1,59 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<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.
Returns 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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_childrenobj</function>,
and <function>hw_getchilddoccollobj</function>.
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of object records.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_childrenobj</function></member>
<member><function>hw_getchilddoccollobj</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_getchilddoccoll</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -16,9 +15,43 @@
<para>
Returns array of object ids for child documents of a collection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_children</function>,
and <function>hw_getchildcoll</function>.
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of object ids.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_children</function></member>
<member><function>hw_getchildcoll</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_getchilddoccollobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -16,9 +15,43 @@
<para>
Returns an array of object records for child documents of a collection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_childrenobj</function>,
and <function>hw_getchildcollobj</function>.
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of object records.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_childrenobj</function></member>
<member><function>hw_getchildcollobj</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.11 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>hw_getobject</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -15,37 +14,81 @@
<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.
Gets an object record.
If the second parameter is an array of integer the function will
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier, or an array of identifiers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The query string has the following syntax:
<screen>
<![CDATA[
<expr> ::= "(" <expr> ")" |
"!" &lt;expr> | /* NOT */
<expr> "||" <expr> | /* OR */
<expr> "&amp;&amp;" <expr> | /* AND */
<attribute> <operator> <value>
<attribute> ::= /* any attribute name (Title, Author, DocumentType ...) */
<operator> ::= "=" | /* equal */
"<" | /* less than (string compare) */
">" | /* greater than (string compare) */
"~" /* regular expression matching */
]]>
</screen>
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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the object record for the given object ID if the second parameter
is an integer.
</para>
<para>
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>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<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;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>.
<simplelist>
<member><function>hw_getandlock</function></member>
<member><function>hw_getobjectbyquery</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyquery</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -16,15 +15,54 @@
</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.
object ids.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
The query will only work with indexed attributes.
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The query will only work with indexed attributes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>max_hits</parameter></term>
<listitem>
<para>
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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also <function>hw_getobjectbyqueryobj</function>.
Returns an array of object ids.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_getobjectbyqueryobj</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyquerycoll</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -16,17 +15,63 @@
<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.
Searches for objects in collection with ID <parameter>objectID</parameter>
and returns an array of object ids.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
The query will only work with indexed attributes.</para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The collection id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The query will only work with indexed attributes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>max_hits</parameter></term>
<listitem>
<para>
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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also <function>hw_getobjectbyquerycollobj</function>.
Returns an array of object ids.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_getobjectbyquerycollobj</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyquerycollobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -16,18 +15,63 @@
<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.
Searches for objects in collection with ID <parameter>objectID</parameter>
and returns an array of object records.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
The query will only work with indexed attributes.
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The collection id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The query will only work with indexed attributes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>max_hits</parameter></term>
<listitem>
<para>
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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also <function>hw_getobjectbyquerycoll</function>.
Returns an array of object records.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_getobjectbyquerycoll</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_getobjectbyqueryobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -16,17 +15,57 @@
</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>.
object records.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The query will only work with indexed attributes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>max_hits</parameter></term>
<listitem>
<para>
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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of object records.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_getobjectbyquery</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

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

@ -1,23 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<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>.
Returns object records and statistical information about the object
records. Each object record belongs to a parent of the object with ID
<parameter>objectID</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<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.
</para>
</refsect1>
</refentry>

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

@ -1,34 +1,74 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<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.
Gets a remote document.
</para>
<para>
Remote documents in Hyperwave notation are documents retrieved from an
external source. Common remote documents are for example external web
pages or queries in a database.
</para>
<para>
In order to be able to access external sources through remote documents
Hyperwave introduces the HGI (Hyperwave Gateway Interface) which is
similar to the CGI. Currently, only ftp, http-servers and some databases
can be accessed by the HGI.
</para>
<para>
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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_getremotechildren</function>.
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a remote document.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_getremotechildren</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,40 +1,71 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.9 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<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.
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.
</para>
<para>
See also <function>hw_getremote</function>.
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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object_record</parameter></term>
<listitem>
<para>
The object record.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
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.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_getremote</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,25 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.5 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<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.
Gets the object records of all anchors pointing to the object with ID
<parameter>objectID</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_getanchors</function>.
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier. The object can either be a document or an
anchor of type destination.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of object records.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_getanchors</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_identify</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
@ -16,13 +15,49 @@
</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.
<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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_connect</function>.
<variablelist>
<varlistentry>
<term><parameter>link</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The username.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>hw_insertanchors</methodname>
<methodparam><type>int</type><parameter>hwdoc</parameter></methodparam>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>hw_insertdocument</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -15,17 +14,58 @@
<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;.
Uploads a document into the given collection.
</para>
<para>
See also <function>hw_pipedocument</function>.
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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parent_id</parameter></term>
<listitem>
<para>
The collection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hw_document</parameter></term>
<listitem>
<para>
The document identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The functions returns the object id of the new document or &false;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_pipedocument</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>hw_insertobject</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -15,21 +14,56 @@
<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.
Inserts an object into the server.
</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.
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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_pipedocument</function>,
<function>hw_insertdocument</function>,
<function>hw_insdoc</function>,
and <function>hw_inscoll</function>.
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object_rec</parameter></term>
<listitem>
<para>
The object can be any valid hyperwave object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parameter</parameter></term>
<listitem>
<para>
See the HG-CSP documentation for a detailed information on how the
parameters have to be.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_pipedocument</function></member>
<member><function>hw_insertdocument</function></member>
<member><function>hw_insdoc</function></member>
<member><function>hw_inscoll</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>hw_mapid</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -15,19 +14,55 @@
<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.
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.
</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
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>.
</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>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>server_id</parameter></term>
<listitem>
<para>
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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object_id</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the virtual object id.
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.11 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>hw_modifyobject</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -19,21 +18,12 @@
<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
<parameter>object_to_change</parameter>.
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.
@ -174,6 +164,60 @@
</simpara>
</note>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object_to_change</parameter></term>
<listitem>
<para>
The object to be changed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>remove</parameter></term>
<listitem>
<para>
An array of attributes to remove.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>add</parameter></term>
<listitem>
<para>
An array of attributes to add.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>hw_new_document</methodname>
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
@ -15,19 +14,61 @@
<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.
Returns a new Hyperwave document with the given document data and object
record.
</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>.
This function does not insert the document into the Hyperwave server.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>object_record</parameter></term>
<listitem>
<para>
The object record.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>document_data</parameter></term>
<listitem>
<para>
The document data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>document_size</parameter></term>
<listitem>
<para>
The document size. Must be the length of
<parameter>document_data</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the new Hyperwave document.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_free_document</function></member>
<member><function>hw_document_size</function></member>
<member><function>hw_document_bodytag</function></member>
<member><function>hw_output_document</function></member>
<member><function>hw_insertdocument</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_objrec2array</methodname>
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
@ -15,22 +14,56 @@
</methodsynopsis>
<para>
Converts an <parameter>object_record</parameter> into an object array.
The keys of the resulting array are the attributes names.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>object_record</parameter></term>
<listitem>
<para>
The object record.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
An associative 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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an 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'
</para>
<para>
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>.
alter this behaviour.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>hw_array2objrec</function>.
<simplelist>
<member><function>hw_array2objrec</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>hw_pconnect</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
@ -16,19 +15,64 @@
<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.
Opens a persistent connection to a Hyperwave server.
You can have multiple persistent connections open at once.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_connect</function>.
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
<para>
The server host name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
The server port number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The Hyperwave user name. If ommited, no identification with the server
will be done. It is similar to identify as user anonymous.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password for <parameter>username</parameter>.
Keep in mind, that the password is not encrypted.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a connection index on success, or &false; if the connection could
not be made.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

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

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>hw_pipedocument</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -15,18 +14,60 @@
<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.
Gets the Hyperwave document with the given object ID. If the document has
anchors which can be inserted, they will have been inserted already.
</para>
<para>
The document will be transferred via a special data connection which
does not block the control connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<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>.
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>url_prefixes</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the Hyperwave document.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_gettext</function></member>
<member><function>hw_free_document</function></member>
<member><function>hw_document_size</function></member>
<member><function>hw_document_bodytag</function></member>
<member><function>hw_output_document</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

71
reference/mcal/functions/mcal-date-compare.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.mcal-date-compare" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_date_compare</refname>
<refpurpose>Compares two dates</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mcal_date_compare</methodname>
<methodparam><type>int</type><parameter>a_year</parameter></methodparam>
@ -18,8 +17,68 @@
<methodparam><type>int</type><parameter>b_day</parameter></methodparam>
</methodsynopsis>
<para>
<function>mcal_date_compare</function> Compares the two given
dates, returns &lt;0, 0, >0 if a&lt;b, a==b, a>b respectively.
Compares the two given dates.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>a_year</parameter></term>
<listitem>
<para>
Year part of the first date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>a_month</parameter></term>
<listitem>
<para>
Month part of the first date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>a_day</parameter></term>
<listitem>
<para>
Day part of the first date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>b_year</parameter></term>
<listitem>
<para>
Year part of the second date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>b_month</parameter></term>
<listitem>
<para>
Month part of the second date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>b_day</parameter></term>
<listitem>
<para>
Day part of the second date.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &lt;0, 0, >0 if a&lt;b, a==b, a>b respectively.
</para>
</refsect1>
</refentry>

224
reference/mcal/functions/mcal-fetch-event.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-fetch-event" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_fetch_event</refname>
<refpurpose>Fetches an event from the calendar stream</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>object</type><methodname>mcal_fetch_event</methodname>
<methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
@ -18,72 +17,175 @@
<function>mcal_fetch_event</function> fetches an event from the
calendar stream specified by <parameter>id</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mcal_stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_id</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an event object consisting of:
<itemizedlist>
<listitem><simpara>
int id - ID of that event.</simpara></listitem>
<listitem><simpara>
int public - &true; if the event if public, &false; if it is
private.</simpara></listitem>
<listitem><simpara>
string category - Category string of the event.</simpara></listitem>
<listitem><simpara>
string title - Title string of the event.</simpara></listitem>
<listitem><simpara>
string description - Description string of the event.</simpara></listitem>
<listitem><simpara>
int alarm - number of minutes before the event to send an
alarm/reminder.</simpara></listitem>
<listitem><simpara>
object start - Object containing a datetime entry.</simpara></listitem>
<listitem><simpara>
object end - Object containing a datetime entry.</simpara></listitem>
<listitem><simpara>
int recur_type - recurrence type</simpara></listitem>
<listitem><simpara>
int recur_interval - recurrence interval</simpara></listitem>
<listitem><simpara>
datetime recur_enddate - recurrence end date</simpara></listitem>
<listitem><simpara>
int recur_data - recurrence data</simpara></listitem>
<listitem>
<simpara>
int id - ID of that event.
</simpara>
</listitem>
<listitem>
<simpara>
int public - &true; if the event if public, &false; if it is private.
</simpara>
</listitem>
<listitem>
<simpara>
string category - Category string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
string title - Title string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
string description - Description string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
int alarm - number of minutes before the event to send an
alarm/reminder.
</simpara>
</listitem>
<listitem>
<simpara>
object start - Object containing a datetime entry.
</simpara>
</listitem>
<listitem>
<simpara>
object end - Object containing a datetime entry.
</simpara>
</listitem>
<listitem>
<simpara>
int recur_type - recurrence type
</simpara>
</listitem>
<listitem>
<simpara>
int recur_interval - recurrence interval
</simpara>
</listitem>
<listitem>
<simpara>
datetime recur_enddate - recurrence end date
</simpara>
</listitem>
<listitem>
<simpara>
int recur_data - recurrence data
</simpara>
</listitem>
</itemizedlist>
All datetime entries consist of an object that contains:
<itemizedlist>
<listitem><simpara>
int year - year</simpara></listitem>
<listitem><simpara>
int month - month</simpara></listitem>
<listitem><simpara>
int mday - day of month</simpara></listitem>
<listitem><simpara>
int hour - hour</simpara></listitem>
<listitem><simpara>
int min - minutes</simpara></listitem>
<listitem><simpara>
int sec - seconds</simpara></listitem>
<listitem><simpara>
int alarm - minutes before event to send an alarm</simpara></listitem>
<listitem>
<simpara>
int year - year
</simpara>
</listitem>
<listitem>
<simpara>
int month - month
</simpara>
</listitem>
<listitem>
<simpara>
int mday - day of month
</simpara>
</listitem>
<listitem>
<simpara>
int hour - hour
</simpara>
</listitem>
<listitem>
<simpara>
int min - minutes
</simpara>
</listitem>
<listitem>
<simpara>
int sec - seconds
</simpara>
</listitem>
<listitem>
<simpara>
int alarm - minutes before event to send an alarm
</simpara>
</listitem>
</itemizedlist>
The possible values for recur_type are:
<itemizedlist>
<listitem><simpara>
0 - Indicates that this event does not recur</simpara></listitem>
<listitem><simpara>
1 - This event recurs daily</simpara></listitem>
<listitem><simpara>
2 - This event recurs on a weekly basis</simpara></listitem>
<listitem><simpara>
3 - This event recurs monthly on a specific day of the month (e.g. the 10th of the month)</simpara></listitem>
<listitem><simpara>
4 - This event recurs monthly on a sequenced day of the week (e.g. the 3rd Saturday) </simpara></listitem>
<listitem><simpara>
5 - This event recurs on an annual basis</simpara></listitem>
</itemizedlist></para>
<listitem>
<simpara>
0 - Indicates that this event does not recur
</simpara>
</listitem>
<listitem>
<simpara>
1 - This event recurs daily
</simpara>
</listitem>
<listitem>
<simpara>
2 - This event recurs on a weekly basis
</simpara>
</listitem>
<listitem>
<simpara>
3 - This event recurs monthly on a specific day of the month (e.g. the 10th of the month)
</simpara>
</listitem>
<listitem>
<simpara>
4 - This event recurs monthly on a sequenced day of the week (e.g. the 3rd Saturday)
</simpara>
</listitem>
<listitem>
<simpara>
5 - This event recurs on an annual basis
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>

95
reference/mcal/functions/mcal-list-alarms.xml
View file

@ -1,33 +1,96 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-list-alarms" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_list_alarms</refname>
<refpurpose>Return a list of events that has an alarm triggered at the given datetime</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mcal_list_alarms</methodname>
<methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>begin_year</parameter></methodparam>
<methodparam><type>int</type><parameter>begin_month</parameter></methodparam>
<methodparam><type>int</type><parameter>begin_day</parameter></methodparam>
<methodparam><type>int</type><parameter>end_year</parameter></methodparam>
<methodparam><type>int</type><parameter>end_month</parameter></methodparam>
<methodparam><type>int</type><parameter>end_day</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>begin_month</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>begin_day</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end_year</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end_month</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end_day</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of event ID's that has an alarm going off
between the start and end dates, or if just a stream is given,
uses the start and end dates in the global event structure.
Returns an array of event ID's that has an alarm going off between the
start and end dates, or if just a stream is given, uses the start and
end dates in the global event structure.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<function>mcal_list_events</function> function takes in an
optional beginning date and an end date for a calendar stream. An
array of event id's that are between the given dates or the
internal event dates are returned.
<variablelist>
<varlistentry>
<term><parameter>mcal_stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>begin_year</parameter></term>
<listitem>
<para>
Year part of the first date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>begin_month</parameter></term>
<listitem>
<para>
Month part of the first date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>begin_day</parameter></term>
<listitem>
<para>
Day part of the first date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>end_year</parameter></term>
<listitem>
<para>
Year part of the second date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>end_month</parameter></term>
<listitem>
<para>
Month part of the second date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>end_day</parameter></term>
<listitem>
<para>
Day part of the second date.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of alarm id's that are between the given dates or the
internal alarm dates.
</para>
</refsect1>
</refentry>

91
reference/mcal/functions/mcal-list-events.xml
View file

@ -1,22 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mcal-list-events" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_list_events</refname>
<refpurpose>Return a list of IDs for a date or a range of dates</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mcal_list_events</methodname>
<methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>begin_year</parameter></methodparam>
<methodparam><type>int</type><parameter>begin_month</parameter></methodparam>
<methodparam><type>int</type><parameter>begin_day</parameter></methodparam>
<methodparam><type>int</type><parameter>end_year</parameter></methodparam>
<methodparam><type>int</type><parameter>end_month</parameter></methodparam>
<methodparam><type>int</type><parameter>end_day</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>begin_month</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>begin_day</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end_year</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end_month</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end_day</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of ID's that are between the start and end
@ -25,9 +24,77 @@
</para>
<para>
<function>mcal_list_events</function> takes in an
beginning date and an optional end date for a calendar stream. An
array of event id's that are between the given dates or the
internal event dates are returned.
beginning date and an optional end date for a calendar stream.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mcal_stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>begin_year</parameter></term>
<listitem>
<para>
Year part of the first date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>begin_month</parameter></term>
<listitem>
<para>
Month part of the first date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>begin_day</parameter></term>
<listitem>
<para>
Day part of the first date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>end_year</parameter></term>
<listitem>
<para>
Year part of the second date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>end_month</parameter></term>
<listitem>
<para>
Month part of the second date.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>end_day</parameter></term>
<listitem>
<para>
Day part of the second date.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of event id's that are between the given dates or the
internal event dates.
</para>
</refsect1>
</refentry>

97
reference/uodbc/functions/odbc-binmode.xml
View file

@ -1,38 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.odbc-binmode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_binmode</refname>
<refpurpose>Handling of binary column data</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>odbc_binmode</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
(ODBC SQL types affected: BINARY, VARBINARY, LONGVARBINARY)
Enables handling of binary column data. ODBC SQL types affected are
BINARY, VARBINARY, and LONGVARBINARY.
</para>
<itemizedlist>
<listitem>
<simpara>
ODBC_BINMODE_PASSTHRU: Passthru BINARY data
</simpara>
</listitem>
<listitem>
<simpara>
ODBC_BINMODE_RETURN: Return as is
</simpara>
</listitem>
<listitem>
<simpara>
ODBC_BINMODE_CONVERT: Convert to char and return
</simpara>
</listitem>
</itemizedlist>
<para>
When binary SQL data is converted to character C data, each byte
(8 bits) of source data is represented as two ASCII characters.
@ -91,20 +74,66 @@
</table>
</para>
<para>
If <function>odbc_fetch_into</function> is used, passthru means
that an empty string is returned for these columns.
If <function>odbc_fetch_into</function> is used, passthru means that an
empty string is returned for these columns.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
If <parameter>result_id</parameter> is <literal>0</literal>, the
settings apply as default for new results.
<note>
<simpara>
Default for longreadlen is <literal>4096</literal> and binmode
defaults to <literal>ODBC_BINMODE_RETURN</literal>. Handling
of binary long columns is also affected by
<function>odbc_longreadlen</function>
</simpara>
</note>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
The result identifier.
</para>
<para>
If <parameter>result_id</parameter> is <literal>0</literal>, the
settings apply as default for new results.
<note>
<simpara>
Default for longreadlen is <literal>4096</literal> and
<parameter>mode</parameter> defaults to
<literal>ODBC_BINMODE_RETURN</literal>. Handling of binary long
columns is also affected by <function>odbc_longreadlen</function>.
</simpara>
</note>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Possible values for <parameter>mode</parameter> are:
<itemizedlist>
<listitem>
<simpara>
<constant>ODBC_BINMODE_PASSTHRU</constant>: Passthru BINARY data
</simpara>
</listitem>
<listitem>
<simpara>
<constant>ODBC_BINMODE_RETURN</constant>: Return as is
</simpara>
</listitem>
<listitem>
<simpara>
<constant>ODBC_BINMODE_CONVERT</constant>: Convert to char and return
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>

80
reference/uodbc/functions/odbc-columnprivileges.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.odbc-columnprivileges" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_columnprivileges</refname>
<refpurpose>Returns a result identifier that can be used to fetch a list of columns and associated privileges</refpurpose>
<refpurpose>Lists columns and associated privileges for the given table</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_columnprivileges</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
@ -18,8 +17,68 @@
</methodsynopsis>
<para>
Lists columns and associated privileges for the given table.
Returns an ODBC result identifier or &false; on
failure.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection_id</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>qualifier</parameter></term>
<listitem>
<para>
The qualifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>owner</parameter></term>
<listitem>
<para>
The owner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>table_name</parameter></term>
<listitem>
<para>
The table name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>column_name</parameter></term>
<listitem>
<para>
The <parameter>column_name</parameter> argument accepts search
patterns ('%' to match zero or more characters and '_' to match a
single character).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The <parameter>owner</parameter>, <parameter>table_name</parameter>, and
<parameter>column_name</parameter> accept search patterns ('%' to match
zero or more characters and '_' to match a single character).
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an ODBC result identifier or &false; on failure.
This result identifier can be used to fetch a list of columns and
associated privileges.
</para>
<para>
The result set has the following columns:
@ -33,14 +92,9 @@
<listitem><simpara>IS_GRANTABLE</simpara></listitem>
</itemizedlist>
</para>
<simpara>
<para>
The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and
TABLE_NAME.
</simpara>
<para>
The <parameter>column_name</parameter> argument accepts search
patterns ('%' to match zero or more characters and '_' to match a
single character).
</para>
</refsect1>
</refentry>

91
reference/uodbc/functions/odbc-columns.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.odbc-columns" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_columns</refname>
<refpurpose>Lists the column names in specified tables</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_columns</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
@ -17,8 +16,65 @@
<methodparam choice="opt"><type>string</type><parameter>column_name</parameter></methodparam>
</methodsynopsis>
<para>
Lists all columns in the requested range. Returns an ODBC result
identifier containing the information or &false; on failure.
Lists all columns in the requested range.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection_id</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>qualifier</parameter></term>
<listitem>
<para>
The qualifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>schema</parameter></term>
<listitem>
<para>
The owner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>table_name</parameter></term>
<listitem>
<para>
The table name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>column_name</parameter></term>
<listitem>
<para>
The column name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The <parameter>schema</parameter>, <parameter>table_name</parameter>, and
<parameter>column_name</parameter> accept search patterns ('%' to match
zero or more characters and '_' to match a single character).
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an ODBC result identifier or &false; on failure.
</para>
<para>
The result set has the following columns:
@ -37,22 +93,21 @@
<listitem><simpara>REMARKS</simpara></listitem>
</itemizedlist>
</para>
<simpara>
<para>
The result set is ordered by TABLE_QUALIFIER, TABLE_SCHEM and
TABLE_NAME.
</simpara>
<para>
The <parameter>schema</parameter>,
<parameter>table_name</parameter> and
<parameter>column_name</parameter> arguments accept search
patterns ('%' to match zero or more characters and '_' to match a
single character).
</para>
<simpara>
See also <function>odbc_columnprivileges</function> to retrieve
associated privileges.
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>odbc_columnprivileges</function> to retrieve associated
privileges</member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

70
reference/uodbc/functions/odbc-fetch-row.xml
View file

@ -1,45 +1,63 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.29 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.odbc-fetch-row" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_fetch_row</refname>
<refpurpose>Fetch a row</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>odbc_fetch_row</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row_number</parameter></methodparam>
</methodsynopsis>
<para>
If <function>odbc_fetch_row</function> was successful (there was a
row), &true; is returned. If there are no more
rows, &false; is returned.
Fetches a row of the data that was returned by <function>odbc_do</function>
or <function>odbc_exec</function>. After <function>odbc_fetch_row</function>
is called, the fields of that row can be accessed with
<function>odbc_result</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<function>odbc_fetch_row</function> fetches a row of the data
that was returned by <function>odbc_do</function> /
<function>odbc_exec</function>. After
<function>odbc_fetch_row</function> is called, the fields of that
row can be accessed with <function>odbc_result</function>.
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
The result identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>row_number</parameter></term>
<listitem>
<para>
If <parameter>row_number</parameter> is not specified,
<function>odbc_fetch_row</function> will try to fetch the next row in
the result set. Calls to <function>odbc_fetch_row</function> with and
without <parameter>row_number</parameter> can be mixed.
</para>
<para>
To step through the result more than once, you can call
<function>odbc_fetch_row</function> with
<parameter>row_number</parameter> 1, and then continue doing
<function>odbc_fetch_row</function> without
<parameter>row_number</parameter> to review the result. If a driver
doesn't support fetching rows by number, the
<parameter>row_number</parameter> parameter is ignored.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If <parameter>row_number</parameter> is not specified,
<function>odbc_fetch_row</function> will try to fetch the next
row in the result set. Calls to
<function>odbc_fetch_row</function> with and without
<parameter>row_number</parameter> can be mixed.
</para>
<para>
To step through the result more than once, you can call
<function>odbc_fetch_row</function> with
<parameter>row_number</parameter> 1, and then continue doing
<function>odbc_fetch_row</function> without
<parameter>row_number</parameter> to review the result. If a
driver doesn't support fetching rows by number, the
<parameter>row_number</parameter> parameter is ignored.
Returns &true; if there was a row, &false; otherwise.
</para>
</refsect1>
</refentry>

36
reference/uodbc/functions/odbc-next-result.xml
View file

@ -1,29 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.29 -->
<!-- $Revision: 1.9 $ -->
<refentry xml:id='function.odbc-next-result' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_next_result</refname>
<refpurpose>Checks if multiple results are available</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>odbc_next_result</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
<function>odbc_next_result</function> returns &true; if there are more result sets
available as well as allowing access to the next result set via
<function>odbc_fetch_array</function>, <function>odbc_fetch_row</function>,
<function>odbc_result</function>, etc.
Checks if there are more result sets available as well as allowing access
to the next result set via <function>odbc_fetch_array</function>,
<function>odbc_fetch_row</function>, <function>odbc_result</function>, etc.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
This function returns &false; on error.
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
The result identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The argument is a valid result identifier returned by <function>odbc_exec</function>.
Returns &true; if there are more result sets, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>odbc_next_result</function></title>