share/man/man9/bcopy.9

   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 .\"     from: @(#)bcopy.3       8.1 (Berkeley) 6/4/93
  32 .\"     $NetBSD: bcopy.9,v 1.8 2003/04/16 13:35:25 wiz Exp $
  33 .\"
  34 .Dd July 7, 2001
  35 .Dt BCOPY 9
  36 .Os
  37 .Sh NAME
  38 .Nm bcopy
  39 .Nd copy byte string
  40 .Sh SYNOPSIS
  41 .In sys/systm.h
  42 .Ft void
  43 .Fn bcopy "const void *src" "void *dst" "size_t len"
  44 .Sh DESCRIPTION
  45 .Bf -symbolic
  46 The
  47 .Fn bcopy
  48 interface is obsolete.
  49 Do not add new code using it.
  50 It will soon be purged.
  51 Use
  52 .Xr memcpy 9
  53 instead.
  54 (The
  55 .Fn bcopy
  56 function is now a macro for
  57 .Xr memcpy 9 . )
  58 .Ef
  59 .Pp
  60 The
  61 .Fn bcopy
  62 function
  63 copies
  64 .Fa len
  65 bytes from string
  66 .Fa src
  67 to string
  68 .Fa dst .
  69 .Pp
  70 .Bf -symbolic
  71 Unlike
  72 .Xr bcopy 3
  73 the two strings must not overlap!
  74 .Ef
  75 In the traditional
  76 .Bx
  77 kernel, overlapping copies were handled by the now-purged
  78 .Fn ovbcopy
  79 function.
  80 If you need to copy overlapping data, see
  81 .Xr memmove 9 .
  82 .Pp
  83 If
  84 .Fa len
  85 is zero, no bytes are copied.
  86 .Sh SEE ALSO
  87 .Xr bcopy 3 ,
  88 .Xr memcpy 9 ,
  89 .Xr memmove 9