xref: /freebsd/lib/libc/string/memccpy.3 (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
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. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)memccpy.3	8.1 (Berkeley) 6/9/93
33.\"
34.Dd June 9, 1993
35.Dt MEMCCPY 3
36.Os
37.Sh NAME
38.Nm memccpy
39.Nd copy string until character found
40.Sh SYNOPSIS
41.Fd #include <string.h>
42.Ft void *
43.Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
44.Sh DESCRIPTION
45The
46.Fn memccpy
47function
48copies bytes from string
49.Fa src
50to string
51.Fa dst .
52If the character
53.Fa c
54(as converted to an unsigned char) occurs in the string
55.Fa src ,
56the copy stops and a pointer to the byte after the copy of
57.Fa c
58in the string
59.Fa dst
60is returned.
61Otherwise,
62.Fa len
63bytes are copied, and a NULL pointer is returned.
64.Sh SEE ALSO
65.Xr bcopy 3 ,
66.Xr memcpy 3 ,
67.Xr memmove 3 ,
68.Xr strcpy 3
69.Sh HISTORY
70The
71.Fn memccpy
72function first appeared in 4.4BSD.
73