<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Rounds a variant to the specified number of decimal places</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.variant-pow.html">variant_pow</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.variant-set-type.html">variant_set_type</a></div>
<div class="up"><a href="ref.com.html">COM Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.variant-round" class="refentry">
<div class="refnamediv">
<h1 class="refname">variant_round</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">variant_round</span> — <span class="dc-title">Rounds a variant to the specified number of decimal places</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.variant-round-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>variant_round</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$variant</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$decimals</code></span>
)</div>
<p class="para rdfs-comment">
Returns the value of <em><code class="parameter">variant</code></em> rounded to
<em><code class="parameter">decimals</code></em> decimal places.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.variant-round-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">variant</code></em></span>
<dd>
<p class="para">
The variant.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">decimals</code></em></span>
<dd>
<p class="para">
Number of decimal places.
</p>
</dd>
</dt>
</dl>
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
As with all the variant arithmetic functions, the parameters for this function
can be either a PHP native type (integer, string, floating point, boolean or
<strong><code>NULL</code></strong>), or an instance of a COM, VARIANT or DOTNET class. PHP native types
will be converted to variants using the same rules as found in the constructor
for the <a href="class.variant.html" class="xref">VARIANT</a> class. COM and DOTNET objects
will have the value of their default property taken and used as the variant value.
</p>
<p class="para">
The variant arithmetic functions are wrappers around the similarly named
functions in the COM library; for more information on these functions, consult
the MSDN library. The PHP functions are named slightly differently; for example
<span class="function"><a href="function.variant-add.html" class="function">variant_add()</a></span> in PHP corresponds to <em>VarAdd()
</em> in the MSDN documentation.
</p>
</p></blockquote>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.variant-round-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the rounded value.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.variant-round-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.round.html" class="function" rel="rdfs-seeAlso">round()</a> - Rounds a float</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.variant-pow.html">variant_pow</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.variant-set-type.html">variant_set_type</a></div>
<div class="up"><a href="ref.com.html">COM Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
