]> git.ipfire.org Git - thirdparty/man-pages.git/blob - man3/wcsncasecmp.3
getauxval.3: wfix
[thirdparty/man-pages.git] / man3 / wcsncasecmp.3
1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2 .\"
3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
4 .\" This is free documentation; you can redistribute it and/or
5 .\" modify it under the terms of the GNU General Public License as
6 .\" published by the Free Software Foundation; either version 2 of
7 .\" the License, or (at your option) any later version.
8 .\" %%%LICENSE_END
9 .\"
10 .\" References consulted:
11 .\" GNU glibc-2 source code and manual
12 .\" Dinkumware C library reference http://www.dinkumware.com/
13 .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
14 .\"
15 .TH WCSNCASECMP 3 2015-03-02 "GNU" "Linux Programmer's Manual"
16 .SH NAME
17 wcsncasecmp \- compare two fixed-size wide-character strings, ignoring case
18 .SH SYNOPSIS
19 .nf
20 .B #include <wchar.h>
21 .sp
22 .BI "int wcsncasecmp(const wchar_t *" s1 ", const wchar_t *" s2 ", size_t " n );
23 .fi
24 .sp
25 .in -4n
26 Feature Test Macro Requirements for glibc (see
27 .BR feature_test_macros (7)):
28 .in
29 .sp
30 .BR wcsncasecmp ():
31 .PD 0
32 .ad l
33 .RS 4
34 .TP 4
35 Since glibc 2.10:
36 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
37 .TP
38 Before glibc 2.10:
39 _GNU_SOURCE
40 .RE
41 .ad
42 .PD
43 .SH DESCRIPTION
44 The
45 .BR wcsncasecmp ()
46 function is the wide-character equivalent of the
47 .BR strncasecmp (3)
48 function.
49 It compares the wide-character string pointed to
50 by
51 .I s1
52 and the wide-character string
53 pointed to by
54 .IR s2 ,
55 but at most
56 .I n
57 wide characters from each string, ignoring case differences
58 .RB ( towupper (3),
59 .BR towlower (3)).
60 .SH RETURN VALUE
61 The
62 .BR wcsncasecmp ()
63 function returns zero
64 if the wide-character strings at
65 .I s1
66 and
67 .IR s2 ,
68 truncated to at most length
69 .IR n ,
70 are equal except
71 for case distinctions.
72 It returns a positive integer if truncated
73 .I s1
74 is
75 greater than truncated
76 .IR s2 ,
77 ignoring case.
78 It returns a negative integer
79 if truncated
80 .I s1
81 is smaller than truncated
82 .IR s2 ,
83 ignoring case.
84 .SH VERSIONS
85 The
86 .BR wcsncasecmp ()
87 function is provided in glibc since version 2.1.
88 .SH ATTRIBUTES
89 For an explanation of the terms used in this section, see
90 .BR attributes (7).
91 .TS
92 allbox;
93 lb lb lb
94 l l l.
95 Interface Attribute Value
96 T{
97 .BR wcsncasecmp ()
98 T} Thread safety MT-Safe locale
99 .TE
100 .SH CONFORMING TO
101 POSIX.1-2008.
102 This function is not specified in POSIX.1-2001,
103 and is not widely available on other systems.
104 .SH NOTES
105 The behavior of
106 .BR wcsncasecmp ()
107 depends on the
108 .B LC_CTYPE
109 category of the
110 current locale.
111 .SH SEE ALSO
112 .BR strncasecmp (3),
113 .BR wcsncmp (3)