xref: /freebsd/lib/libc/string/memccpy.3 (revision 4b9d6057)
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 June 9, 1993
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.Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
40.Sh DESCRIPTION
41The
42.Fn memccpy
43function
44copies bytes from string
45.Fa src
46to string
47.Fa dst .
48If the character
49.Fa c
50(as converted to an
51.Vt "unsigned char" )
52occurs in the string
53.Fa src ,
54the copy stops and a pointer to the byte after the copy of
55.Fa c
56in the string
57.Fa dst
58is returned.
59Otherwise,
60.Fa len
61bytes are copied, and a NULL pointer is returned.
62.Sh SEE ALSO
63.Xr bcopy 3 ,
64.Xr memcpy 3 ,
65.Xr memmove 3 ,
66.Xr strcpy 3
67.Sh HISTORY
68The
69.Fn memccpy
70function first appeared in
71.Bx 4.4 .
72