xref: /netbsd-src/lib/libc/string/wmemchr.3 (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1.\"	$NetBSD: wmemchr.3,v 1.5 2001/01/02 11:27:45 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.Dd December 22, 2000
41.Dt WMEMCHR 3
42.Os
43.Sh NAME
44.Nm wmemchr ,
45.Nm wmemcmp ,
46.Nm wmemcpy ,
47.Nm wmemmove ,
48.Nm wmemset ,
49.Nm wcscat ,
50.Nm wcschr ,
51.Nm wcscmp ,
52.Nm wcscpy ,
53.Nm wcscspn ,
54.Nm wcslcat ,
55.Nm wcslcpy ,
56.Nm wcslen ,
57.Nm wcsncat ,
58.Nm wcsncmp ,
59.Nm wcsncpy ,
60.Nm wcspbrk ,
61.Nm wcsrchr ,
62.Nm wcsspn ,
63.Nm wcsstr
64.Nd wide character string manipulation operations
65.Sh LIBRARY
66.Lb libc
67.Sh SYNOPSIS
68.Fd #include <wchar.h>
69.Ft wchar_t *
70.Fn wmemchr "const wchar_t *s" "wchar_t c" "size_t n"
71.Ft int
72.Fn wmemcmp "const wchar_t *s1" "const wchar_t *s2" "size_t n"
73.Ft wchar_t *
74.Fn wmemcpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
75.Ft wchar_t *
76.Fn wmemmove "wchar_t *s1" "const wchar_t *s2" "size_t n"
77.Ft wchar_t *
78.Fn wmemset "wchar_t *s" "wchar_t c" "size_t n"
79.Ft wchar_t *
80.Fn wcscat "wchar_t * restrict s1" "const wchar_t * restrict s2"
81.Ft wchar_t *
82.Fn wcschr "const wchar_t *s" "wchar_t c"
83.Ft int
84.Fn wcscmp "const wchar_t *s1" "const wchar_t *s2"
85.Ft wchar_t *
86.Fn wcscpy "wchar_t * restrict s1" "const wchar_t * restrict s2"
87.Ft size_t
88.Fn wcscspn "const wchar_t *s1" "const wchar_t *s2"
89.Ft size_t
90.Fn wcslcat "wchar_t *s1" "const wchar_t *s2" "size_t n"
91.Ft size_t
92.Fn wcslcpy "wchar_t *s1" "const wchar_t *s2" "size_t n"
93.Ft size_t
94.Fn wcslen "const wchar_t *s"
95.Ft wchar_t *
96.Fn wcsncat "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
97.Ft int
98.Fn wcsncmp "const wchar_t *s1" "const wchar_t * s2" "size_t n"
99.Ft wchar_t *
100.Fn wcsncpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
101.Ft wchar_t *
102.Fn wcspbrk "const wchar_t *s1" "const wchar_t *s2"
103.Ft wchar_t *
104.Fn wcsrchr "const wchar_t *s" "wchar_t c"
105.Ft size_t
106.Fn wcsspn "const wchar_t *s1" "const wchar_t *s2"
107.Ft wchar_t *
108.Fn wcsstr "const wchar_t *s1" "const wchar_t *s2"
109.Sh DESCRIPTION
110The functions implement string manipulation operations over wide character
111strings.
112For a detailed description, refer to documents for the respective single-byte
113counterpart, such as
114.Xr memchr 3 .
115.Sh SEE ALSO
116.Xr memchr 3 ,
117.Xr memcmp 3 ,
118.Xr memcpy 3 ,
119.Xr memmove 3 ,
120.Xr memset 3 ,
121.Xr strcat 3 ,
122.Xr strchr 3 ,
123.Xr strcmp 3 ,
124.Xr strcpy 3 ,
125.Xr strcspn 3 ,
126.Xr strlcat 3 ,
127.Xr strlcpy 3 ,
128.Xr strlen 3 ,
129.Xr strncat 3 ,
130.Xr strncmp 3 ,
131.Xr strncpy 3 ,
132.Xr strpbrk 3 ,
133.Xr strrchr 3 ,
134.Xr strspn 3 ,
135.Xr strstr 3
136.Sh STANDARDS
137These functions conform to
138.St -isoC99
139and were first introduced in
140.St -isoC-amd1 ,
141with the exception of
142.Fn wcslcat
143and
144.Fn wcslcpy ,
145which are extensions.
146