[apple/libc.git] / 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. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. 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: src/lib/libc/string/wmemchr.3,v 1.6 2002/09/07 04:07:00 tjr Exp $
.\"
.Dd December 22, 2000
.Dt WMEMCHR 3
.Os
.Sh NAME
.Nm wcscat ,
.Nm wcschr ,
.Nm wcscmp ,
.Nm wcscpy ,
.Nm wcscspn ,
.Nm wcslcat ,
.Nm wcslcpy ,
.Nm wcslen ,
.Nm wcsncat ,
.Nm wcsncmp ,
.Nm wcsncpy ,
.Nm wcspbrk ,
.Nm wcsrchr ,
.Nm wcsspn ,
.Nm wcsstr ,
.Nm wmemchr ,
.Nm wmemcmp ,
.Nm wmemcpy ,
.Nm wmemmove ,
.Nm wmemset
.Nd wide character string manipulation operations
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In wchar.h
.Ft wchar_t *
.Fo wcscat
.Fa "wchar_t *restrict ws1"
.Fa "const wchar_t *restrict ws2"
.Fc
.Ft wchar_t *
.Fo wcschr
.Fa "const wchar_t *ws"
.Fa "wchar_t wc"
.Fc
.Ft int
.Fo wcscmp
.Fa "const wchar_t *ws1"
.Fa "const wchar_t *ws2"
.Fc
.Ft wchar_t *
.Fo wcscpy
.Fa "wchar_t *restrict ws1"
.Fa "const wchar_t *restrict ws2"
.Fc
.Ft size_t
.Fo wcscspn
.Fa "const wchar_t *ws1"
.Fa "const wchar_t *ws2"
.Fc
.Ft size_t
.Fo wcslcat
.Fa "wchar_t *ws1"
.Fa "const wchar_t *ws2"
.Fa "size_t n"
.Fc
.Ft size_t
.Fo wcslcpy
.Fa "wchar_t *ws1"
.Fa "const wchar_t *ws2"
.Fa "size_t n"
.Fc
.Ft size_t
.Fo wcslen
.Fa "const wchar_t *ws"
.Fc
.Ft wchar_t *
.Fo wcsncat
.Fa "wchar_t *restrict ws1"
.Fa "const wchar_t *restrict ws2"
.Fa "size_t n"
.Fc
.Ft int
.Fo wcsncmp
.Fa "const wchar_t *ws1"
.Fa "const wchar_t *ws2"
.Fa "size_t n"
.Fc
.Ft wchar_t *
.Fo wcsncpy
.Fa "wchar_t *restrict ws1"
.Fa "const wchar_t *restrict ws2"
.Fa "size_t n"
.Fc
.Ft wchar_t *
.Fo wcspbrk
.Fa "const wchar_t *ws1"
.Fa "const wchar_t *ws2"
.Fc
.Ft wchar_t *
.Fo wcsrchr
.Fa "const wchar_t *ws"
.Fa "wchar_t wc"
.Fc
.Ft size_t
.Fo wcsspn
.Fa "const wchar_t *ws1"
.Fa "const wchar_t *ws2"
.Fc
.Ft wchar_t *
.Fo wcsstr
.Fa "const wchar_t *restrict ws1"
.Fa "const wchar_t *restrict ws2"
.Fc
.Ft wchar_t *
.Fo wmemchr
.Fa "const wchar_t *ws"
.Fa "wchar_t wc"
.Fa "size_t n"
.Fc
.Ft int
.Fo wmemcmp
.Fa "const wchar_t *ws1"
.Fa "const wchar_t *ws2"
.Fa "size_t n"
.Fc
.Ft wchar_t *
.Fo wmemcpy
.Fa "wchar_t *restrict ws1"
.Fa "const wchar_t *restrict ws2"
.Fa "size_t n"
.Fc
.Ft wchar_t *
.Fo wmemmove
.Fa "wchar_t *ws1"
.Fa "const wchar_t *ws2"
.Fa "size_t n"
.Fc
.Ft wchar_t *
.Fo wmemset
.Fa "wchar_t *ws"
.Fa "wchar_t wc"
.Fa "size_t n"
.Fc
.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 strcat 3 ,
.Xr strchr 3 ,
.Xr strcmp 3 ,
.Xr strcpy 3 ,
.Xr strcspn 3 ,
.Xr strlcat 3 ,
.Xr strlcpy 3 ,
.Xr strlen 3 ,
.Xr strncat 3 ,
.Xr strncmp 3 ,
.Xr strncpy 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 wcslcat
and
.Fn wcslcpy ,
which are extensions.
Commit	Line	Data
224c7076 A	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. All advertising materials mentioning features or use of this software
	19	.\" must display the following acknowledgement:
	20	.\" This product includes software developed by the University of
	21	.\" California, Berkeley and its contributors.
	22	.\" 4. Neither the name of the University nor the names of its contributors
	23	.\" may be used to endorse or promote products derived from this software
	24	.\" without specific prior written permission.
	25	.\"
	26	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	27	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	28	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	29	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	30	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	31	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	32	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	33	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	34	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	35	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	36	.\" SUCH DAMAGE.
	37	.\"
	38	.\" from: @(#)strcpy.3 8.1 (Berkeley) 6/4/93
	39	.\"
	40	.\" $FreeBSD: src/lib/libc/string/wmemchr.3,v 1.6 2002/09/07 04:07:00 tjr Exp $
	41	.\"
	42	.Dd December 22, 2000
	43	.Dt WMEMCHR 3
	44	.Os
	45	.Sh NAME
	46	.Nm wcscat ,
	47	.Nm wcschr ,
	48	.Nm wcscmp ,
	49	.Nm wcscpy ,
	50	.Nm wcscspn ,
	51	.Nm wcslcat ,
	52	.Nm wcslcpy ,
	53	.Nm wcslen ,
	54	.Nm wcsncat ,
	55	.Nm wcsncmp ,
	56	.Nm wcsncpy ,
	57	.Nm wcspbrk ,
	58	.Nm wcsrchr ,
	59	.Nm wcsspn ,
	60	.Nm wcsstr ,
	61	.Nm wmemchr ,
	62	.Nm wmemcmp ,
	63	.Nm wmemcpy ,
	64	.Nm wmemmove ,
65	.Nm wmemset
66	.Nd wide character string manipulation operations
67	.Sh LIBRARY
68	.Lb libc
69	.Sh SYNOPSIS
70	.In wchar.h
71	.Ft wchar_t *
72	.Fo wcscat
73	.Fa "wchar_t *restrict ws1"
74	.Fa "const wchar_t *restrict ws2"
75	.Fc
76	.Ft wchar_t *
77	.Fo wcschr
78	.Fa "const wchar_t *ws"
79	.Fa "wchar_t wc"
80	.Fc
81	.Ft int
82	.Fo wcscmp
83	.Fa "const wchar_t *ws1"
84	.Fa "const wchar_t *ws2"
85	.Fc
86	.Ft wchar_t *
87	.Fo wcscpy
88	.Fa "wchar_t *restrict ws1"
89	.Fa "const wchar_t *restrict ws2"
90	.Fc
91	.Ft size_t
92	.Fo wcscspn
93	.Fa "const wchar_t *ws1"
94	.Fa "const wchar_t *ws2"
95	.Fc
96	.Ft size_t
97	.Fo wcslcat
98	.Fa "wchar_t *ws1"
99	.Fa "const wchar_t *ws2"
100	.Fa "size_t n"
101	.Fc
102	.Ft size_t
103	.Fo wcslcpy
104	.Fa "wchar_t *ws1"
105	.Fa "const wchar_t *ws2"
106	.Fa "size_t n"
107	.Fc
108	.Ft size_t
109	.Fo wcslen
110	.Fa "const wchar_t *ws"
111	.Fc
112	.Ft wchar_t *
113	.Fo wcsncat
114	.Fa "wchar_t *restrict ws1"
115	.Fa "const wchar_t *restrict ws2"
116	.Fa "size_t n"
117	.Fc
118	.Ft int
119	.Fo wcsncmp
120	.Fa "const wchar_t *ws1"
121	.Fa "const wchar_t *ws2"
122	.Fa "size_t n"
123	.Fc
124	.Ft wchar_t *
125	.Fo wcsncpy
126	.Fa "wchar_t *restrict ws1"
127	.Fa "const wchar_t *restrict ws2"
128	.Fa "size_t n"
129	.Fc
130	.Ft wchar_t *
131	.Fo wcspbrk
132	.Fa "const wchar_t *ws1"
133	.Fa "const wchar_t *ws2"
134	.Fc
135	.Ft wchar_t *
136	.Fo wcsrchr
137	.Fa "const wchar_t *ws"
138	.Fa "wchar_t wc"
139	.Fc
140	.Ft size_t
141	.Fo wcsspn
142	.Fa "const wchar_t *ws1"
143	.Fa "const wchar_t *ws2"
144	.Fc
145	.Ft wchar_t *
146	.Fo wcsstr
147	.Fa "const wchar_t *restrict ws1"
148	.Fa "const wchar_t *restrict ws2"
149	.Fc
150	.Ft wchar_t *
151	.Fo wmemchr
152	.Fa "const wchar_t *ws"
153	.Fa "wchar_t wc"
154	.Fa "size_t n"
155	.Fc
156	.Ft int
157	.Fo wmemcmp
158	.Fa "const wchar_t *ws1"
159	.Fa "const wchar_t *ws2"
160	.Fa "size_t n"
161	.Fc
162	.Ft wchar_t *
163	.Fo wmemcpy
164	.Fa "wchar_t *restrict ws1"
165	.Fa "const wchar_t *restrict ws2"
166	.Fa "size_t n"
167	.Fc
168	.Ft wchar_t *
169	.Fo wmemmove
170	.Fa "wchar_t *ws1"
171	.Fa "const wchar_t *ws2"
172	.Fa "size_t n"
173	.Fc
174	.Ft wchar_t *
175	.Fo wmemset
176	.Fa "wchar_t *ws"
177	.Fa "wchar_t wc"
178	.Fa "size_t n"
179	.Fc
180	.Sh DESCRIPTION
181	The functions implement string manipulation operations
182	over wide character strings.
183	For a detailed description,
184	refer to documents for the respective single-byte counterpart, such as
185	.Xr memchr 3 .
186	.Sh SEE ALSO
187	.Xr memchr 3 ,
188	.Xr memcmp 3 ,
189	.Xr memcpy 3 ,
190	.Xr memmove 3 ,
191	.Xr memset 3 ,
192	.Xr strcat 3 ,
193	.Xr strchr 3 ,
194	.Xr strcmp 3 ,
195	.Xr strcpy 3 ,
196	.Xr strcspn 3 ,
197	.Xr strlcat 3 ,
198	.Xr strlcpy 3 ,
199	.Xr strlen 3 ,
200	.Xr strncat 3 ,
201	.Xr strncmp 3 ,
202	.Xr strncpy 3 ,
203	.Xr strpbrk 3 ,
204	.Xr strrchr 3 ,
205	.Xr strspn 3 ,
206	.Xr strstr 3
207	.Sh STANDARDS
208	These functions conform to
209	.St -isoC-99 ,
210	with the exception of
211	.Fn wcslcat
212	and
213	.Fn wcslcpy ,
214	which are extensions.