diff options
Diffstat (limited to 'upstream/archlinux/man3p/wcscoll.3p')
-rw-r--r-- | upstream/archlinux/man3p/wcscoll.3p | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/wcscoll.3p b/upstream/archlinux/man3p/wcscoll.3p new file mode 100644 index 00000000..544cc31e --- /dev/null +++ b/upstream/archlinux/man3p/wcscoll.3p @@ -0,0 +1,137 @@ +'\" et +.TH WCSCOLL "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual" +.\" +.SH PROLOG +This manual page is part of the POSIX Programmer's Manual. +The Linux implementation of this interface may differ (consult +the corresponding Linux manual page for details of Linux behavior), +or the interface may not be implemented on Linux. +.\" +.SH NAME +wcscoll, +wcscoll_l +\(em wide-character string comparison using collating information +.SH SYNOPSIS +.LP +.nf +#include <wchar.h> +.P +int wcscoll(const wchar_t *\fIws1\fP, const wchar_t *\fIws2\fP); +int wcscoll_l(const wchar_t *\fIws1\fP, const wchar_t *\fIws2\fP, + locale_t \fIlocale\fP); +.fi +.SH DESCRIPTION +For +\fIwcscoll\fR(): +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 POSIX.1\(hy2017 defers to the ISO\ C standard. +.P +The +\fIwcscoll\fR() +and +\fIwcscoll_l\fR() +functions shall compare the wide-character string pointed to by +.IR ws1 +to the wide-character string pointed to by +.IR ws2 , +both interpreted as appropriate to the +.IR LC_COLLATE +category of the current locale, +or the locale represented by +.IR locale , +respectively. +.P +The +\fIwcscoll\fR() +and +\fIwcscoll_l\fR() +functions shall not change the setting of +.IR errno +if successful. +.P +An application wishing to check for error situations should set +.IR errno +to 0 before calling +\fIwcscoll\fR() +or +\fIwcscoll_l\fR(). +If +.IR errno +is non-zero on return, an error has occurred. +.P +The behavior is undefined if the +.IR locale +argument to +\fIwcscoll_l\fR() +is the special locale object LC_GLOBAL_LOCALE or is not a valid locale +object handle. +.SH "RETURN VALUE" +Upon successful completion, +\fIwcscoll\fR() +and +\fIwcscoll_l\fR() +shall return an integer greater than, equal to, or less than 0, +according to whether the wide-character string pointed to by +.IR ws1 +is greater than, equal to, or less than the wide-character string +pointed to by +.IR ws2 , +when both are interpreted as appropriate to the current locale, +or to the locale represented by +.IR locale , +respectively. On error, +\fIwcscoll\fR() +and +\fIwcscoll_l\fR() +shall set +.IR errno , +but no return value is reserved to indicate an error. +.SH ERRORS +These functions may fail if: +.TP +.BR EINVAL +The +.IR ws1 +or +.IR ws2 +arguments contain wide-character codes outside the domain of the +collating sequence. +.LP +.IR "The following sections are informative." +.SH EXAMPLES +None. +.SH "APPLICATION USAGE" +The +\fIwcsxfrm\fR() +and +\fIwcscmp\fR() +functions should be used for sorting large lists. +.SH RATIONALE +None. +.SH "FUTURE DIRECTIONS" +None. +.SH "SEE ALSO" +.IR "\fIwcscmp\fR\^(\|)", +.IR "\fIwcsxfrm\fR\^(\|)" +.P +The Base Definitions volume of POSIX.1\(hy2017, +.IR "\fB<wchar.h>\fP" +.\" +.SH COPYRIGHT +Portions of this text are reprinted and reproduced in electronic form +from IEEE Std 1003.1-2017, Standard for Information Technology +-- Portable Operating System Interface (POSIX), The Open Group Base +Specifications Issue 7, 2018 Edition, +Copyright (C) 2018 by the Institute of +Electrical and Electronics Engineers, Inc and The Open Group. +In the event of any discrepancy between this version 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 . +.PP +Any typographical or formatting errors that appear +in this page are most likely +to have been introduced during the conversion of the source files to +man page format. To report such errors, see +https://www.kernel.org/doc/man-pages/reporting_bugs.html . |