xref: /freebsd/lib/libc/string/bcopy.3 (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.Dd August 24, 2015
32.Dt BCOPY 3
33.Os
34.Sh NAME
35.Nm bcopy
36.Nd copy byte string
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In strings.h
41.Ft void
42.Fn bcopy "const void *src" "void *dst" "size_t len"
43.Sh DESCRIPTION
44The
45.Fn bcopy
46function
47copies
48.Fa len
49bytes from string
50.Fa src
51to string
52.Fa dst .
53The two strings may overlap.
54If
55.Fa len
56is zero, no bytes are copied.
57.Sh SEE ALSO
58.Xr memccpy 3 ,
59.Xr memcpy 3 ,
60.Xr memmove 3 ,
61.Xr strcpy 3 ,
62.Xr strncpy 3
63.Sh HISTORY
64A
65.Fn bcopy
66function appeared in
67.Bx 4.2 .
68Its prototype existed previously in
69.In string.h
70before it was moved to
71.In strings.h
72for
73.St -p1003.1-2001
74compliance.
75.Pp
76.St -p1003.1-2008
77removes the specification of
78.Fn bcopy
79and it is marked as LEGACY in
80.St -p1003.1-2004 .
81New programs should use
82.Xr memmove 3 .
83If the input and output buffer do not overlap, then
84.Xr memcpy 3
85is more efficient.
86Note that
87.Fn bcopy
88takes
89.Ar src
90and
91.Ar dst
92in the opposite order from
93.Fn memmove
94and
95.Fn memcpy .
96