diff options
Diffstat (limited to 'src/lib/libc/string/wcscmp.3')
| -rw-r--r-- | src/lib/libc/string/wcscmp.3 | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/src/lib/libc/string/wcscmp.3 b/src/lib/libc/string/wcscmp.3 new file mode 100644 index 0000000000..15952b9022 --- /dev/null +++ b/src/lib/libc/string/wcscmp.3 | |||
| @@ -0,0 +1,82 @@ | |||
| 1 | .\" Copyright (c) 1990, 1991 The Regents of the University of California. | ||
| 2 | .\" All rights reserved. | ||
| 3 | .\" | ||
| 4 | .\" This code is derived from software contributed to Berkeley by | ||
| 5 | .\" Chris Torek and the American National Standards Committee X3, | ||
| 6 | .\" on Information Processing Systems. | ||
| 7 | .\" | ||
| 8 | .\" Redistribution and use in source and binary forms, with or without | ||
| 9 | .\" modification, are permitted provided that the following conditions | ||
| 10 | .\" are met: | ||
| 11 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 12 | .\" notice, this list of conditions and the following disclaimer. | ||
| 13 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 14 | .\" notice, this list of conditions and the following disclaimer in the | ||
| 15 | .\" documentation and/or other materials provided with the distribution. | ||
| 16 | .\" 3. Neither the name of the University nor the names of its contributors | ||
| 17 | .\" may be used to endorse or promote products derived from this software | ||
| 18 | .\" without specific prior written permission. | ||
| 19 | .\" | ||
| 20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
| 21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| 23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
| 24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| 25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
| 26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
| 28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
| 29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
| 30 | .\" SUCH DAMAGE. | ||
| 31 | .\" | ||
| 32 | .\" $OpenBSD: wcscmp.3,v 1.1 2011/07/09 16:32:11 nicm Exp $ | ||
| 33 | .\" | ||
| 34 | .Dd $Mdocdate: July 9 2011 $ | ||
| 35 | .Dt WCSCMP 3 | ||
| 36 | .Os | ||
| 37 | .Sh NAME | ||
| 38 | .Nm wcscmp , | ||
| 39 | .Nm wcsncmp | ||
| 40 | .Nd compare wide strings | ||
| 41 | .Sh SYNOPSIS | ||
| 42 | .Fd #include <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 | ||
| 48 | The | ||
| 49 | .Fn wcscmp | ||
| 50 | and | ||
| 51 | .Fn wcsncmp | ||
| 52 | functions lexicographically compare the wide strings | ||
| 53 | .Fa s1 | ||
| 54 | and | ||
| 55 | .Fa s2 . | ||
| 56 | The | ||
| 57 | .Fn wcsncmp | ||
| 58 | compares at most | ||
| 59 | .Fa len | ||
| 60 | wide characters. | ||
| 61 | .Sh RETURN VALUES | ||
| 62 | The | ||
| 63 | .Fn wcscmp | ||
| 64 | and | ||
| 65 | .Fn wcsncmp | ||
| 66 | functions return an integer greater than, equal to, or less than 0, according | ||
| 67 | to whether the wide string | ||
| 68 | .Fa s1 | ||
| 69 | is greater than, equal to, or less than the wide string | ||
| 70 | .Fa s2 . | ||
| 71 | .Sh SEE ALSO | ||
| 72 | .Xr wcscasecmp 3 , | ||
| 73 | .Xr wmemcmp 3 | ||
| 74 | .Sh STANDARDS | ||
| 75 | The | ||
| 76 | .Fn wcscmp | ||
| 77 | and | ||
| 78 | .Fn wcsncmp | ||
| 79 | functions conform to | ||
| 80 | .St -isoC-99 | ||
| 81 | and were first introduced in | ||
| 82 | .St -isoC-amd1 . | ||