1 '\" te
   2 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
   3 .\"  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   4 .\" 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
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH WCSCOLL 3C "Jun 25, 2014"
  12 .SH NAME
  13 wcscoll, wcscoll_l wscoll \- wide character string comparison using collating information
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <wchar.h>
  18 
  19 \fBint\fR \fBwcscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
  20 .fi
  21 .LP
  22 .nf
  23 \fBint\fR \fBwcscoll_l\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR, \fBlocale_t\fR \fIloc\fR);
  24 .fi
  25 .LP
  26 .nf
  27 \fBint\fR \fBwscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
  28 .fi
  29 .SH DESCRIPTION
  30 .LP
  31 The \fBwcscoll()\fR, \fBwcscoll_l()\fR, and \fBwscoll()\fR functions compare
  32 the wide character
  33 string pointed to by \fIws1\fR to the wide character string pointed to by
  34 \fIws2\fR, both interpreted as appropriate to the \fBLC_COLLATE\fR locale
  35 category.
  36 .LP
  37 These  functions do not change the setting of \fBerrno\fR if successful.
  38 .LP
  39 An application wanting to check for error situations should set \fBerrno\fR to
  40 0 before calling these functions.  If \fBerrno\fR is non-zero
  41 on return, an error has occurred.
  42 .LP
  43 The function \fBwcsoll_l()\fR behaves identically to \fBwcsoll\fR(), except
  44 instead of operating in the current locale, it operates in the locale
  45 specified by \fIloc\fR.
  46 .SH RETURN VALUES
  47 .LP
  48 Upon successful completion, these functions return an
  49 integer greater than, equal to, or less than 0, depending upon whether the wide
  50 character string pointed to by \fIws1\fR is greater than, equal to, or less
  51 than the wide character string pointed to by \fIws2\fR, when both are
  52 interpreted as appropriate to the the current locale, or the locale
  53 specified by \fIloc\fR. On error, 
  54 they set \fBerrno\fR, but no return value is reserved to indicate an error.
  55 .SH ERRORS
  56 .LP
  57 The \fBwcscoll()\fR, \fBwcscoll_l()\fR and \fBwscoll()\fR functions may fail if:
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBEINVAL\fR\fR
  62 .ad
  63 .RS 10n
  64 The \fIws1\fR or \fIws2\fR arguments contain wide character codes outside the
  65 domain of the collating sequence.
  66 .RE
  67 .SH USAGE
  68 .sp
  69 .LP
  70 The \fBwcsxfrm\fR(3C) and \fBwcscmp\fR(3C) functions should be used for sorting
  71 large lists, or when performing many comparisions on the same strings.
  72 .SH ATTRIBUTES
  73 .LP
  74 See \fBattributes\fR(5) for descriptions of the following attributes:
  75 .TS
  76 box;
  77 c | c
  78 l | l .
  79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  80 _
  81 CSI     Enabled
  82 _
  83 Interface Stability     See below.
  84 _
  85 MT-Level        MT-Safe
  86 .TE
  87 
  88 .LP
  89 The \fBwcscoll()\fR and \fBwcscoll_l()\fR functions are Standard.
  90 The \fBwscoll()\fR function is Committed.
  91 .SH SEE ALSO
  92 .LP
  93 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
  94 \fBwcscmp\fR(3C), \fBwcsxfrm\fR(3C), \fBattributes\fR(5),
  95 \fBstandards\fR(5)