1.\" $OpenBSD: wcscmp.3,v 1.3 2013/06/05 03:39:23 tedu Exp $ 2.\" 3.\" Copyright (c) 1990, 1991 The Regents of the University of California. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to Berkeley by 7.\" Chris Torek and the American National Standards Committee X3, 8.\" on Information Processing Systems. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.Dd $Mdocdate: June 5 2013 $ 35.Dt WCSCMP 3 36.Os 37.Sh NAME 38.Nm wcscmp , 39.Nm wcsncmp 40.Nd compare wide strings 41.Sh SYNOPSIS 42.In wchar.h 43.Ft int 44.Fn wcscmp "const wchar_t *s1" "const wchar_t *s2" 45.Ft int 46.Fn wcsncmp "const wchar_t *s1" "const wchar_t *s2" "size_t len" 47.Sh DESCRIPTION 48The 49.Fn wcscmp 50and 51.Fn wcsncmp 52functions lexicographically compare the wide strings 53.Fa s1 54and 55.Fa s2 . 56The 57.Fn wcsncmp 58function compares at most 59.Fa len 60wide characters. 61.Sh RETURN VALUES 62The 63.Fn wcscmp 64and 65.Fn wcsncmp 66functions return an integer greater than, equal to, or less than 0, according 67to whether the wide string 68.Fa s1 69is greater than, equal to, or less than the wide string 70.Fa s2 . 71.Sh SEE ALSO 72.Xr strcmp 3 , 73.Xr wcscasecmp 3 , 74.Xr wmemcmp 3 75.Sh STANDARDS 76The 77.Fn wcscmp 78and 79.Fn wcsncmp 80functions conform to 81.St -isoC-99 82and were first introduced in 83.St -isoC-amd1 . 84.Sh HISTORY 85The 86.Fn wcscmp 87and 88.Fn wcsncmp 89functions were ported from 90.Nx 91and first appeared in 92.Ox 3.8 . 93