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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>variant_div</methodname>
   <methodparam><type>mixed</type><parameter>left</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>right</parameter></methodparam>
  </methodsynopsis>
  <para>
   Divides <parameter>left</parameter> by <parameter>right</parameter> and
   returns the result.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>left</parameter></term>
     <listitem>
      <para>
       The left operand.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>right</parameter></term>
     <listitem>
      <para>
       The right operand.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
   &com.variant-arith;
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <table>
    <title>Variant Division Rules</title>
    <tgroup cols="2">
     <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 <classname>com_exception</classname> 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 <classname>com_exception</classname> with code <constant>DISP_E_OVERFLOW</constant>
       is thrown</entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>variant_idiv</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
-->