cvs: phpdoc /en/reference/com/functions com-addref.xml com-get.xml com-isenum.xml com-load.xml com-set.xml variant-cast.xml
variant-date-from-timestamp.xml variant-date-to-timestamp.xml variant-eqv.xml variant-fix.xml variant-int.xml variant-pow.xml variant-set-type.xml
/en/reference/hw/functions hw-cp.xml hw-deleteobject.xml hw-docbyanchor.xml hw-getandlock.xml hw-gettext.xml hw-incollections.xml hw-inscoll.xml
hw-insdoc.xml hw-mv.xml hw-root.xml hw-who.xml /en/reference/mcal/functions mcal-date-valid.xml mcal-event-set-alarm.xml mcal-event-set-class.xml
mcal-event-set-description.xml mcal-popen.xml mcal-time-valid.xml /en/reference/mcrypt/functions mcrypt-enc-get-block-size.xml
mcrypt-enc-get-iv-size.xml mcrypt-enc-get-key-size.xml mcrypt-enc-is-block-algorithm-mode.xml mcrypt-enc-is-block-algorithm.xml
mcrypt-enc-is-block-mode.xml mcrypt-enc-self-test.xml mcrypt-module-close.xml mcrypt-module-get-algo-block-size.xml
mcrypt-module-get-algo-key-size.xml /en/ref! erence/uodbc/functions odbc-autocommit.xml odbc-data-source.xml odbc-error.xml odbc-errormsg.xml
odbc-exec.xml odbc-field-len.xml odbc-free-result.xml odbc-longreadlen.xml odbc-num-rows.xml odbc-primarykeys.xml odbc-result-all.xml

From: Date: Sun, 30 Dec 2007 13:40:52 +0000
Subject: cvs: phpdoc /en/reference/com/functions com-addref.xml com-get.xml com-isenum.xml com-load.xml com-set.xml variant-cast.xml
variant-date-from-timestamp.xml variant-date-to-timestamp.xml variant-eqv.xml variant-fix.xml variant-int.xml variant-pow.xml variant-set-type.xml
/en/reference/hw/functions hw-cp.xml hw-deleteobject.xml hw-docbyanchor.xml hw-getandlock.xml hw-gettext.xml hw-incollections.xml hw-inscoll.xml
hw-insdoc.xml hw-mv.xml hw-root.xml hw-who.xml /en/reference/mcal/functions mcal-date-valid.xml mcal-event-set-alarm.xml mcal-event-set-class.xml
mcal-event-set-description.xml mcal-popen.xml mcal-time-valid.xml /en/reference/mcrypt/functions mcrypt-enc-get-block-size.xml
mcrypt-enc-get-iv-size.xml mcrypt-enc-get-key-size.xml mcrypt-enc-is-block-algorithm-mode.xml mcrypt-enc-is-block-algorithm.xml
mcrypt-enc-is-block-mode.xml mcrypt-enc-self-test.xml mcrypt-module-close.xml mcrypt-module-get-algo-block-size.xml
mcrypt-module-get-algo-key-size.xml /en/ref! erence/uodbc/functions odbc-autocommit.xml odbc-data-source.xml odbc-error.xml odbc-errormsg.xml
odbc-exec.xml odbc-field-len.xml odbc-free-result.xml odbc-longreadlen.xml odbc-num-rows.xml odbc-primarykeys.xml odbc-result-all.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-930@lists.php.net to get a copy of this message
didou Sun Dec 30 13:40:52 2007 UTC Modified files: /phpdoc/en/reference/com/functions com-addref.xml com-get.xml com-isenum.xml com-load.xml com-set.xml variant-cast.xml variant-date-from-timestamp.xml variant-date-to-timestamp.xml variant-eqv.xml variant-fix.xml variant-int.xml variant-pow.xml variant-set-type.xml /phpdoc/en/reference/hw/functions hw-cp.xml hw-deleteobject.xml hw-docbyanchor.xml hw-getandlock.xml hw-gettext.xml hw-incollections.xml hw-inscoll.xml hw-insdoc.xml hw-mv.xml hw-root.xml hw-who.xml /phpdoc/en/reference/mcal/functions mcal-date-valid.xml mcal-event-set-alarm.xml mcal-event-set-class.xml mcal-event-set-description.xml mcal-popen.xml mcal-time-valid.xml /phpdoc/en/reference/mcrypt/functions mcrypt-enc-get-block-size.xml mcrypt-enc-get-iv-size.xml mcrypt-enc-get-key-size.xml mcrypt-enc-is-block-algorithm-mode.xml mcrypt-enc-is-block-algorithm.xml mcrypt-enc-is-block-mode.xml mcrypt-enc-self-test.xml mcrypt-module-close.xml mcrypt-module-get-algo-block-size.xml mcrypt-module-get-algo-key-size.xml /phpdoc/en/reference/uodbc/functions odbc-autocommit.xml odbc-data-source.xml odbc-error.xml odbc-errormsg.xml odbc-exec.xml odbc-field-len.xml odbc-free-result.xml odbc-longreadlen.xml odbc-num-rows.xml odbc-primarykeys.xml odbc-result-all.xml Log: Switch to new doc style # 250 to go

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/com-addref.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/com/functions/com-addref.xml diff -u phpdoc/en/reference/com/functions/com-addref.xml:1.6 phpdoc/en/reference/com/functions/com-addref.xml:1.7 --- phpdoc/en/reference/com/functions/com-addref.xml:1.6 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/com-addref.xml Sun Dec 30 13:40:51 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.com-addref" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>com_addref</refname> <refpurpose>Increases the components reference counter [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>com_addref</methodname> <void/> @@ -14,6 +14,15 @@ <para> Increases the components reference counter. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <warning> <simpara> You should never need to use this function. http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/com-get.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/com/functions/com-get.xml diff -u phpdoc/en/reference/com/functions/com-get.xml:1.6 phpdoc/en/reference/com/functions/com-get.xml:1.7 --- phpdoc/en/reference/com/functions/com-get.xml:1.6 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/com-get.xml Sun Dec 30 13:40:51 2007 @@ -1,26 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/com.xml, last change in rev 1.7 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.com-get" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>com_get</refname> <refpurpose>Gets the value of a COM Component's property [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>mixed</type><methodname>com_get</methodname> - <methodparam><type>resource</type><parameter>com_object</parameter></methodparam> - <methodparam><type>string</type><parameter>property</parameter></methodparam> - </methodsynopsis> + <refsect1 role="description"> + &reftitle.description; <para> - Returns the value of the <parameter>property</parameter> of the - COM component referenced by <parameter>com_object</parameter>. - Returns &false; on error. + Deprecated, use the OO syntax instead. </para> <para> <example> - <title>Don't use com_get(), use OO syntax instead</title> + <title>OO syntax</title> <programlisting role="php"> <![CDATA[ <?php @@ -33,9 +25,10 @@ </programlisting> </example> </para> - - &com.use-oo-instead; - + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &com.use-oo-instead; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/com-isenum.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/com/functions/com-isenum.xml diff -u phpdoc/en/reference/com/functions/com-isenum.xml:1.9 phpdoc/en/reference/com/functions/com-isenum.xml:1.10 --- phpdoc/en/reference/com/functions/com-isenum.xml:1.9 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/com-isenum.xml Sun Dec 30 13:40:51 2007 @@ -1,23 +1,46 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> -<!-- splitted from ./en/functions/com.xml, last change in rev 1.27 --> +<!-- $Revision: 1.10 $ --> <refentry xml:id='function.com-isenum' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>com_isenum</refname> <refpurpose>Indicates if a COM object has an IEnumVariant interface for iteration [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>com_isenum</methodname> <methodparam><type>variant</type><parameter>com_module</parameter></methodparam> </methodsynopsis> <para> Checks to see if a COM object can be enumerated using the - <literal>Next()</literal> method hack. Returns &true; if it can, &false; if it cannot. + <literal>Next()</literal> method hack. See <xref linkend="class.com"/> class for more details on these methods. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>com_module</parameter></term> + <listitem> + <para> + The COM object. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the object can be enumatated, &false; otherwise. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <note> <para> This function does not exist in PHP 5; use the more natural http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/com-load.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/com/functions/com-load.xml diff -u phpdoc/en/reference/com/functions/com-load.xml:1.6 phpdoc/en/reference/com/functions/com-load.xml:1.7 --- phpdoc/en/reference/com/functions/com-load.xml:1.6 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/com-load.xml Sun Dec 30 13:40:51 2007 @@ -1,27 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/com.xml, last change in rev 1.7 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.com-load" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>com_load</refname> <refpurpose>Creates a new reference to a COM component [deprecated]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>com_load</methodname> - <methodparam><type>string</type><parameter>module_name</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>server_name</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>codepage</parameter></methodparam> - </methodsynopsis> + <refsect1 role="description"> + &reftitle.description; <para> - Equivalent to using the <literal>new</literal> operator to create an - instance of the <xref linkend="class.com"/> class. You should do - that instead of calling this function. + Deprecated, use the OO syntax instead. </para> <para> <example> - <title>Don't use com_load(), use OO syntax instead</title> + <title>OO syntax</title> <programlisting role="php"> <![CDATA[ <?php @@ -34,14 +25,10 @@ </programlisting> </example> </para> - - - <note> - <para> - This function does not exist in PHP 5; use the <xref - linkend="class.com"/> class instead. - </para> - </note> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &com.use-oo-instead; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/com-set.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/com/functions/com-set.xml diff -u phpdoc/en/reference/com/functions/com-set.xml:1.6 phpdoc/en/reference/com/functions/com-set.xml:1.7 --- phpdoc/en/reference/com/functions/com-set.xml:1.6 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/com-set.xml Sun Dec 30 13:40:51 2007 @@ -1,28 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/com.xml, last change in rev 1.7 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.com-set" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>com_set</refname> <refpurpose>Assigns a value to a COM component's property</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>com_set</methodname> - <methodparam><type>resource</type><parameter>com_object</parameter></methodparam> - <methodparam><type>string</type><parameter>property</parameter></methodparam> - <methodparam><type>mixed</type><parameter>value</parameter></methodparam> - </methodsynopsis> + <refsect1 role="description"> + &reftitle.description; <para> - Sets the value of the <parameter>property</parameter> of the COM - component referenced by <parameter>com_object</parameter>. - Returns the newly set value if succeeded, &false; on error. + Deprecated, use the OO syntax instead. </para> - <para> <example> - <title>Don't use com_set(), use OO syntax instead</title> + <title>OO syntax</title> <programlisting role="php"> <![CDATA[ <?php @@ -35,8 +25,9 @@ </programlisting> </example> </para> - - + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &com.use-oo-instead; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/variant-cast.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/com/functions/variant-cast.xml diff -u phpdoc/en/reference/com/functions/variant-cast.xml:1.4 phpdoc/en/reference/com/functions/variant-cast.xml:1.5 --- phpdoc/en/reference/com/functions/variant-cast.xml:1.4 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/variant-cast.xml Sun Dec 30 13:40:51 2007 @@ -1,35 +1,64 @@ <?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-cast" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>variant_cast</refname> <refpurpose>Convert a variant into a new variant object of another type</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>variant</type><methodname>variant_cast</methodname> <methodparam><type>variant</type><parameter>variant</parameter></methodparam> <methodparam><type>int</type><parameter>type</parameter></methodparam> </methodsynopsis> - <para> This function makes a copy of <parameter>variant</parameter> and then performs a variant cast operation to force the copy to have the type - given by <parameter>type</parameter>. <parameter>type</parameter> should - be one of the <constant>VT_XXX</constant> constants. + given by <parameter>type</parameter>. </para> - <para> This function wraps VariantChangeType() in the COM library; consult MSDN for more information. </para> - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also <function>variant_set_type</function>. + <variablelist> + <varlistentry> + <term><parameter>variant</parameter></term> + <listitem> + <para> + The variant. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + <parameter>type</parameter> should be one of the + <constant>VT_XXX</constant> constants. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a <constant>VT_DATE</constant> variant. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>variant_set_type</function></member> + </simplelist> </para> - </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/variant-date-from-timestamp.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/com/functions/variant-date-from-timestamp.xml diff -u phpdoc/en/reference/com/functions/variant-date-from-timestamp.xml:1.5 phpdoc/en/reference/com/functions/variant-date-from-timestamp.xml:1.6 --- phpdoc/en/reference/com/functions/variant-date-from-timestamp.xml:1.5 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/variant-date-from-timestamp.xml Sun Dec 30 13:40:51 2007 @@ -1,30 +1,52 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.variant-date-from-timestamp" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>variant_date_from_timestamp</refname> <refpurpose>Returns a variant date representation of a Unix timestamp</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>variant</type><methodname>variant_date_from_timestamp</methodname> <methodparam><type>int</type><parameter>timestamp</parameter></methodparam> </methodsynopsis> - <para> Converts <parameter>timestamp</parameter> from a unix timestamp value into a variant of type <constant>VT_DATE</constant>. This allows easier interopability between the unix-ish parts of PHP and COM. </para> - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also <function>variant_date_to_timestamp</function> for the inverse - of this operation, - <function>mktime</function>, <function>time</function>. + <variablelist> + <varlistentry> + <term><parameter>timestamp</parameter></term> + <listitem> + <para> + A unix timestamp. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a <constant>VT_DATE</constant> variant. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>variant_date_to_timestamp</function></member> + <member><function>mktime</function></member> + <member><function>time</function></member> + </simplelist> </para> - </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/variant-date-to-timestamp.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/com/functions/variant-date-to-timestamp.xml diff -u phpdoc/en/reference/com/functions/variant-date-to-timestamp.xml:1.6 phpdoc/en/reference/com/functions/variant-date-to-timestamp.xml:1.7 --- phpdoc/en/reference/com/functions/variant-date-to-timestamp.xml:1.6 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/variant-date-to-timestamp.xml Sun Dec 30 13:40:51 2007 @@ -1,30 +1,52 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.variant-date-to-timestamp" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>variant_date_to_timestamp</refname> <refpurpose>Converts a variant date/time value to Unix timestamp</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>variant_date_to_timestamp</methodname> <methodparam><type>variant</type><parameter>variant</parameter></methodparam> </methodsynopsis> - <para> Converts <parameter>variant</parameter> from a <constant>VT_DATE</constant> (or similar) value into a Unix timestamp. This allows easier interopability between the Unix-ish parts of PHP and COM. </para> - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also <function>variant_date_from_timestamp</function> for the inverse - of this operation, - <function>date</function>, <function>strftime</function>. + <variablelist> + <varlistentry> + <term><parameter>variant</parameter></term> + <listitem> + <para> + The variant. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a unix timestamp. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>variant_date_from_timestamp</function></member> + <member><function>date</function></member> + <member><function>strftime</function></member> + </simplelist> </para> - </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/variant-eqv.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/com/functions/variant-eqv.xml diff -u phpdoc/en/reference/com/functions/variant-eqv.xml:1.4 phpdoc/en/reference/com/functions/variant-eqv.xml:1.5 --- phpdoc/en/reference/com/functions/variant-eqv.xml:1.4 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/variant-eqv.xml Sun Dec 30 13:40:51 2007 @@ -1,26 +1,52 @@ <?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-eqv" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>variant_eqv</refname> <refpurpose>Performs a bitwise equivalence on two variants</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>variant_eqv</methodname> <methodparam><type>mixed</type><parameter>left</parameter></methodparam> <methodparam><type>mixed</type><parameter>right</parameter></methodparam> </methodsynopsis> - + <para> + Performs a bitwise equivalence on two variants. + </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> + </para> + &com.variant-arith; + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> If each bit in <parameter>left</parameter> is equal to the corresponding bit in <parameter>right</parameter> then &true; is returned, otherwise &false; is returned. </para> - - &com.variant-arith; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/variant-fix.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/com/functions/variant-fix.xml diff -u phpdoc/en/reference/com/functions/variant-fix.xml:1.4 phpdoc/en/reference/com/functions/variant-fix.xml:1.5 --- phpdoc/en/reference/com/functions/variant-fix.xml:1.4 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/variant-fix.xml Sun Dec 30 13:40:51 2007 @@ -1,32 +1,47 @@ <?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-fix" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>variant_fix</refname> - <refpurpose>Returns the integer portion ? of a variant</refpurpose> + <refpurpose>Returns the integer portion of a variant</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>variant_fix</methodname> <methodparam><type>mixed</type><parameter>variant</parameter></methodparam> </methodsynopsis> - + <para> + Gets the integer portion of a variant. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>variant</parameter></term> + <listitem> + <para> + The variant. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + &com.variant-arith; + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> If <parameter>variant</parameter> is negative, then the first negative integer greater than or equal to the variant is returned, otherwise returns the integer portion of the value of <parameter>variant</parameter>. </para> - - <para> - See also <function>variant_int</function>, - <function>variant_round</function>, <function>floor</function>, - <function>ceil</function>, - <function>round</function>. - </para> - + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <warning> <simpara> This documentation is based on the MSDN documentation; it appears @@ -35,8 +50,18 @@ documentation. </simpara> </warning> - - &com.variant-arith; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>variant_int</function></member> + <member><function>variant_round</function></member> + <member><function>floor</function></member> + <member><function>ceil</function></member> + <member><function>round</function></member> + </simplelist> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/variant-int.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/com/functions/variant-int.xml diff -u phpdoc/en/reference/com/functions/variant-int.xml:1.4 phpdoc/en/reference/com/functions/variant-int.xml:1.5 --- phpdoc/en/reference/com/functions/variant-int.xml:1.4 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/variant-int.xml Sun Dec 30 13:40:51 2007 @@ -1,34 +1,56 @@ <?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-int" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>variant_int</refname> <refpurpose>Returns the integer portion of a variant</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>variant_int</methodname> <methodparam><type>mixed</type><parameter>variant</parameter></methodparam> </methodsynopsis> - + <para> + Gets the integer portion of a variant. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>variant</parameter></term> + <listitem> + <para> + The variant. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + &com.variant-arith; + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> If <parameter>variant</parameter> is negative, then the first negative integer greater than or equal to the variant is returned, otherwise returns the integer portion of the value of <parameter>variant</parameter>. </para> - + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>variant_fix</function>, - <function>variant_round</function>, <function>floor</function>, - <function>ceil</function>, - <function>round</function>. + <simplelist> + <member><function>variant_fix</function></member> + <member><function>variant_round</function></member> + <member><function>floor</function></member> + <member><function>ceil</function></member> + <member><function>round</function></member> + </simplelist> </para> - - &com.variant-arith; - </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/variant-pow.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/com/functions/variant-pow.xml diff -u phpdoc/en/reference/com/functions/variant-pow.xml:1.4 phpdoc/en/reference/com/functions/variant-pow.xml:1.5 --- phpdoc/en/reference/com/functions/variant-pow.xml:1.4 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/variant-pow.xml Sun Dec 30 13:40:51 2007 @@ -1,30 +1,61 @@ <?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-pow" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>variant_pow</refname> <refpurpose>Returns the result of performing the power function with two variants</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>variant_pow</methodname> <methodparam><type>mixed</type><parameter>left</parameter></methodparam> <methodparam><type>mixed</type><parameter>right</parameter></methodparam> </methodsynopsis> - <para> Returns the result of <parameter>left</parameter> to the power of <parameter>right</parameter>. </para> - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also <function>pow</function>. + <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> </para> - &com.variant-arith; </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the result of <parameter>left</parameter> to the power of + <parameter>right</parameter>. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>pow</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/com/functions/variant-set-type.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/com/functions/variant-set-type.xml diff -u phpdoc/en/reference/com/functions/variant-set-type.xml:1.5 phpdoc/en/reference/com/functions/variant-set-type.xml:1.6 --- phpdoc/en/reference/com/functions/variant-set-type.xml:1.5 Sun Dec 30 10:06:13 2007 +++ phpdoc/en/reference/com/functions/variant-set-type.xml Sun Dec 30 13:40:51 2007 @@ -1,30 +1,59 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.variant-set-type" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>variant_set_type</refname> <refpurpose>Convert a variant into another type "in-place"</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>variant_set_type</methodname> <methodparam><type>variant</type><parameter>variant</parameter></methodparam> <methodparam><type>int</type><parameter>type</parameter></methodparam> </methodsynopsis> - <para> This function is similar to <function>variant_cast</function> except that the variant is modified "in-place"; no new variant is created. The parameters for this function have identical meaning to those of <function>variant_cast</function>. </para> - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also <function>variant_cast</function>. + <variablelist> + <varlistentry> + <term><parameter>variant</parameter></term> + <listitem> + <para> + The variant. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>variant_cast</function></member> + </simplelist> </para> - </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-cp.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-cp.xml diff -u phpdoc/en/reference/hw/functions/hw-cp.xml:1.5 phpdoc/en/reference/hw/functions/hw-cp.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-cp.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-cp.xml Sun Dec 30 13:40:51 2007 @@ -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-cp" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_cp</refname> <refpurpose>Copies objects</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_cp</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> @@ -19,11 +18,50 @@ parameter to the collection with the id <parameter>destination id</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The value return is the number of copied objects. + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_id_array</parameter></term> + <listitem> + <para> + An array of object ids. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>destination_id</parameter></term> + <listitem> + <para> + The target collection id. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of copied objects. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_mv</function>. + <simplelist> + <member><function>hw_mv</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-deleteobject.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-deleteobject.xml diff -u phpdoc/en/reference/hw/functions/hw-deleteobject.xml:1.6 phpdoc/en/reference/hw/functions/hw-deleteobject.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-deleteobject.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-deleteobject.xml Sun Dec 30 13:40:51 2007 @@ -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-deleteobject" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Deleteobject</refname> <refpurpose>Deletes object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>hw_deleteobject</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> @@ -17,11 +16,42 @@ Deletes the object with the given object id in the second parameter. It will delete all instances of the object. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns &true; if no error occurs otherwise &false;. + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_to_delete</parameter></term> + <listitem> + <para> + The object identifier. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_mv</function>. + <simplelist> + <member><function>hw_mv</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-docbyanchor.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-docbyanchor.xml diff -u phpdoc/en/reference/hw/functions/hw-docbyanchor.xml:1.5 phpdoc/en/reference/hw/functions/hw-docbyanchor.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-docbyanchor.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-docbyanchor.xml Sun Dec 30 13:40:51 2007 @@ -1,21 +1,49 @@ <?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-docbyanchor" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_DocByAnchor</refname> <refpurpose>Object id object belonging to anchor</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_docbyanchor</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> <methodparam><type>int</type><parameter>anchorID</parameter></methodparam> </methodsynopsis> <para> - Returns an th object id of the document to - which <parameter>anchorID</parameter> belongs. + Returns an th object id of the document to which + <parameter>anchorID</parameter> belongs. + </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>anchorID</parameter></term> + <listitem> + <para> + The anchor identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the document object id. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-getandlock.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-getandlock.xml diff -u phpdoc/en/reference/hw/functions/hw-getandlock.xml:1.6 phpdoc/en/reference/hw/functions/hw-getandlock.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-getandlock.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-getandlock.xml Sun Dec 30 13:40:51 2007 @@ -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-getandlock" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_GetAndLock</refname> <refpurpose>Return object record and lock object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_getandlock</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> @@ -19,9 +18,44 @@ It will also lock the object, so other users cannot access it until it is unlocked. </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 the object record for the object with ID + <parameter>objectID</parameter>. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_unlock</function>, - and <function>hw_getobject</function>. + <simplelist> + <member><function>hw_unlock</function></member> + <member><function>hw_getobject</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-gettext.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-gettext.xml diff -u phpdoc/en/reference/hw/functions/hw-gettext.xml:1.7 phpdoc/en/reference/hw/functions/hw-gettext.xml:1.8 --- phpdoc/en/reference/hw/functions/hw-gettext.xml:1.7 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-gettext.xml Sun Dec 30 13:40:51 2007 @@ -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-gettext" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_GetText</refname> <refpurpose>Retrieve text document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_gettext</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> @@ -15,50 +14,92 @@ <methodparam choice="opt"><type>mixed</type><parameter>rootID/prefix</parameter></methodparam> </methodsynopsis> <para> - Returns the document with object ID - <parameter>objectID</parameter>. If the document - has anchors which can be inserted, they will be inserted already. - The optional parameter <parameter>rootID/prefix</parameter> can - be a string or an integer. If it is an integer it determines - how links are inserted - into the document. The default is 0 and will result in links that - are constructed from the name of the link's destination object. This - is useful for web applications. If a link points to an object with - name 'internet_movie' the HTML link will be - &lt;A HREF="/internet_movie">. The actual location of the source and - destination object in the document hierarchy is disregarded. You - will have to set up your web browser, to rewrite that URL to for - example '/my_script.php3/internet_movie'. 'my_script.php3' will - have to evaluate $PATH_INFO and retrieve the document. - All links will have the prefix '/my_script.php3/'. If you do not - want this you can set the optional parameter - <parameter>rootID/prefix</parameter> to any prefix which - is used instead. Is this case it has to be a string. + Returns the document with object ID <parameter>objectID</parameter>. If + the document has anchors which can be inserted, they will be inserted + already. </para> <para> - If <parameter>rootID/prefix</parameter> is an integer and - unequal to 0 the link is constructed from all the names - starting at the object with the id <parameter>rootID/prefix</parameter> - separated by a slash relative to the current object. - If for example the above document 'internet_movie' is located - at 'a-b-c-internet_movie' with '-' being the separator between - hierarchy levels on the Hyperwave server and the source document is - located at 'a-b-d-source' the resulting HTML link would be: - &lt;A HREF="../c/internet_movie">. This is useful if you want - to download the whole server content onto disk and map - the document hierarchy onto the file system. + This function will only work for pure text documents. It will not open a + special data connection and therefore blocks the control connection during + the transfer. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function will only work for pure text documents. It will - not open a special data connection and therefore blocks the - control connection during the transfer. + <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>rootID/prefix</parameter></term> + <listitem> + <para> + The optional parameter <parameter>rootID/prefix</parameter> can be a + string or an integer. If it is an integer it determines how links are + inserted into the document. The default is 0 and will result in links + that are constructed from the name of the link's destination object. + This is useful for web applications. If a link points to an object + with name 'internet_movie' the HTML link will be &lt;A + href="/internet_movie">. The actual location of the source and + destination object in the document hierarchy is disregarded. You + will have to set up your web browser, to rewrite that URL to for + example '/my_script.php3/internet_movie'. 'my_script.php3' will + have to evaluate $PATH_INFO and retrieve the document. + All links will have the prefix '/my_script.php3/'. If you do not + want this you can set the optional parameter + <parameter>rootID/prefix</parameter> to any prefix which + is used instead. Is this case it has to be a string. + </para> + <para> + If <parameter>rootID/prefix</parameter> is an integer and unequal to 0 + the link is constructed from all the names starting at the object with + the id <parameter>rootID/prefix</parameter> separated by a slash + relative to the current object. + </para> + <para> + If for example the above document 'internet_movie' is located + at 'a-b-c-internet_movie' with '-' being the separator between + hierarchy levels on the Hyperwave server and the source document is + located at 'a-b-d-source' the resulting HTML link would be: + &lt;A HREF="../c/internet_movie">. This is useful if you want + to download the whole server content onto disk and map + the document hierarchy onto the file system. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the text document. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_pipedocument</function>, - <function>hw_free_document</function>, - <function>hw_document_bodytag</function>, - <function>hw_document_size</function>, - and <function>hw_output_document</function>. + <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> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-incollections.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-incollections.xml diff -u phpdoc/en/reference/hw/functions/hw-incollections.xml:1.5 phpdoc/en/reference/hw/functions/hw-incollections.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-incollections.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-incollections.xml Sun Dec 30 13:40:51 2007 @@ -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-incollections" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_InCollections</refname> <refpurpose>Check if object ids in collections</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>hw_incollections</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> @@ -19,15 +18,60 @@ Checks whether a set of objects (documents or collections) specified by the <parameter>object_id_array</parameter> is part of the collections listed in <parameter>collection_id_array</parameter>. - When the fourth parameter <parameter>return_collections</parameter> is 0, - the subset of object ids that is part of the collections (i.e., - the documents or collections that are children of one or more - collections of collection ids or their subcollections, recursively) - is returned as an array. When the fourth parameter is 1, however, the - set of collections that have one or more objects of this subset as - children are returned as an array. This option allows a client to, - e.g., highlight the part of the collection hierarchy that contains - the matches of a previous query, in a graphical overview. + </para> + </refsect1> + <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_id_array</parameter></term> + <listitem> + <para> + An array of object ids. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>collection_id_array</parameter></term> + <listitem> + <para> + An array of collection ids. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>return_collections</parameter></term> + <listitem> + <para> + When set to 0, the subset of object ids that is part of the + collections (i.e., the documents or collections that are children of + one or more collections of collection ids or their subcollections, + recursively) is returned as an array. + </para> + <para> + When set to 1, the set of collections that have one or more objects of + this subset as children are returned as an array. This option allows a + client to, e.g., highlight the part of the collection hierarchy that + contains the matches of a previous query, in a graphical overview. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of object ids. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-inscoll.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-inscoll.xml diff -u phpdoc/en/reference/hw/functions/hw-inscoll.xml:1.5 phpdoc/en/reference/hw/functions/hw-inscoll.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-inscoll.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-inscoll.xml Sun Dec 30 13:40:51 2007 @@ -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-inscoll" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_InsColl</refname> <refpurpose>Insert collection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_inscoll</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> @@ -20,6 +19,40 @@ collection 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> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_array</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-insdoc.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-insdoc.xml diff -u phpdoc/en/reference/hw/functions/hw-insdoc.xml:1.6 phpdoc/en/reference/hw/functions/hw-insdoc.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-insdoc.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-insdoc.xml Sun Dec 30 13:40:51 2007 @@ -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-insdoc" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_InsDoc</refname> <refpurpose>Insert document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_insdoc</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> @@ -17,16 +16,64 @@ </methodsynopsis> <para> Inserts a new document with attributes as in - <parameter>object_record</parameter> into collection with object ID - <parameter>parentID</parameter>. This function inserts either - an object record only or an object record and a pure ascii text in - <parameter>text</parameter> if <parameter>text</parameter> is given. + <parameter>object_record</parameter> into acollection. + </para> + <para> If you want to insert a general document of any kind use <function>hw_insertdocument</function> instead. </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>parentID</parameter></term> + <listitem> + <para> + The collection id. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_record</parameter></term> + <listitem> + <para> + Object attributes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + If provided, this ascii text will be inserted too. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_insertdocument</function>, - and <function>hw_inscoll</function>. + <simplelist> + <member><function>hw_insertdocument</function></member> + <member><function>hw_inscoll</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-mv.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-mv.xml diff -u phpdoc/en/reference/hw/functions/hw-mv.xml:1.6 phpdoc/en/reference/hw/functions/hw-mv.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-mv.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-mv.xml Sun Dec 30 13:40:51 2007 @@ -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-mv" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_mv</refname> <refpurpose>Moves objects</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_mv</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> @@ -16,21 +15,65 @@ <methodparam><type>int</type><parameter>destination_id</parameter></methodparam> </methodsynopsis> <para> - Moves the objects with object ids as specified in the second - parameter from the collection with id <parameter>source_id</parameter> - to the collection with the id <parameter>destination_id</parameter>. - If the destination id is 0 the objects will - be unlinked from the source collection. If this is the last instance - of that object it will be deleted. If you want to delete all instances - at once, use <function>hw_deleteobject</function>. + Moves the specified objects from a collection to another. </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_id_array</parameter></term> + <listitem> + <para> + An array of object ids. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>source_id</parameter></term> + <listitem> + <para> + The source collection id. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>destination_id</parameter></term> + <listitem> + <para> + The target collection id. If set to 0 the objects will be unlinked + from the source collection. If this is the last instance of that + object it will be deleted. If you want to delete all instances at + once, use <function>hw_deleteobject</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The value returned is the number of moved objects. + Returns the number of moved objects. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_cp</function>, - and <function>hw_deleteobject</function>. - </para> + <simplelist> + <member><function>hw_cp</function></member> + <member><function>hw_deleteobject</function></member> + </simplelist> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-root.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-root.xml diff -u phpdoc/en/reference/hw/functions/hw-root.xml:1.5 phpdoc/en/reference/hw/functions/hw-root.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-root.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-root.xml Sun Dec 30 13:40:51 2007 @@ -1,16 +1,15 @@ <?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-root" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Root</refname> <refpurpose>Root object id</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_root</methodname> - <methodparam><parameter/></methodparam> + <void/> </methodsynopsis> <para> Returns the object ID of the hyperroot collection. Currently this @@ -18,6 +17,12 @@ collection of the connected server. </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns 0. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-who.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-who.xml diff -u phpdoc/en/reference/hw/functions/hw-who.xml:1.6 phpdoc/en/reference/hw/functions/hw-who.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-who.xml:1.6 Sat Dec 29 22:27:08 2007 +++ phpdoc/en/reference/hw/functions/hw-who.xml Sun Dec 30 13:40:51 2007 @@ -1,18 +1,38 @@ <?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-who" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Who</refname> <refpurpose>List of currently logged in users</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>hw_who</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> + Gets the list of currently logged in users. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns an array of users currently logged into the Hyperwave server. Each entry in this array is an array itself containing the elements id, name, system, onSinceDate, onSinceTime, TotalTime and self. 'self' http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcal/functions/mcal-date-valid.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/mcal/functions/mcal-date-valid.xml diff -u phpdoc/en/reference/mcal/functions/mcal-date-valid.xml:1.6 phpdoc/en/reference/mcal/functions/mcal-date-valid.xml:1.7 --- phpdoc/en/reference/mcal/functions/mcal-date-valid.xml:1.6 Sun Dec 30 00:52:46 2007 +++ phpdoc/en/reference/mcal/functions/mcal-date-valid.xml Sun Dec 30 13:40:51 2007 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.mcal-date-valid" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcal_date_valid</refname> - <refpurpose>Returns &true; if the given year, month, day is a valid date</refpurpose> + <refpurpose>Validates a date</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -14,7 +14,7 @@ <methodparam><type>int</type><parameter>day</parameter></methodparam> </methodsynopsis> <para> - <function>mcal_date_valid</function> + Validates a date. </para> </refsect1> <refsect1 role="parameters"> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcal/functions/mcal-event-set-alarm.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/mcal/functions/mcal-event-set-alarm.xml diff -u phpdoc/en/reference/mcal/functions/mcal-event-set-alarm.xml:1.5 phpdoc/en/reference/mcal/functions/mcal-event-set-alarm.xml:1.6 --- phpdoc/en/reference/mcal/functions/mcal-event-set-alarm.xml:1.5 Sat Dec 29 23:07:17 2007 +++ phpdoc/en/reference/mcal/functions/mcal-event-set-alarm.xml Sun Dec 30 13:40:51 2007 @@ -1,21 +1,49 @@ <?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-event-set-alarm" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcal_event_set_alarm</refname> <refpurpose>Sets the alarm of the streams global event structure</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>mcal_event_set_alarm</methodname> <methodparam><type>int</type><parameter>stream</parameter></methodparam> <methodparam><type>int</type><parameter>alarm</parameter></methodparam> </methodsynopsis> <para> - <function>mcal_event_set_alarm</function> sets the streams global - event structure's alarm to the given minutes before the event. + Sets the streams global event structure's alarm to the given minutes + before the event. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>stream</parameter></term> + <listitem> + <para> + The MCAL stream. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>alarm</parameter></term> + <listitem> + <para> + The alarm, in minutes. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcal/functions/mcal-event-set-class.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/mcal/functions/mcal-event-set-class.xml diff -u phpdoc/en/reference/mcal/functions/mcal-event-set-class.xml:1.5 phpdoc/en/reference/mcal/functions/mcal-event-set-class.xml:1.6 --- phpdoc/en/reference/mcal/functions/mcal-event-set-class.xml:1.5 Sat Dec 29 23:07:17 2007 +++ phpdoc/en/reference/mcal/functions/mcal-event-set-class.xml Sun Dec 30 13:40:51 2007 @@ -1,22 +1,48 @@ <?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-event-set-class" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcal_event_set_class</refname> <refpurpose>Sets the class of the streams global event structure</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>mcal_event_set_class</methodname> <methodparam><type>int</type><parameter>stream</parameter></methodparam> <methodparam><type>int</type><parameter>class</parameter></methodparam> </methodsynopsis> <para> - <function>mcal_event_set_class</function> sets the streams global - event structure's class to the given value. The class is either 1 - for public, or 0 for private. + Sets the streams global event structure's class to the given value. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>stream</parameter></term> + <listitem> + <para> + The MCAL stream. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>class</parameter></term> + <listitem> + <para> + The class is either 1 for public, or 0 for private. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcal/functions/mcal-event-set-description.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/mcal/functions/mcal-event-set-description.xml diff -u phpdoc/en/reference/mcal/functions/mcal-event-set-description.xml:1.5 phpdoc/en/reference/mcal/functions/mcal-event-set-description.xml:1.6 --- phpdoc/en/reference/mcal/functions/mcal-event-set-description.xml:1.5 Sat Dec 29 23:07:17 2007 +++ phpdoc/en/reference/mcal/functions/mcal-event-set-description.xml Sun Dec 30 13:40:51 2007 @@ -1,21 +1,48 @@ <?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-event-set-description" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcal_event_set_description</refname> <refpurpose>Sets the description of the streams global event structure</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>mcal_event_set_description</methodname> <methodparam><type>int</type><parameter>stream</parameter></methodparam> <methodparam><type>string</type><parameter>description</parameter></methodparam> </methodsynopsis> <para> - <function>mcal_event_set_description</function> sets the streams - global event structure's description to the given string. + Sets the streams global event structure's description to the given string. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>stream</parameter></term> + <listitem> + <para> + The MCAL stream. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>description</parameter></term> + <listitem> + <para> + The description, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcal/functions/mcal-popen.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/mcal/functions/mcal-popen.xml diff -u phpdoc/en/reference/mcal/functions/mcal-popen.xml:1.4 phpdoc/en/reference/mcal/functions/mcal-popen.xml:1.5 --- phpdoc/en/reference/mcal/functions/mcal-popen.xml:1.4 Sat Dec 29 23:07:17 2007 +++ phpdoc/en/reference/mcal/functions/mcal-popen.xml Sun Dec 30 13:40:51 2007 @@ -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.11 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.mcal-popen" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcal_popen</refname> <refpurpose>Opens up a persistent MCAL connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mcal_popen</methodname> <methodparam><type>string</type><parameter>calendar</parameter></methodparam> @@ -16,14 +15,57 @@ <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - Returns an MCAL stream on success, &false; on error. + <function>mcal_popen</function> opens up an persistent MCAL connection to + the specified <parameter>calendar</parameter> store. + </para> + <para> + The streams internal event structure is also initialized upon connection. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>calendar</parameter></term> + <listitem> + <para> + The MCAL calendar store. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The MCAL username. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The MCAL password. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + If the optional <parameter>options</parameter> is specified, + passes the <parameter>options</parameter> to that mailbox also. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mcal_popen</function> opens up an MCAL connection to the - specified <parameter>calendar</parameter> store. If the optional - <parameter>options</parameter> is specified, passes the - <parameter>options</parameter> to that mailbox also. The streams - internal event structure is also initialized upon connection. + Returns an MCAL stream on success, &false; on error. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcal/functions/mcal-time-valid.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/mcal/functions/mcal-time-valid.xml diff -u phpdoc/en/reference/mcal/functions/mcal-time-valid.xml:1.6 phpdoc/en/reference/mcal/functions/mcal-time-valid.xml:1.7 --- phpdoc/en/reference/mcal/functions/mcal-time-valid.xml:1.6 Sat Dec 29 23:07:17 2007 +++ phpdoc/en/reference/mcal/functions/mcal-time-valid.xml Sun Dec 30 13:40:51 2007 @@ -1,13 +1,12 @@ <?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-time-valid" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcal_time_valid</refname> - <refpurpose>Returns &true; if the given hour, minutes and seconds is a valid time</refpurpose> + <refpurpose>Validates a time</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mcal_time_valid</methodname> <methodparam><type>int</type><parameter>hour</parameter></methodparam> @@ -15,8 +14,44 @@ <methodparam><type>int</type><parameter>seconds</parameter></methodparam> </methodsynopsis> <para> - <function>mcal_time_valid</function> Returns &true; if the given - hour, minutes and seconds is a valid time, &false; if not. + Validates a time. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hour</parameter></term> + <listitem> + <para> + The hour. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>minutes</parameter></term> + <listitem> + <para> + The minutes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>seconds</parameter></term> + <listitem> + <para> + The seconds. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the given time is valid, &false; otherwise. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml:1.5 phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml:1.6 --- phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml:1.5 Sun Dec 30 13:15:56 2007 +++ phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml Sun Dec 30 13:40:52 2007 @@ -1,20 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.mcrypt-enc-get-block-size" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcrypt_enc_get_block_size</refname> <refpurpose>Returns the blocksize of the opened algorithm</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mcrypt_enc_get_block_size</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> </methodsynopsis> <para> - This function returns the block size of the algorithm specified by - the encryption descriptor <parameter>td</parameter> in bytes. + Gets the blocksize of the opened algorithm. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>td</parameter></term> + <listitem> + <para> + The encryption descriptior. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the block size of the specified algorithm in bytes. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml:1.4 phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml:1.5 --- phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml:1.4 Sun Dec 30 13:15:56 2007 +++ phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml Sun Dec 30 13:40:52 2007 @@ -1,22 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.mcrypt-enc-get-iv-size" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcrypt_enc_get_iv_size</refname> <refpurpose>Returns the size of the IV of the opened algorithm</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mcrypt_enc_get_iv_size</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> </methodsynopsis> <para> - This function returns the size of the iv of the algorithm - specified by the encryption descriptor in bytes. If it returns - '0' then the IV is ignored in the algorithm. An IV is used in - cbc, cfb and ofb modes, and in some algorithms in stream mode. + This function returns the size of the IV of the algorithm specified by the + encryption descriptor in bytes. An IV is used in cbc, cfb and ofb modes, + and in some algorithms in stream mode. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>td</parameter></term> + <listitem> + <para> + The encryption descriptior. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the size of the IV, or 0 if the IV is ignored in the algorithm. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml:1.5 phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml:1.6 --- phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml:1.5 Sun Dec 30 13:15:56 2007 +++ phpdoc/en/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml Sun Dec 30 13:40:52 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.mcrypt-enc-get-key-size" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcrypt_enc_get_key_size</refname> <refpurpose>Returns the maximum supported keysize of the opened mode</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mcrypt_enc_get_key_size</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> </methodsynopsis> <para> - This function returns the maximum supported key size of the - algorithm specified by the encryption descriptor - <parameter>td</parameter> in bytes. + Gets the maximum supported key size of the algorithm in bytes. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>td</parameter></term> + <listitem> + <para> + The encryption descriptior. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the maximum supported key size of the algorithm in bytes. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml:1.6 phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml:1.7 --- phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml:1.6 Sun Dec 30 13:15:56 2007 +++ phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml Sun Dec 30 13:40:52 2007 @@ -1,20 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.mcrypt-enc-is-block-algorithm-mode" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcrypt_enc_is_block_algorithm_mode</refname> <refpurpose>Checks whether the encryption of the opened mode works on blocks</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mcrypt_enc_is_block_algorithm_mode</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> </methodsynopsis> <para> - This function returns &true; if the mode is for use with block algorithms, - otherwise it returns &false;. (e.g. &false; for stream, and &true; for cbc, cfb, ofb). + Tells whether the algorithm of the opened mode works on blocks (e.g. + &false; for stream, and &true; for cbc, cfb, ofb).. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>td</parameter></term> + <listitem> + <para> + The encryption descriptior. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the mode is for use with block algorithms, otherwise it + returns &false;. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml:1.5 phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml:1.6 --- phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml:1.5 Sun Dec 30 13:15:56 2007 +++ phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml Sun Dec 30 13:40:52 2007 @@ -1,20 +1,40 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.mcrypt-enc-is-block-algorithm" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcrypt_enc_is_block_algorithm</refname> <refpurpose>Checks whether the algorithm of the opened mode is a block algorithm</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mcrypt_enc_is_block_algorithm</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> </methodsynopsis> <para> - This function returns &true; if the algorithm is a block algorithm, - or &false; if it is a stream algorithm. + Tells whether the algorithm of the opened mode is a block algorithm. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>td</parameter></term> + <listitem> + <para> + The encryption descriptior. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the algorithm is a block algorithm or &false; if it is + a stream one. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml:1.8 phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml:1.9 --- phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml:1.8 Sun Dec 30 13:15:56 2007 +++ phpdoc/en/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml Sun Dec 30 13:40:52 2007 @@ -1,21 +1,40 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 --> +<!-- $Revision: 1.9 $ --> <refentry xml:id="function.mcrypt-enc-is-block-mode" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcrypt_enc_is_block_mode</refname> <refpurpose>Checks whether the opened mode outputs blocks</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mcrypt_enc_is_block_mode</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> </methodsynopsis> <para> - This function returns &true; if the mode outputs blocks of bytes or - &false; if it outputs bytes. (e.g. &true; for cbc and ecb, and &false; for cfb and - stream). + Tells whether the opened mode outputs blocks (e.g. &true; for cbc and ecb, + and &false; for cfb and stream). + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>td</parameter></term> + <listitem> + <para> + The encryption descriptior. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the mode outputs blocks of bytes or &false; if it outputs bytes. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcrypt/functions/mcrypt-enc-self-test.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/mcrypt/functions/mcrypt-enc-self-test.xml diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-enc-self-test.xml:1.6 phpdoc/en/reference/mcrypt/functions/mcrypt-enc-self-test.xml:1.7 --- phpdoc/en/reference/mcrypt/functions/mcrypt-enc-self-test.xml:1.6 Sun Dec 30 13:15:56 2007 +++ phpdoc/en/reference/mcrypt/functions/mcrypt-enc-self-test.xml Sun Dec 30 13:40:52 2007 @@ -1,21 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.mcrypt-enc-self-test" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcrypt_enc_self_test</refname> - <refpurpose>This function runs a self test on the opened module</refpurpose> + <refpurpose>Runs a self test on the opened module</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mcrypt_enc_self_test</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> </methodsynopsis> <para> This function runs the self test on the algorithm specified by the - descriptor <parameter>td</parameter>. If the self test succeeds it returns &false;. In case - of an error, it returns &true;. + descriptor <parameter>td</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>td</parameter></term> + <listitem> + <para> + The encryption descriptior. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + If the self test succeeds it returns &false;. In case of an error, it + returns &true;. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcrypt/functions/mcrypt-module-close.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/mcrypt/functions/mcrypt-module-close.xml diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-module-close.xml:1.5 phpdoc/en/reference/mcrypt/functions/mcrypt-module-close.xml:1.6 --- phpdoc/en/reference/mcrypt/functions/mcrypt-module-close.xml:1.5 Sun Dec 30 13:15:56 2007 +++ phpdoc/en/reference/mcrypt/functions/mcrypt-module-close.xml Sun Dec 30 13:40:52 2007 @@ -1,22 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.27 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id='function.mcrypt-module-close' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcrypt_module_close</refname> <refpurpose>Close the mcrypt module</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mcrypt_module_close</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> </methodsynopsis> <para> - This function closes the specified encryption handle. + Closes the specified encryption handle. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>td</parameter></term> + <listitem> + <para> + The encryption descriptior. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See <function>mcrypt_module_open</function> for an example. + <simplelist> + <member><function>mcrypt_module_open</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml:1.4 phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml:1.5 --- phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml:1.4 Sun Dec 30 13:15:56 2007 +++ phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml Sun Dec 30 13:40:52 2007 @@ -1,22 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.mcrypt-module-get-algo-block-size" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcrypt_module_get_algo_block_size</refname> <refpurpose>Returns the blocksize of the specified algorithm</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mcrypt_module_get_algo_block_size</methodname> <methodparam><type>string</type><parameter>algorithm</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam> </methodsynopsis> <para> - This function returns the block size of the algorithm specified in - bytes. The optional <parameter>lib_dir</parameter> parameter - can contain the location where the mode module is on the system. + Gets the blocksize of the specified algorithm. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>algorithm</parameter></term> + <listitem> + <para> + The algorithm name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lib_dir</parameter></term> + <listitem> + <para> + This optional parameter can contain the location where the mode module + is on the system. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the block size of the algorithm specified in bytes. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml:1.4 phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml:1.5 --- phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml:1.4 Sun Dec 30 13:15:56 2007 +++ phpdoc/en/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml Sun Dec 30 13:40:52 2007 @@ -1,23 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.mcrypt-module-get-algo-key-size" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>mcrypt_module_get_algo_key_size</refname> <refpurpose>Returns the maximum supported keysize of the opened mode</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mcrypt_module_get_algo_key_size</methodname> <methodparam><type>string</type><parameter>algorithm</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam> </methodsynopsis> <para> + Gets the maximum supported keysize of the opened mode. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>algorithm</parameter></term> + <listitem> + <para> + The algorithm name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lib_dir</parameter></term> + <listitem> + <para> + This optional parameter can contain the location where the mode module + is on the system. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> This function returns the maximum supported key size of the - algorithm specified in bytes. The optional - <parameter>lib_dir</parameter> parameter can contain the - location where the mode module is on the system. + algorithm specified in bytes. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/uodbc/functions/odbc-autocommit.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/uodbc/functions/odbc-autocommit.xml diff -u phpdoc/en/reference/uodbc/functions/odbc-autocommit.xml:1.5 phpdoc/en/reference/uodbc/functions/odbc-autocommit.xml:1.6 --- phpdoc/en/reference/uodbc/functions/odbc-autocommit.xml:1.5 Wed Jun 20 22:25:34 2007 +++ phpdoc/en/reference/uodbc/functions/odbc-autocommit.xml Sun Dec 30 13:40:52 2007 @@ -1,38 +1,70 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.odbc-autocommit" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>odbc_autocommit</refname> <refpurpose>Toggle autocommit behaviour</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>odbc_autocommit</methodname> <methodparam><type>resource</type><parameter>connection_id</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>OnOff</parameter></methodparam> </methodsynopsis> <para> - Without the <parameter>OnOff</parameter> parameter, this function - returns auto-commit status for - <parameter>connection_id</parameter>. Non-zero is returned if - auto-commit is on, 0 if it is off, or &false; if an error occurs. - </para> - <para> - If <parameter>OnOff</parameter> is &true;, auto-commit is enabled, - if it is &false; auto-commit is disabled. Returns &true; on success, - &false; on failure. + Toggles autocommit behaviour. </para> <para> By default, auto-commit is on for a connection. Disabling auto-commit is equivalent with starting a transaction. </para> - <simpara> - See also - <function>odbc_commit</function> and - <function>odbc_rollback</function>. - </simpara> + </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>OnOff</parameter></term> + <listitem> + <para> + If <parameter>OnOff</parameter> is &true;, auto-commit is enabled, if + it is &false; auto-commit is disabled. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Without the <parameter>OnOff</parameter> parameter, this function returns + auto-commit status for <parameter>connection_id</parameter>. Non-zero is + returned if auto-commit is on, 0 if it is off, or &false; if an error + occurs. + </para> + <para> + If <parameter>OnOff</parameter> is set, this function returns &true; on + success and &false; on failure. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>odbc_commit</function></member> + <member><function>odbc_rollback</function></member> + </simplelist> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/uodbc/functions/odbc-data-source.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/uodbc/functions/odbc-data-source.xml diff -u phpdoc/en/reference/uodbc/functions/odbc-data-source.xml:1.7 phpdoc/en/reference/uodbc/functions/odbc-data-source.xml:1.8 --- phpdoc/en/reference/uodbc/functions/odbc-data-source.xml:1.7 Wed Jun 20 22:25:34 2007 +++ phpdoc/en/reference/uodbc/functions/odbc-data-source.xml Sun Dec 30 13:40:52 2007 @@ -1,27 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry xml:id="function.odbc-data-source" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>odbc_data_source</refname> <refpurpose>Returns information about a current connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>odbc_data_source</methodname> <methodparam><type>resource</type><parameter>connection_id</parameter></methodparam> <methodparam><type>int</type><parameter>fetch_type</parameter></methodparam> </methodsynopsis> <para> - Returns &false; on error, and an array upon success. + This function will return the list of available DNS (after calling it + several times). </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function will return the list of available DNS (after calling it - several times). The - <parameter>connection_id</parameter> is required to be a valid ODBC - connection. The <parameter>fetch_type</parameter> can be one of two - constant types: SQL_FETCH_FIRST, SQL_FETCH_NEXT. Use SQL_FETCH_FIRST the - first time this function is called, thereafter use the SQL_FETCH_NEXT. + <variablelist> + <varlistentry> + <term><parameter>connection_id</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fetch_type</parameter></term> + <listitem> + <para> + The <parameter>fetch_type</parameter> can be one of two constant types: + <constant>SQL_FETCH_FIRST</constant>, <constant>SQL_FETCH_NEXT</constant>. + Use <constant>SQL_FETCH_FIRST</constant> the first time this function is + called, thereafter use the <constant>SQL_FETCH_NEXT</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &false; on error, and an array upon success. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/uodbc/functions/odbc-error.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/uodbc/functions/odbc-error.xml diff -u phpdoc/en/reference/uodbc/functions/odbc-error.xml:1.5 phpdoc/en/reference/uodbc/functions/odbc-error.xml:1.6 --- phpdoc/en/reference/uodbc/functions/odbc-error.xml:1.5 Wed Jun 20 22:25:34 2007 +++ phpdoc/en/reference/uodbc/functions/odbc-error.xml Sun Dec 30 13:40:52 2007 @@ -1,31 +1,56 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.13 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.odbc-error" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>odbc_error</refname> <refpurpose>Get the last error code</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>odbc_error</methodname> <methodparam choice="opt"><type>resource</type><parameter>connection_id</parameter></methodparam> </methodsynopsis> <simpara> - Returns a six-digit ODBC state, or an empty string if there - has been no errors. If <parameter>connection_id</parameter> is - specified, the last state of that connection is returned, else the - last state of any connection is returned. + Returns a six-digit ODBC state, or an empty string if there has been no + errors. </simpara> - <simpara> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection_id</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + If <parameter>connection_id</parameter> is specified, the last state + of that connection is returned, else the last state of any connection + is returned. + </para> + <para> This function returns meaningful value only if last odbc query failed (i.e. <function>odbc_exec</function> returned &false;). - </simpara> - <simpara> - See also: <function>odbc_errormsg</function> and - <function>odbc_exec</function>. - </simpara> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>odbc_errormsg</function></member> + <member><function>odbc_exec</function></member> + </simplelist> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/uodbc/functions/odbc-errormsg.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/uodbc/functions/odbc-errormsg.xml diff -u phpdoc/en/reference/uodbc/functions/odbc-errormsg.xml:1.5 phpdoc/en/reference/uodbc/functions/odbc-errormsg.xml:1.6 --- phpdoc/en/reference/uodbc/functions/odbc-errormsg.xml:1.5 Wed Jun 20 22:25:34 2007 +++ phpdoc/en/reference/uodbc/functions/odbc-errormsg.xml Sun Dec 30 13:40:52 2007 @@ -1,32 +1,56 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.13 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.odbc-errormsg" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>odbc_errormsg</refname> <refpurpose>Get the last error message</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>odbc_errormsg</methodname> <methodparam choice="opt"><type>resource</type><parameter>connection_id</parameter></methodparam> </methodsynopsis> <simpara> Returns a string containing the last ODBC error message, or an empty - string if there has been no errors. If - <parameter>connection_id</parameter> is specified, the last state of - that connection is returned, else the last state of any connection - is returned. + string if there has been no errors. </simpara> - <simpara> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection_id</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + If <parameter>connection_id</parameter> is specified, the last state + of that connection is returned, else the last state of any connection + is returned. + </para> + <para> This function returns meaningful value only if last odbc query failed (i.e. <function>odbc_exec</function> returned &false;). - </simpara> - <simpara> - See also: <function>odbc_error</function> and - <function>odbc_exec</function>. - </simpara> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>odbc_error</function></member> + <member><function>odbc_exec</function></member> + </simplelist> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/uodbc/functions/odbc-exec.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/uodbc/functions/odbc-exec.xml diff -u phpdoc/en/reference/uodbc/functions/odbc-exec.xml:1.5 phpdoc/en/reference/uodbc/functions/odbc-exec.xml:1.6 --- phpdoc/en/reference/uodbc/functions/odbc-exec.xml:1.5 Wed Jun 20 22:25:34 2007 +++ phpdoc/en/reference/uodbc/functions/odbc-exec.xml Sun Dec 30 13:40:52 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.odbc-exec" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>odbc_exec</refname> <refpurpose>Prepare and execute a SQL statement</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>odbc_exec</methodname> <methodparam><type>resource</type><parameter>connection_id</parameter></methodparam> @@ -15,21 +14,54 @@ <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> - Returns &false; on error. Returns an ODBC - result identifier if the SQL command was executed successfully. + Sends an SQL statement to the database server. </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>query_string</parameter></term> + <listitem> + <para> + The SQL statement. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an ODBC result identifier if the SQL command was executed + successfully, or &false; on error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - <function>odbc_exec</function> will send an SQL statement to the - database server specified by - <parameter>connection_id</parameter>. This parameter must be a - valid identifier returned by <function>odbc_connect</function> or - <function>odbc_pconnect</function>. + <simplelist> + <member><function>odbc_prepare</function></member> + <member><function>odbc_execute</function></member> + </simplelist> </para> - <simpara> - See also: <function>odbc_prepare</function> and - <function>odbc_execute</function> for multiple execution of SQL - statements. - </simpara> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/uodbc/functions/odbc-field-len.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/uodbc/functions/odbc-field-len.xml diff -u phpdoc/en/reference/uodbc/functions/odbc-field-len.xml:1.5 phpdoc/en/reference/uodbc/functions/odbc-field-len.xml:1.6 --- phpdoc/en/reference/uodbc/functions/odbc-field-len.xml:1.5 Wed Jun 20 22:25:34 2007 +++ phpdoc/en/reference/uodbc/functions/odbc-field-len.xml Sun Dec 30 13:40:52 2007 @@ -1,27 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.odbc-field-len" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>odbc_field_len</refname> <refpurpose>Get the length (precision) of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>odbc_field_len</methodname> <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> <methodparam><type>int</type><parameter>field_number</parameter></methodparam> </methodsynopsis> <para> - <function>odbc_field_len</function> will return the length of - the field referenced by number in the given ODBC result - identifier. Field numbering starts at 1. + Gets the length of the field referenced by number in the given result + identifier. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result_id</parameter></term> + <listitem> + <para> + The result identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field_number</parameter></term> + <listitem> + <para> + The field number. Field numbering starts at 1. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the field name as a string, or &false; on error. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>odbc_field_scale</function> to get the scale of a + floating point number</member> + </simplelist> </para> - <simpara> - See also: <function>odbc_field_scale</function> to get the scale of a - floating point number. - </simpara> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/uodbc/functions/odbc-free-result.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/uodbc/functions/odbc-free-result.xml diff -u phpdoc/en/reference/uodbc/functions/odbc-free-result.xml:1.5 phpdoc/en/reference/uodbc/functions/odbc-free-result.xml:1.6 --- phpdoc/en/reference/uodbc/functions/odbc-free-result.xml:1.5 Wed Jun 20 22:25:34 2007 +++ phpdoc/en/reference/uodbc/functions/odbc-free-result.xml Sun Dec 30 13:40:52 2007 @@ -1,40 +1,56 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.odbc-free-result" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>odbc_free_result</refname> <refpurpose>Free resources associated with a result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>odbc_free_result</methodname> <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> </methodsynopsis> <para> - Always returns &true;. + Free resources associated with a result. </para> <para> - <function>odbc_free_result</function> only needs to be called if - you are worried about using too much memory while your script is - running. All result memory will automatically be freed when the - script is finished. But, if you are sure you are not going to - need the result data anymore in a script, you may call - <function>odbc_free_result</function>, and the memory associated - with <parameter>result_id</parameter> will be freed. + <function>odbc_free_result</function> only needs to be called if you are + worried about using too much memory while your script is running. + All result memory will automatically be freed when the script is finished. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <note> - <simpara> - If auto-commit is disabled (see - <function>odbc_autocommit</function>) and you call - <function>odbc_free_result</function> before committing, all - pending transactions are rolled back. - </simpara> - </note> + <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> + Always returns &true;. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + If auto-commit is disabled (see <function>odbc_autocommit</function>) and + you call <function>odbc_free_result</function> before committing, all + pending transactions are rolled back. + </para> + </note> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/uodbc/functions/odbc-longreadlen.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/uodbc/functions/odbc-longreadlen.xml diff -u phpdoc/en/reference/uodbc/functions/odbc-longreadlen.xml:1.8 phpdoc/en/reference/uodbc/functions/odbc-longreadlen.xml:1.9 --- phpdoc/en/reference/uodbc/functions/odbc-longreadlen.xml:1.8 Sun Dec 30 00:22:50 2007 +++ phpdoc/en/reference/uodbc/functions/odbc-longreadlen.xml Sun Dec 30 13:40:52 2007 @@ -1,29 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.9 $ --> <refentry xml:id="function.odbc-longreadlen" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>odbc_longreadlen</refname> <refpurpose>Handling of LONG columns</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>odbc_longreadlen</methodname> <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> <methodparam><type>int</type><parameter>length</parameter></methodparam> </methodsynopsis> <para> - (ODBC SQL types affected: LONG, LONGVARBINARY) The number of - bytes returned to PHP is controlled by the parameter length. If it - is set to 0, Long column data is passed through to the - client. + Enables handling of LONG and LONGVARBINARY columns. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result_id</parameter></term> + <listitem> + <para> + The result identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The number of bytes returned to PHP is controlled by the parameter + length. If it is set to 0, Long column data is passed through to the + client. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <note> - <simpara> + <para> Handling of LONGVARBINARY columns is also affected by <function>odbc_binmode</function>. - </simpara> + </para> </note> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/uodbc/functions/odbc-num-rows.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/uodbc/functions/odbc-num-rows.xml diff -u phpdoc/en/reference/uodbc/functions/odbc-num-rows.xml:1.4 phpdoc/en/reference/uodbc/functions/odbc-num-rows.xml:1.5 --- phpdoc/en/reference/uodbc/functions/odbc-num-rows.xml:1.4 Wed Jun 20 22:25:34 2007 +++ phpdoc/en/reference/uodbc/functions/odbc-num-rows.xml Sun Dec 30 13:40:52 2007 @@ -1,31 +1,54 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.odbc-num-rows" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>odbc_num_rows</refname> <refpurpose>Number of rows in a result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>odbc_num_rows</methodname> <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> </methodsynopsis> <para> - <function>odbc_num_rows</function> will return the number of rows - in an ODBC result. This function will return -1 on error. For - INSERT, UPDATE and DELETE statements - <function>odbc_num_rows</function> returns the number of rows - affected. For a SELECT clause this <literal>can</literal> be - the number of rows available. + Gets the number of rows in a result. For INSERT, UPDATE and DELETE + statements <function>odbc_num_rows</function> returns the number of rows + affected. For a SELECT clause this <literal>can</literal> be the number + of rows available. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Note: Using <function>odbc_num_rows</function> to determine the - number of rows available after a SELECT will return -1 with many - drivers. + <variablelist> + <varlistentry> + <term><parameter>result_id</parameter></term> + <listitem> + <para> + The result identifier returned by <function>odbc_exec</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of rows in an ODBC result. + This function will return -1 on error. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + Using <function>odbc_num_rows</function> to determine the number of rows + available after a SELECT will return -1 with many drivers. + </para> + </note> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/uodbc/functions/odbc-primarykeys.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/uodbc/functions/odbc-primarykeys.xml diff -u phpdoc/en/reference/uodbc/functions/odbc-primarykeys.xml:1.4 phpdoc/en/reference/uodbc/functions/odbc-primarykeys.xml:1.5 --- phpdoc/en/reference/uodbc/functions/odbc-primarykeys.xml:1.4 Wed Jun 20 22:25:34 2007 +++ phpdoc/en/reference/uodbc/functions/odbc-primarykeys.xml Sun Dec 30 13:40:52 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.odbc-primarykeys" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>odbc_primarykeys</refname> - <refpurpose>Returns a result identifier that can be used to fetch the column names that comprise the primary key for a table</refpurpose> + <refpurpose>Gets the primary keys for a table</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>odbc_primarykeys</methodname> <methodparam><type>resource</type><parameter>connection_id</parameter></methodparam> @@ -16,9 +15,50 @@ <methodparam><type>string</type><parameter>table</parameter></methodparam> </methodsynopsis> <para> - Returns the column names that comprise the primary key for a - table. Returns an ODBC result identifier or - &false; on failure. + Returns a result identifier that can be used to fetch the column names + that comprise the primary key for a table. + </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> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>owner</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>table</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </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: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/uodbc/functions/odbc-result-all.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/uodbc/functions/odbc-result-all.xml diff -u phpdoc/en/reference/uodbc/functions/odbc-result-all.xml:1.4 phpdoc/en/reference/uodbc/functions/odbc-result-all.xml:1.5 --- phpdoc/en/reference/uodbc/functions/odbc-result-all.xml:1.4 Wed Jun 20 22:25:34 2007 +++ phpdoc/en/reference/uodbc/functions/odbc-result-all.xml Sun Dec 30 13:40:52 2007 @@ -1,28 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.odbc-result-all" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>odbc_result_all</refname> <refpurpose>Print result as HTML table</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>odbc_result_all</methodname> <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>format</parameter></methodparam> </methodsynopsis> <para> - Returns the number of rows in the result or - &false; on error. + Prints all rows from a result identifier produced by + <function>odbc_exec</function>. The result is printed in HTML table format. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result_id</parameter></term> + <listitem> + <para> + The result identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>format</parameter></term> + <listitem> + <para> + Additional overall table formatting. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>odbc_result_all</function> will print all rows from a - result identifier produced by <function>odbc_exec</function>. The - result is printed in HTML table format. With the optional string - argument <parameter>format</parameter>, additional overall table - formatting can be done. + Returns the number of rows in the result or &false; on error. </para> </refsect1> </refentry>
« previous php.doc.cvs (#930) next »