177 lines
6.2 KiB
HTML
177 lines
6.2 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy, see www.w3.org">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
|
|
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
|
|
<title>strcoll</title>
|
|
</head>
|
|
<body bgcolor="white">
|
|
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
|
|
</script>
|
|
|
|
<basefont size="3"> <a name="strcoll"></a> <a name="tag_03_723"></a><!-- strcoll -->
|
|
<!--header start-->
|
|
<center><font size="2">The Open Group Base Specifications Issue 6<br>
|
|
IEEE Std 1003.1-2001<br>
|
|
Copyright © 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
|
|
|
|
<!--header end-->
|
|
<hr size="2" noshade>
|
|
<h4><a name="tag_03_723_01"></a>NAME</h4>
|
|
|
|
<blockquote>strcoll - string comparison using collating information</blockquote>
|
|
|
|
<h4><a name="tag_03_723_02"></a>SYNOPSIS</h4>
|
|
|
|
<blockquote class="synopsis">
|
|
<p><code><tt>#include <<a href="../basedefs/string.h.html">string.h</a>><br>
|
|
<br>
|
|
int strcoll(const char *</tt><i>s1</i><tt>, const char *</tt><i>s2</i><tt>);<br>
|
|
</tt></code></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_723_03"></a>DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<div class="box"><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]"
|
|
border="0"> The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the
|
|
requirements described here and the ISO C standard is unintentional. This volume of IEEE Std 1003.1-2001 defers to
|
|
the ISO C standard. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></div>
|
|
|
|
<p>The <i>strcoll</i>() function shall compare the string pointed to by <i>s1</i> to the string pointed to by <i>s2</i>, both
|
|
interpreted as appropriate to the <i>LC_COLLATE</i> category of the current locale.</p>
|
|
|
|
<p><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0"> The
|
|
<i>strcoll</i>() function shall not change the setting of <i>errno</i> if successful.</p>
|
|
|
|
<p>Since no return value is reserved to indicate an error, an application wishing to check for error situations should set
|
|
<i>errno</i> to 0, then call <i>strcoll</i>(), then check <i>errno</i>. <img src="../images/opt-end.gif" alt="[Option End]" border=
|
|
"0"></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_723_04"></a>RETURN VALUE</h4>
|
|
|
|
<blockquote>
|
|
<p>Upon successful completion, <i>strcoll</i>() shall return an integer greater than, equal to, or less than 0, according to
|
|
whether the string pointed to by <i>s1</i> is greater than, equal to, or less than the string pointed to by <i>s2</i> when both are
|
|
interpreted as appropriate to the current locale. <sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src=
|
|
"../images/opt-start.gif" alt="[Option Start]" border="0"> On error, <i>strcoll</i>() may set <i>errno</i>, but no return
|
|
value is reserved to indicate an error. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_723_05"></a>ERRORS</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>strcoll</i>() function may fail if:</p>
|
|
|
|
<dl compact>
|
|
<dt>[EINVAL]</dt>
|
|
|
|
<dd><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
|
|
The <i>s1</i> or <i>s2</i> arguments contain characters outside the domain of the collating sequence. <img src=
|
|
"../images/opt-end.gif" alt="[Option End]" border="0"></dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<hr>
|
|
<div class="box"><em>The following sections are informative.</em></div>
|
|
|
|
<h4><a name="tag_03_723_06"></a>EXAMPLES</h4>
|
|
|
|
<blockquote>
|
|
<h5><a name="tag_03_723_06_01"></a>Comparing Nodes</h5>
|
|
|
|
<p>The following example uses an application-defined function, <i>node_compare</i>(), to compare two nodes based on an alphabetical
|
|
ordering of the <i>string</i> field.</p>
|
|
|
|
<pre>
|
|
<tt>#include <string.h>
|
|
...
|
|
struct node { /* These are stored in the table. */
|
|
char *string;
|
|
int length;
|
|
};
|
|
...
|
|
int node_compare(const void *node1, const void *node2)
|
|
{
|
|
return strcoll(((const struct node *)node1)->string,
|
|
((const struct node *)node2)->string);
|
|
}
|
|
...
|
|
</tt>
|
|
</pre>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_723_07"></a>APPLICATION USAGE</h4>
|
|
|
|
<blockquote>
|
|
<p>The <a href="../functions/strxfrm.html"><i>strxfrm</i>()</a> and <a href="../functions/strcmp.html"><i>strcmp</i>()</a>
|
|
functions should be used for sorting large lists.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_723_08"></a>RATIONALE</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_723_09"></a>FUTURE DIRECTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_723_10"></a>SEE ALSO</h4>
|
|
|
|
<blockquote>
|
|
<p><a href="strcmp.html"><i>strcmp</i>()</a> , <a href="strxfrm.html"><i>strxfrm</i>()</a> , the Base Definitions volume of
|
|
IEEE Std 1003.1-2001, <a href="../basedefs/string.h.html"><i><string.h></i></a></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_723_11"></a>CHANGE HISTORY</h4>
|
|
|
|
<blockquote>
|
|
<p>First released in Issue 3.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_723_12"></a>Issue 5</h4>
|
|
|
|
<blockquote>
|
|
<p>The DESCRIPTION is updated to indicate that <i>errno</i> does not change if the function is successful.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_723_13"></a>Issue 6</h4>
|
|
|
|
<blockquote>
|
|
<p>Extensions beyond the ISO C standard are marked.</p>
|
|
|
|
<p>The following new requirements on POSIX implementations derive from alignment with the Single UNIX Specification:</p>
|
|
|
|
<ul>
|
|
<li>
|
|
<p>The [EINVAL] optional error condition is added.</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>An example is added.</p>
|
|
</blockquote>
|
|
|
|
<div class="box"><em>End of informative text.</em></div>
|
|
|
|
<hr>
|
|
<hr size="2" noshade>
|
|
<center><font size="2"><!--footer start-->
|
|
UNIX ® is a registered Trademark of The Open Group.<br>
|
|
POSIX ® is a registered Trademark of The IEEE.<br>
|
|
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
|
|
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
|
|
]</font></center>
|
|
|
|
<!--footer end-->
|
|
<hr size="2" noshade>
|
|
</body>
|
|
</html>
|
|
|