xref: /freebsd/lib/libc/string/memccpy.3 (revision 0ad011ececb978e22a9bff2acf76633b094f1ff6)
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.Dd December 5, 2023
29.Dt MEMCCPY 3
30.Os
31.Sh NAME
32.Nm memccpy
33.Nd copy string until character found
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In string.h
38.Ft void *
39.Fo memccpy
40.Fa "void * restrict dst"
41.Fa "const void * restrict src"
42.Fa "int c"
43.Fa "size_t len"
44.Fc
45.Sh DESCRIPTION
46The
47.Fn memccpy
48function
49copies bytes from string
50.Fa src
51to string
52.Fa dst .
53If the character
54.Fa c
55(as converted to an
56.Vt "unsigned char" )
57occurs in the string
58.Fa src ,
59the copy stops and a pointer to the byte after the copy of
60.Fa c
61in the string
62.Fa dst
63is returned.
64Otherwise,
65.Fa len
66bytes are copied, and a NULL pointer is returned.
67If
68.Fa src
69and
70.Fa dst
71overlap, behavior is undefined.
72.Sh SEE ALSO
73.Xr bcopy 3 ,
74.Xr memcpy 3 ,
75.Xr memmove 3 ,
76.Xr strcpy 3
77.Sh STANDARDS
78The
79.Fn memccpy
80function conforms to
81.St -p1003.1-2004
82and
83.\" St -isoC-2024 .
84ISO/IEC 9899:2024 (\(lqISO\~C23\(rq).
85.Sh HISTORY
86The
87.Fn memccpy
88function first appeared in
89.Bx 4.4
90and was first specified in the
91.\" St -svid1 .
92System\~V Interface Definition, First Edition (\(lqSVID1\(rq).
93The
94.Ft restrict
95keyword was added to the prototype in
96.Fx 5.0.0
97in accordance with the updated specification of
98.St -p1003.1-2004 .
99