php-doc-en/reference/com/functions/variant-div.xml

100 lines
2.9 KiB
XML
Raw Normal View History

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.variant-div" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_div</refname>
<refpurpose>
Returns the result from dividing two variants
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>variant_div</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Divides <parameter>left</parameter> by <parameter>right</parameter> and
returns the result, subject to the following rules:
<table>
<title>Variant Division Rules</title>
<tgroup cols="2">
<thead>
<row>
<entry>If</entry>
<entry>Then</entry>
</row>
</thead>
<tbody>
<row>
<entry>Both expressions are of the string, date, character, boolean type</entry>
<entry>Double is returned</entry>
</row>
<row>
<entry>One expression is a string type and the other a
character</entry>
<entry>Division and a double is returned</entry>
</row>
<row>
<entry>One expression is numeric and the other is a string</entry>
<entry>Division and a double is returned.</entry>
</row>
<row>
<entry>Both expressions are numeric</entry>
<entry>Division and a double is returned</entry>
</row>
<row>
<entry>Either expression is NULL</entry>
<entry>NULL is returned</entry>
</row>
<row>
<entry><parameter>right</parameter> is empty and
<parameter>left</parameter> is anything but empty</entry>
<entry>A com_exception with code <constant>DISP_E_DIVBYZERO</constant>
is thrown</entry>
</row>
<row>
<entry><parameter>left</parameter> is empty and
<parameter>right</parameter> is anything but empty.</entry>
<entry>0 as type double is returned</entry>
</row>
<row>
<entry>Both expressions are empty</entry>
<entry>A com_exception with code <constant>DISP_E_OVERFLOW</constant>
is thrown</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
&com.variant-arith;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->