php-doc-en/reference/com/functions/variant-add.xml
2011-08-16 11:38:58 +00:00

118 lines
2.9 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.variant-add" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_add</refname>
<refpurpose>"Adds" two variant values together and returns the result</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_add</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Adds <parameter>left</parameter> to <parameter>right</parameter> using
the following rules (taken from the MSDN library), which correspond to
those of Visual Basic:
<table>
<title>Variant Addition Rules</title>
<tgroup cols="2">
<thead>
<row>
<entry>If</entry>
<entry>Then</entry>
</row>
</thead>
<tbody>
<row>
<entry>Both expressions are of the string type</entry>
<entry>Concatenation</entry>
</row>
<row>
<entry>One expression is a string type and the other a
character</entry>
<entry>Addition</entry>
</row>
<row>
<entry>One expression is numeric and the other is a string</entry>
<entry>Addition</entry>
</row>
<row>
<entry>Both expressions are numeric</entry>
<entry>Addition</entry>
</row>
<row>
<entry>Either expression is NULL</entry>
<entry>NULL is returned</entry>
</row>
<row>
<entry>Both expressions are empty</entry>
<entry>Integer subtype is returned</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
&com.variant-arith;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the result.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>variant_sub</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->