<!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>Locale based string comparison</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.strcmp.html">strcmp</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.strcspn.html">strcspn</a></div>
<div class="up"><a href="ref.strings.html">String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.strcoll" class="refentry">
<div class="refnamediv">
<h1 class="refname">strcoll</h1>
<p class="verinfo">(PHP 4 >= 4.0.5, PHP 5)</p><p class="refpurpose"><span class="refname">strcoll</span> — <span class="dc-title">Locale based string comparison</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.strcoll-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>strcoll</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str1</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$str2</code></span>
)</div>
<p class="para rdfs-comment">
Note that this comparison is case sensitive, and unlike
<span class="function"><a href="function.strcmp.html" class="function">strcmp()</a></span> this function is not binary safe.
</p>
<p class="para">
<span class="function"><strong>strcoll()</strong></span> uses the current locale for doing the
comparisons. If the current locale is C or POSIX, this function is
equivalent to <span class="function"><a href="function.strcmp.html" class="function">strcmp()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.strcoll-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">str1</code></em></span>
<dd>
<p class="para">
The first string.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">str2</code></em></span>
<dd>
<p class="para">
The second string.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.strcoll-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns < 0 if <em><code class="parameter">str1</code></em> is less than
<em><code class="parameter">str2</code></em>; > 0 if
<em><code class="parameter">str1</code></em> is greater than
<em><code class="parameter">str2</code></em>, and 0 if they are equal.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.strcoll-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>4.2.3</td>
<td>
This function now works on win32.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.strcoll-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.preg-match.html" class="function" rel="rdfs-seeAlso">preg_match()</a> - Perform a regular expression match</span></li>
<li class="member"> <span class="function"><a href="function.strcmp.html" class="function" rel="rdfs-seeAlso">strcmp()</a> - Binary safe string comparison</span></li>
<li class="member"> <span class="function"><a href="function.strcasecmp.html" class="function" rel="rdfs-seeAlso">strcasecmp()</a> - Binary safe case-insensitive string comparison</span></li>
<li class="member"> <span class="function"><a href="function.substr.html" class="function" rel="rdfs-seeAlso">substr()</a> - Return part of a string</span></li>
<li class="member"> <span class="function"><a href="function.stristr.html" class="function" rel="rdfs-seeAlso">stristr()</a> - Case-insensitive strstr</span></li>
<li class="member"> <span class="function"><a href="function.strncasecmp.html" class="function" rel="rdfs-seeAlso">strncasecmp()</a> - Binary safe case-insensitive string comparison of the first n characters</span></li>
<li class="member"> <span class="function"><a href="function.strncmp.html" class="function" rel="rdfs-seeAlso">strncmp()</a> - Binary safe string comparison of the first n characters</span></li>
<li class="member"> <span class="function"><a href="function.strstr.html" class="function" rel="rdfs-seeAlso">strstr()</a> - Find the first occurrence of a string</span></li>
<li class="member"> <span class="function"><a href="function.setlocale.html" class="function" rel="rdfs-seeAlso">setlocale()</a> - Set locale information</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.strcmp.html">strcmp</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.strcspn.html">strcspn</a></div>
<div class="up"><a href="ref.strings.html">String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
