libc/string/wmemchr.3

.\"     $NetBSD: wmemchr.3,v 1.4 2001/01/02 11:26:23 itojun Exp $
.\"
.\" Copyright (c) 1990, 1991, 1993
.\"     The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     from: @(#)strcpy.3      8.1 (Berkeley) 6/4/93
.\"
.\" $FreeBSD$
.\"
.Dd March 4, 2009
.Dt WMEMCHR 3
.Os
.Sh NAME
.Nm wmemchr ,
.Nm wmemcmp ,
.Nm wmemcpy ,
.Nm wmemmove ,
.Nm wmemset ,
.Nm wcpcpy ,
.Nm wcpncpy ,
.Nm wcscasecmp ,
.Nm wcscat ,
.Nm wcschr ,
.Nm wcscmp ,
.Nm wcscpy ,
.Nm wcscspn ,
.Nm wcsdup ,
.Nm wcslcat ,
.Nm wcslcpy ,
.Nm wcslen ,
.Nm wcsncasecmp ,
.Nm wcsncat ,
.Nm wcsncmp ,
.Nm wcsncpy ,
.Nm wcsnlen ,
.Nm wcspbrk ,
.Nm wcsrchr ,
.Nm wcsspn ,
.Nm wcsstr
.Nd wide character string manipulation operations
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In wchar.h
.Ft wchar_t *
.Fn wmemchr "const wchar_t *s" "wchar_t c" "size_t n"
.Ft int
.Fn wmemcmp "const wchar_t *s1" "const wchar_t *s2" "size_t n"
.Ft wchar_t *
.Fn wmemcpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
.Ft wchar_t *
.Fn wmemmove "wchar_t *s1" "const wchar_t *s2" "size_t n"
.Ft wchar_t *
.Fn wmemset "wchar_t *s" "wchar_t c" "size_t n"
.Ft wchar_t *
.Fn wcpcpy "wchar_t *s1" "wchar_t *s2"
.Ft wchar_t *
.Fn wcpncpy "wchar_t *s1" "wchar_t *s2" "size_t n"
.Ft int
.Fn wcscasecmp "const wchar_t *s1" "const wchar_t *s2"
.Ft wchar_t *
.Fn wcscat "wchar_t * restrict s1" "const wchar_t * restrict s2"
.Ft wchar_t *
.Fn wcschr "const wchar_t *s" "wchar_t c"
.Ft int
.Fn wcscmp "const wchar_t *s1" "const wchar_t *s2"
.Ft wchar_t *
.Fn wcscpy "wchar_t * restrict s1" "const wchar_t * restrict s2"
.Ft size_t
.Fn wcscspn "const wchar_t *s1" "const wchar_t *s2"
.Ft wchar_t *
.Fn wcsdup "const wchar_t *s"
.Ft size_t
.Fn wcslcat "wchar_t *s1" "const wchar_t *s2" "size_t n"
.Ft size_t
.Fn wcslcpy "wchar_t *s1" "const wchar_t *s2" "size_t n"
.Ft size_t
.Fn wcslen "const wchar_t *s"
.Ft int
.Fn wcsncasecmp "const wchar_t *s1" "const wchar_t *s2" "size_t n"
.Ft wchar_t *
.Fn wcsncat "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
.Ft int
.Fn wcsncmp "const wchar_t *s1" "const wchar_t * s2" "size_t n"
.Ft wchar_t *
.Fn wcsncpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
.Ft size_t
.Fn wcsnlen "const wchar_t *s" "size_t maxlen"
.Ft wchar_t *
.Fn wcspbrk "const wchar_t *s1" "const wchar_t *s2"
.Ft wchar_t *
.Fn wcsrchr "const wchar_t *s" "wchar_t c"
.Ft size_t
.Fn wcsspn "const wchar_t *s1" "const wchar_t *s2"
.Ft wchar_t *
.Fn wcsstr "const wchar_t * restrict s1" "const wchar_t * restrict s2"
.Sh DESCRIPTION
The functions implement string manipulation operations over wide character
strings.
For a detailed description, refer to documents for the respective single-byte
counterpart, such as
.Xr memchr 3 .
.Sh SEE ALSO
.Xr memchr 3 ,
.Xr memcmp 3 ,
.Xr memcpy 3 ,
.Xr memmove 3 ,
.Xr memset 3 ,
.Xr stpcpy 3 ,
.Xr stpncpy 3 ,
.Xr strcasecmp 3 ,
.Xr strcat 3 ,
.Xr strchr 3 ,
.Xr strcmp 3 ,
.Xr strcpy 3 ,
.Xr strcspn 3 ,
.Xr strdup 3 ,
.Xr strlcat 3 ,
.Xr strlcpy 3 ,
.Xr strlen 3 ,
.Xr strncat 3 ,
.Xr strncmp 3 ,
.Xr strncpy 3 ,
.Xr strnlen 3 ,
.Xr strpbrk 3 ,
.Xr strrchr 3 ,
.Xr strspn 3 ,
.Xr strstr 3
.Sh STANDARDS
These functions conform to
.St -isoC-99 ,
with the exception of
.Fn wcpcpy ,
.Fn wcpncpy ,
.Fn wcscasecmp ,
.Fn wcsdup ,
.Fn wcsncasecmp ,
and
.Fn wcsnlen ,
which conform to
.St -p1003.1-2008 ;
and
.Fn wcslcat
and
.Fn wcslcpy ,
which are extensions.
1	.\" $NetBSD: wmemchr.3,v 1.4 2001/01/02 11:26:23 itojun Exp $
2	.\"
3	.\" Copyright (c) 1990, 1991, 1993
4	.\" The Regents of the University of California. 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	.\" from: @(#)strcpy.3 8.1 (Berkeley) 6/4/93
35	.\"
36	.\" $FreeBSD$
37	.\"
38	.Dd March 4, 2009
39	.Dt WMEMCHR 3
40	.Os
41	.Sh NAME
42	.Nm wmemchr ,
43	.Nm wmemcmp ,
44	.Nm wmemcpy ,
45	.Nm wmemmove ,
46	.Nm wmemset ,
47	.Nm wcpcpy ,
48	.Nm wcpncpy ,
49	.Nm wcscasecmp ,
50	.Nm wcscat ,
51	.Nm wcschr ,
52	.Nm wcscmp ,
53	.Nm wcscpy ,
54	.Nm wcscspn ,
55	.Nm wcsdup ,
56	.Nm wcslcat ,
57	.Nm wcslcpy ,
58	.Nm wcslen ,
59	.Nm wcsncasecmp ,
60	.Nm wcsncat ,
61	.Nm wcsncmp ,
62	.Nm wcsncpy ,
63	.Nm wcsnlen ,
64	.Nm wcspbrk ,
65	.Nm wcsrchr ,
66	.Nm wcsspn ,
67	.Nm wcsstr
68	.Nd wide character string manipulation operations
69	.Sh LIBRARY
70	.Lb libc
71	.Sh SYNOPSIS
72	.In wchar.h
73	.Ft wchar_t *
74	.Fn wmemchr "const wchar_t *s" "wchar_t c" "size_t n"
75	.Ft int
76	.Fn wmemcmp "const wchar_t s1" "const wchar_t s2" "size_t n"
77	.Ft wchar_t *
78	.Fn wmemcpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
79	.Ft wchar_t *
80	.Fn wmemmove "wchar_t s1" "const wchar_t s2" "size_t n"
81	.Ft wchar_t *
82	.Fn wmemset "wchar_t *s" "wchar_t c" "size_t n"
83	.Ft wchar_t *
84	.Fn wcpcpy "wchar_t s1" "wchar_t s2"
85	.Ft wchar_t *
86	.Fn wcpncpy "wchar_t s1" "wchar_t s2" "size_t n"
87	.Ft int
88	.Fn wcscasecmp "const wchar_t s1" "const wchar_t s2"
89	.Ft wchar_t *
90	.Fn wcscat "wchar_t * restrict s1" "const wchar_t * restrict s2"
91	.Ft wchar_t *
92	.Fn wcschr "const wchar_t *s" "wchar_t c"
93	.Ft int
94	.Fn wcscmp "const wchar_t s1" "const wchar_t s2"
95	.Ft wchar_t *
96	.Fn wcscpy "wchar_t * restrict s1" "const wchar_t * restrict s2"
97	.Ft size_t
98	.Fn wcscspn "const wchar_t s1" "const wchar_t s2"
99	.Ft wchar_t *
100	.Fn wcsdup "const wchar_t *s"
101	.Ft size_t
102	.Fn wcslcat "wchar_t s1" "const wchar_t s2" "size_t n"
103	.Ft size_t
104	.Fn wcslcpy "wchar_t s1" "const wchar_t s2" "size_t n"
105	.Ft size_t
106	.Fn wcslen "const wchar_t *s"
107	.Ft int
108	.Fn wcsncasecmp "const wchar_t s1" "const wchar_t s2" "size_t n"
109	.Ft wchar_t *
110	.Fn wcsncat "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
111	.Ft int
112	.Fn wcsncmp "const wchar_t s1" "const wchar_t s2" "size_t n"
113	.Ft wchar_t *
114	.Fn wcsncpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
115	.Ft size_t
116	.Fn wcsnlen "const wchar_t *s" "size_t maxlen"
117	.Ft wchar_t *
118	.Fn wcspbrk "const wchar_t s1" "const wchar_t s2"
119	.Ft wchar_t *
120	.Fn wcsrchr "const wchar_t *s" "wchar_t c"
121	.Ft size_t
122	.Fn wcsspn "const wchar_t s1" "const wchar_t s2"
123	.Ft wchar_t *
124	.Fn wcsstr "const wchar_t * restrict s1" "const wchar_t * restrict s2"
125	.Sh DESCRIPTION
126	The functions implement string manipulation operations over wide character
127	strings.
128	For a detailed description, refer to documents for the respective single-byte
129	counterpart, such as
130	.Xr memchr 3 .
131	.Sh SEE ALSO
132	.Xr memchr 3 ,
133	.Xr memcmp 3 ,
134	.Xr memcpy 3 ,
135	.Xr memmove 3 ,
136	.Xr memset 3 ,
137	.Xr stpcpy 3 ,
138	.Xr stpncpy 3 ,
139	.Xr strcasecmp 3 ,
140	.Xr strcat 3 ,
141	.Xr strchr 3 ,
142	.Xr strcmp 3 ,
143	.Xr strcpy 3 ,
144	.Xr strcspn 3 ,
145	.Xr strdup 3 ,
146	.Xr strlcat 3 ,
147	.Xr strlcpy 3 ,
148	.Xr strlen 3 ,
149	.Xr strncat 3 ,
150	.Xr strncmp 3 ,
151	.Xr strncpy 3 ,
152	.Xr strnlen 3 ,
153	.Xr strpbrk 3 ,
154	.Xr strrchr 3 ,
155	.Xr strspn 3 ,
156	.Xr strstr 3
157	.Sh STANDARDS
158	These functions conform to
159	.St -isoC-99 ,
160	with the exception of
161	.Fn wcpcpy ,
162	.Fn wcpncpy ,
163	.Fn wcscasecmp ,
164	.Fn wcsdup ,
165	.Fn wcsncasecmp ,
166	and
167	.Fn wcsnlen ,
168	which conform to
169	.St -p1003.1-2008 ;
170	and
171	.Fn wcslcat
172	and
173	.Fn wcslcpy ,
174	which are extensions.