<!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>Compares two variants</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.variant-cat.html">variant_cat</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.variant-date-from-timestamp.html">variant_date_from_timestamp</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-cmp" class="refentry">
<div class="refnamediv">
<h1 class="refname">variant_cmp</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">variant_cmp</span> — <span class="dc-title">Compares two variants</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.variant-cmp-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>variant_cmp</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">$left</code></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">$right</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$lcid</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
]] )</div>
<p class="para rdfs-comment">
Compares <em><code class="parameter">left</code></em> with <em><code class="parameter">right</code></em>.
</p>
<p class="para">
This function will only compare scalar values, not arrays or variant records.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.variant-cmp-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">left</code></em></span>
<dd>
<p class="para">
The left operand.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">right</code></em></span>
<dd>
<p class="para">
The right operand.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">lcid</code></em></span>
<dd>
<p class="para">
A valid Locale Identifier to use when comparing strings (this affects
string collation).
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">flags</code></em> can be one or more of the following values
OR'd together, and affects string comparisons:
<table class="doctable table">
<caption><strong>Variant Comparision Flags</strong></caption>
<thead>
<tr>
<th>value</th>
<th>meaning</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><strong><code>NORM_IGNORECASE</code></strong></td>
<td>Compare case insensitively</td>
</tr>
<tr>
<td><strong><code>NORM_IGNORENONSPACE</code></strong></td>
<td>Ignore nonspacing characters</td>
</tr>
<tr>
<td><strong><code>NORM_IGNORESYMBOLS</code></strong></td>
<td>Ignore symbols</td>
</tr>
<tr>
<td><strong><code>NORM_IGNOREWIDTH</code></strong></td>
<td>Ignore string width</td>
</tr>
<tr>
<td><strong><code>NORM_IGNOREKANATYPE</code></strong></td>
<td>Ignore Kana type</td>
</tr>
<tr>
<td><strong><code>NORM_IGNOREKASHIDA</code></strong></td>
<td>Ignore Arabic kashida characters</td>
</tr>
</tbody>
</table>
</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-cmp-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns one of the following:
<table class="doctable table">
<caption><strong>Variant Comparision Results</strong></caption>
<thead>
<tr>
<th>value</th>
<th>meaning</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><strong><code>VARCMP_LT</code></strong></td>
<td><em><code class="parameter">left</code></em> is less than
<em><code class="parameter">right</code></em>
</td>
</tr>
<tr>
<td><strong><code>VARCMP_EQ</code></strong></td>
<td><em><code class="parameter">left</code></em> is equal to
<em><code class="parameter">right</code></em>
</td>
</tr>
<tr>
<td><strong><code>VARCMP_GT</code></strong></td>
<td><em><code class="parameter">left</code></em> is greater than
<em><code class="parameter">right</code></em>
</td>
</tr>
<tr>
<td><strong><code>VARCMP_NULL</code></strong></td>
<td>Either <em><code class="parameter">left</code></em>,
<em><code class="parameter">right</code></em> or both are <strong><code>NULL</code></strong>
</td>
</tr>
</tbody>
</table>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.variant-cat.html">variant_cat</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.variant-date-from-timestamp.html">variant_date_from_timestamp</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>
