xref: /freebsd/lib/libc/string/memccpy.3 (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
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.\" $FreeBSD$
30.\"
31.Dd June 9, 1993
32.Dt MEMCCPY 3
33.Os
34.Sh NAME
35.Nm memccpy
36.Nd copy string until character found
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In string.h
41.Ft void *
42.Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
43.Sh DESCRIPTION
44The
45.Fn memccpy
46function
47copies bytes from string
48.Fa src
49to string
50.Fa dst .
51If the character
52.Fa c
53(as converted to an
54.Vt "unsigned char" )
55occurs in the string
56.Fa src ,
57the copy stops and a pointer to the byte after the copy of
58.Fa c
59in the string
60.Fa dst
61is returned.
62Otherwise,
63.Fa len
64bytes are copied, and a NULL pointer is returned.
65.Sh SEE ALSO
66.Xr bcopy 3 ,
67.Xr memcpy 3 ,
68.Xr memmove 3 ,
69.Xr strcpy 3
70.Sh HISTORY
71The
72.Fn memccpy
73function first appeared in
74.Bx 4.4 .
75