xref: /freebsd/lib/libc/string/memccpy.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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 June 9, 1993
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.Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
42.Sh DESCRIPTION
43The
44.Fn memccpy
45function
46copies bytes from string
47.Fa src
48to string
49.Fa dst .
50If the character
51.Fa c
52(as converted to an
53.Vt "unsigned char" )
54occurs 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
73.Bx 4.4 .
74