]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright (c) Bruno Haible <haible@clisp.cons.org> |
2 | .\" | |
89e3ffe9 | 3 | .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA) |
fea681da MK |
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. | |
fe382ebf | 8 | .\" %%%LICENSE_END |
fea681da MK |
9 | .\" |
10 | .\" References consulted: | |
11 | .\" GNU glibc-2 source code and manual | |
12 | .\" Dinkumware C library reference http://www.dinkumware.com/ | |
008f1ecc | 13 | .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html |
fea681da MK |
14 | .\" ISO/IEC 9899:1999 |
15 | .\" | |
460495ca | 16 | .TH WCSSTR 3 2015-08-08 "GNU" "Linux Programmer's Manual" |
fea681da MK |
17 | .SH NAME |
18 | wcsstr \- locate a substring in a wide-character string | |
19 | .SH SYNOPSIS | |
20 | .nf | |
21 | .B #include <wchar.h> | |
68e4db0a | 22 | .PP |
fea681da MK |
23 | .BI "wchar_t *wcsstr(const wchar_t *" haystack ", const wchar_t *" needle ); |
24 | .fi | |
25 | .SH DESCRIPTION | |
60a90ecd MK |
26 | The |
27 | .BR wcsstr () | |
28 | function is the wide-character equivalent of the | |
29 | .BR strstr (3) | |
30 | function. | |
35478399 | 31 | It searches for the first occurrence of the wide-character string |
40aa0db0 MK |
32 | .I needle |
33 | (without its terminating null wide character (L\(aq\\0\(aq)) | |
34 | as a substring in the wide-character string | |
35 | .IR haystack . | |
47297adb | 36 | .SH RETURN VALUE |
60a90ecd MK |
37 | The |
38 | .BR wcsstr () | |
39 | function returns a pointer to the first occurrence of | |
40aa0db0 MK |
40 | .I needle |
41 | in | |
42 | .IR haystack . | |
43 | It returns NULL if | |
44 | .I needle | |
45 | does not occur | |
46 | as a substring in | |
47 | .IR haystack . | |
fea681da | 48 | .PP |
c13182ef | 49 | Note the special case: |
40aa0db0 MK |
50 | If |
51 | .I needle | |
52 | is the empty wide-character string, | |
53 | the return value is always | |
54 | .I haystack | |
55 | itself. | |
83e0c152 | 56 | .SH ATTRIBUTES |
7604834d PH |
57 | For an explanation of the terms used in this section, see |
58 | .BR attributes (7). | |
59 | .TS | |
60 | allbox; | |
61 | lb lb lb | |
62 | l l l. | |
63 | Interface Attribute Value | |
64 | T{ | |
83e0c152 | 65 | .BR wcsstr () |
7604834d PH |
66 | T} Thread safety MT-Safe |
67 | .TE | |
47297adb | 68 | .SH CONFORMING TO |
d2fc216e | 69 | POSIX.1-2001, POSIX.1-2008, C99. |
47297adb | 70 | .SH SEE ALSO |
fea681da MK |
71 | .BR strstr (3), |
72 | .BR wcschr (3) |