.\" .\" 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 .\" http://www.opengroup.org/bookstore/. .\" .\" 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 SunOS 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. .\" .\" This notice shall appear on any product containing this material. .\" .\" 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. .\" .\" 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. .\" .\" 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] .\" .\" .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. .\" Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved .\" Copyright 2014 Garrett D'Amore .\" .TH WCSCOLL 3C "November 8, 2020" .SH NAME wcscoll, wcscoll_l, wscoll \- wide character string comparison using collating information .SH SYNOPSIS .nf #include \fBint\fR \fBwcscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR); .fi .LP .nf \fBint\fR \fBwcscoll_l\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR, \fBlocale_t\fR \fIloc\fR); .fi .LP .nf \fBint\fR \fBwscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR); .fi .SH DESCRIPTION The \fBwcscoll()\fR, \fBwcscoll_l()\fR, and \fBwscoll()\fR functions compare the wide character string pointed to by \fIws1\fR to the wide character string pointed to by \fIws2\fR, both interpreted as appropriate to the \fBLC_COLLATE\fR locale category. .LP These functions do not change the setting of \fBerrno\fR if successful. .LP An application wanting to check for error situations should set \fBerrno\fR to 0 before calling these functions. If \fBerrno\fR is non-zero on return, an error has occurred. .LP The function \fBwcsoll_l()\fR behaves identically to \fBwcsoll\fR(), except instead of operating in the current locale, it operates in the locale specified by \fIloc\fR. .SH RETURN VALUES Upon successful completion, these functions return an integer greater than, equal to, or less than 0, depending upon whether the wide character string pointed to by \fIws1\fR is greater than, equal to, or less than the wide character string pointed to by \fIws2\fR, when both are interpreted as appropriate to the current locale, or the locale specified by \fIloc\fR. On error, they set \fBerrno\fR, but no return value is reserved to indicate an error. .SH ERRORS The \fBwcscoll()\fR, \fBwcscoll_l()\fR and \fBwscoll()\fR functions may fail if: .sp .ne 2 .na \fB\fBEINVAL\fR\fR .ad .RS 10n The \fIws1\fR or \fIws2\fR arguments contain wide character codes outside the domain of the collating sequence. .RE .SH USAGE The \fBwcsxfrm\fR(3C) and \fBwcscmp\fR(3C) functions should be used for sorting large lists, or when performing many comparisons on the same strings. .SH ATTRIBUTES See \fBattributes\fR(7) for descriptions of the following attributes: .TS box; c | c l | l . ATTRIBUTE TYPE ATTRIBUTE VALUE _ CSI Enabled _ Interface Stability See below. _ MT-Level MT-Safe .TE .LP The \fBwcscoll()\fR and \fBwcscoll_l()\fR functions are Standard. The \fBwscoll()\fR function is Committed. .SH SEE ALSO .BR newlocale (3C), .BR setlocale (3C), .BR uselocale (3C), .BR wcscmp (3C), .BR wcsxfrm (3C), .BR attributes (7), .BR standards (7)