Print this page
11586 NAME field in man pages should match what's installed
@@ -42,15 +42,14 @@
.\"
.\" 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 <garrett@damore.org>
.\"
-.TH WCSCOLL 3C "April 9, 2016"
+.TH WCSCOLL 3C "Aug 20, 2019"
.SH NAME
-wcscoll, wcscoll_l wscoll \- wide character string comparison using collating information
+wcscoll, wcscoll_l, wscoll \- wide character string comparison using collating information
.SH SYNOPSIS
-.LP
.nf
#include <wchar.h>
\fBint\fR \fBwcscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
.fi
@@ -61,11 +60,10 @@
.LP
.nf
\fBint\fR \fBwscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
.fi
.SH DESCRIPTION
-.LP
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.
@@ -78,36 +76,32 @@
.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
-.LP
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
-.LP
The \fBwcscoll()\fR, \fBwcscoll_l()\fR and \fBwscoll()\fR functions may fail if:
.sp
.ne 2
.na
-\fB\fBEINVAL\fR\fR
+\fBEINVAL\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
-.LP
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
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.TS
box;
c | c
l | l .
@@ -122,9 +116,8 @@
.LP
The \fBwcscoll()\fR and \fBwcscoll_l()\fR functions are Standard.
The \fBwscoll()\fR function is Committed.
.SH SEE ALSO
-.LP
\fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
\fBwcscmp\fR(3C), \fBwcsxfrm\fR(3C), \fBattributes\fR(5),
\fBstandards\fR(5)