WCSCOLL(3)                 POSIX Programmer's Manual                WCSCOLL(3)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NNAAMMEE
       wcscoll, wcscoll_l -- wide-character string comparison using collating
       information

SSYYNNOOPPSSIISS
       #include <wchar.h>

       int wcscoll(const wchar_t *_w_s_1, const wchar_t *_w_s_2);
       int wcscoll_l(const wchar_t *_w_s_1, const wchar_t *_w_s_2,
           locale_t _l_o_c_a_l_e);

DDEESSCCRRIIPPTTIIOONN
       For _w_c_s_c_o_l_l(): 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-2017 defers to the ISO C standard.

       The _w_c_s_c_o_l_l() and _w_c_s_c_o_l_l___l() functions shall compare the wide-
       character string pointed to by _w_s_1 to the wide-character string pointed
       to by _w_s_2, both interpreted as appropriate to the _L_C___C_O_L_L_A_T_E category
       of the current locale, or the locale represented by _l_o_c_a_l_e,
       respectively.

       The _w_c_s_c_o_l_l() and _w_c_s_c_o_l_l___l() functions shall not change the setting of
       _e_r_r_n_o if successful.

       An application wishing to check for error situations should set _e_r_r_n_o
       to 0 before calling _w_c_s_c_o_l_l() or _w_c_s_c_o_l_l___l().  If _e_r_r_n_o is non-zero on
       return, an error has occurred.

       The behavior is undefined if the _l_o_c_a_l_e argument to _w_c_s_c_o_l_l___l() is the
       special locale object LC_GLOBAL_LOCALE or is not a valid locale object
       handle.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, _w_c_s_c_o_l_l() and _w_c_s_c_o_l_l___l() shall return an
       integer greater than, equal to, or less than 0, according to whether
       the wide-character string pointed to by _w_s_1 is greater than, equal to,
       or less than the wide-character string pointed to by _w_s_2, when both are
       interpreted as appropriate to the current locale, or to the locale
       represented by _l_o_c_a_l_e, respectively. On error, _w_c_s_c_o_l_l() and
       _w_c_s_c_o_l_l___l() shall set _e_r_r_n_o, but no return value is reserved to
       indicate an error.

EERRRROORRSS
       These functions may fail if:

       EEIINNVVAALL The _w_s_1 or _w_s_2 arguments contain wide-character codes outside
              the domain of the collating sequence.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       The _w_c_s_x_f_r_m() and _w_c_s_c_m_p() functions should be used for sorting large
       lists.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _w_c_s_c_m_p(), _w_c_s_x_f_r_m()

       The Base Definitions volume of POSIX.1-2017, <<wwcchhaarr..hh>>

CCOOPPYYRRIIGGHHTT
       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 .

       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 .



IEEE/The Open Group                  2017                           WCSCOLL(3)
