1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH WCSCOLL 3C "Aug 14, 2002"
  11 .SH NAME
  12 wcscoll, wscoll \- wide character string comparison using collating information
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <wchar.h>
  17 
  18 \fBint\fR \fBwcscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
  19 .fi
  20 
  21 .LP
  22 .nf
  23 \fBint\fR \fBwscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
  24 .fi
  25 
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBwcscoll()\fR and  \fBwscoll()\fR functions compare the wide character
  30 string pointed to by \fIws1\fR to the wide character string pointed to by
  31 \fIws2\fR, both interpreted as appropriate to the \fBLC_COLLATE\fR category of
  32 the current locale.
  33 .sp
  34 .LP
  35 The \fBwcscoll()\fR and \fBwscoll()\fR functions do not change the setting of
  36 \fBerrno\fR if successful.
  37 .sp
  38 .LP
  39 An application wanting to check for error situations should set \fBerrno\fR to
  40 0 before calling \fBwcscoll()\fR or \fBwscoll()\fR.  If \fBerrno\fR is non-zero
  41 on return, an error has occurred.
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 Upon successful completion, \fBwcscoll()\fR and \fBwscoll()\fR return an
  46 integer greater than, equal to, or less than 0, depending upon whether the wide
  47 character string pointed to by \fIws1\fR is greater than, equal to, or less
  48 than the wide character string pointed to by \fIws2\fR, when both are
  49 interpreted as appropriate to the current locale. On error, \fBwcscoll()\fR and
  50 \fBwscoll()\fR may set \fBerrno\fR, but no return value is reserved to indicate
  51 an error.
  52 .SH ERRORS
  53 .sp
  54 .LP
  55 The \fBwcscoll()\fR and \fBwscoll()\fR functions may fail if:
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBEINVAL\fR\fR
  60 .ad
  61 .RS 10n
  62 The \fIws1\fR or \fIws2\fR arguments contain wide character codes outside the
  63 domain of the collating sequence.
  64 .RE
  65 
  66 .SH USAGE
  67 .sp
  68 .LP
  69 The \fBwcsxfrm\fR(3C) and \fBwcscmp\fR(3C) functions should be used for sorting
  70 large lists.
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5) for descriptions of the following attributes:
  75 .sp
  76 
  77 .sp
  78 .TS
  79 box;
  80 l | l
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 CSI     Enabled
  85 _
  86 Interface Stability     \fBwcscoll()\fR is Standard
  87 _
  88 MT-Level        MT-Safe with exceptions
  89 .TE
  90 
  91 .sp
  92 .LP
  93 The \fBwcscoll()\fR and \fBwscoll()\fR functions can be used safely in
  94 multithreaded applications as long as \fBsetlocale\fR(3C) is not being called
  95 to change the locale.
  96 .SH SEE ALSO
  97 .sp
  98 .LP
  99 \fBsetlocale\fR(3C), \fBwcscmp\fR(3C), \fBwcsxfrm\fR(3C), \fBattributes\fR(5),
 100 \fBstandards\fR(5)