xref: /freebsd/lib/libc/string/wmemchr.3 (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
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 July 14, 2021
39.Dt WMEMCHR 3
40.Os
41.Sh NAME
42.Nm wmemchr ,
43.Nm wmemcmp ,
44.Nm wmemcpy ,
45.Nm wmemmove ,
46.Nm wmempcpy ,
47.Nm wmemset ,
48.Nm wcpcpy ,
49.Nm wcpncpy ,
50.Nm wcscasecmp ,
51.Nm wcscat ,
52.Nm wcschr ,
53.Nm wcscmp ,
54.Nm wcscpy ,
55.Nm wcscspn ,
56.Nm wcsdup ,
57.Nm wcslcat ,
58.Nm wcslcpy ,
59.Nm wcslen ,
60.Nm wcsncasecmp ,
61.Nm wcsncat ,
62.Nm wcsncmp ,
63.Nm wcsncpy ,
64.Nm wcsnlen ,
65.Nm wcspbrk ,
66.Nm wcsrchr ,
67.Nm wcsspn ,
68.Nm wcsstr
69.Nd wide character string manipulation operations
70.Sh LIBRARY
71.Lb libc
72.Sh SYNOPSIS
73.In wchar.h
74.Ft wchar_t *
75.Fn wmemchr "const wchar_t *s" "wchar_t c" "size_t n"
76.Ft int
77.Fn wmemcmp "const wchar_t *s1" "const wchar_t *s2" "size_t n"
78.Ft wchar_t *
79.Fn wmemcpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
80.Ft wchar_t *
81.Fn wmemmove "wchar_t *s1" "const wchar_t *s2" "size_t n"
82.Ft wchar_t *
83.Fn wmempcpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
84.Ft wchar_t *
85.Fn wmemset "wchar_t *s" "wchar_t c" "size_t n"
86.Ft wchar_t *
87.Fn wcpcpy "wchar_t *s1" "wchar_t *s2"
88.Ft wchar_t *
89.Fn wcpncpy "wchar_t *s1" "wchar_t *s2" "size_t n"
90.Ft int
91.Fn wcscasecmp "const wchar_t *s1" "const wchar_t *s2"
92.Ft wchar_t *
93.Fn wcscat "wchar_t * restrict s1" "const wchar_t * restrict s2"
94.Ft wchar_t *
95.Fn wcschr "const wchar_t *s" "wchar_t c"
96.Ft int
97.Fn wcscmp "const wchar_t *s1" "const wchar_t *s2"
98.Ft wchar_t *
99.Fn wcscpy "wchar_t * restrict s1" "const wchar_t * restrict s2"
100.Ft size_t
101.Fn wcscspn "const wchar_t *s1" "const wchar_t *s2"
102.Ft wchar_t *
103.Fn wcsdup "const wchar_t *s"
104.Ft size_t
105.Fn wcslcat "wchar_t *s1" "const wchar_t *s2" "size_t n"
106.Ft size_t
107.Fn wcslcpy "wchar_t *s1" "const wchar_t *s2" "size_t n"
108.Ft size_t
109.Fn wcslen "const wchar_t *s"
110.Ft int
111.Fn wcsncasecmp "const wchar_t *s1" "const wchar_t *s2" "size_t n"
112.Ft wchar_t *
113.Fn wcsncat "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
114.Ft int
115.Fn wcsncmp "const wchar_t *s1" "const wchar_t * s2" "size_t n"
116.Ft wchar_t *
117.Fn wcsncpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
118.Ft size_t
119.Fn wcsnlen "const wchar_t *s" "size_t maxlen"
120.Ft wchar_t *
121.Fn wcspbrk "const wchar_t *s1" "const wchar_t *s2"
122.Ft wchar_t *
123.Fn wcsrchr "const wchar_t *s" "wchar_t c"
124.Ft size_t
125.Fn wcsspn "const wchar_t *s1" "const wchar_t *s2"
126.Ft wchar_t *
127.Fn wcsstr "const wchar_t * restrict s1" "const wchar_t * restrict s2"
128.Sh DESCRIPTION
129The functions implement string manipulation operations over wide character
130strings.
131For a detailed description, refer to documents for the respective single-byte
132counterpart, such as
133.Xr memchr 3 .
134.Sh SEE ALSO
135.Xr memchr 3 ,
136.Xr memcmp 3 ,
137.Xr memcpy 3 ,
138.Xr memmove 3 ,
139.Xr memset 3 ,
140.Xr stpcpy 3 ,
141.Xr stpncpy 3 ,
142.Xr strcasecmp 3 ,
143.Xr strcat 3 ,
144.Xr strchr 3 ,
145.Xr strcmp 3 ,
146.Xr strcpy 3 ,
147.Xr strcspn 3 ,
148.Xr strdup 3 ,
149.Xr strlcat 3 ,
150.Xr strlcpy 3 ,
151.Xr strlen 3 ,
152.Xr strncat 3 ,
153.Xr strncmp 3 ,
154.Xr strncpy 3 ,
155.Xr strnlen 3 ,
156.Xr strpbrk 3 ,
157.Xr strrchr 3 ,
158.Xr strspn 3 ,
159.Xr strstr 3
160.Sh STANDARDS
161These functions conform to
162.St -isoC-99 ,
163with the exception of
164.Fn wcpcpy ,
165.Fn wcpncpy ,
166.Fn wcscasecmp ,
167.Fn wcsdup ,
168.Fn wcsncasecmp ,
169and
170.Fn wcsnlen ,
171which conform to
172.St -p1003.1-2008 ;
173and
174.Fn wcslcat ,
175.Fn wcslcpy ,
176and
177.Fn wmempcpy ,
178which are extensions.
179