xref: /freebsd-14.2/lib/libc/string/memccpy.3 (revision 667fa9c4)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)memccpy.3	8.1 (Berkeley) 6/9/93
29.\"
30.Dd December 5, 2023
31.Dt MEMCCPY 3
32.Os
33.Sh NAME
34.Nm memccpy
35.Nd copy string until character found
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In string.h
40.Ft void *
41.Fo memccpy
42.Fa "void * restrict dst"
43.Fa "const void * restrict src"
44.Fa "int c"
45.Fa "size_t len"
46.Fc
47.Sh DESCRIPTION
48The
49.Fn memccpy
50function
51copies bytes from string
52.Fa src
53to string
54.Fa dst .
55If the character
56.Fa c
57(as converted to an
58.Vt "unsigned char" )
59occurs in the string
60.Fa src ,
61the copy stops and a pointer to the byte after the copy of
62.Fa c
63in the string
64.Fa dst
65is returned.
66Otherwise,
67.Fa len
68bytes are copied, and a NULL pointer is returned.
69If
70.Fa src
71and
72.Fa dst
73overlap, behavior is undefined.
74.Sh SEE ALSO
75.Xr bcopy 3 ,
76.Xr memcpy 3 ,
77.Xr memmove 3 ,
78.Xr strcpy 3
79.Sh STANDARDS
80The
81.Fn memccpy
82function conforms to
83.St -p1003.1-2004
84and
85.\" St -isoC-2024 .
86ISO/IEC 9899:2024 (\(lqISO\~C23\(rq).
87.Sh HISTORY
88The
89.Fn memccpy
90function first appeared in
91.Bx 4.4
92and was first specified in the
93.\" St -svid1 .
94System\~V Interface Definition, First Edition (\(lqSVID1\(rq).
95The
96.Ft restrict
97keyword was added to the prototype in
98.Fx 5.0.0
99in accordance with the updated specification of
100.St -p1003.1-2004 .
101