lib/libc/string/memcpy.3

   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 and the American National Standards Committee X3,
   6 .\" on Information Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)memcpy.3    8.1 (Berkeley) 6/4/93
  37 .\" $FreeBSD: src/lib/libc/string/memcpy.3,v 1.3.2.4 2002/02/11 02:10:47 dd Exp $
  38 .\" $DragonFly: src/lib/libc/string/memcpy.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  39 .\"
  40 .Dd June 4, 1993
  41 .Dt MEMCPY 3
  42 .Os
  43 .Sh NAME
  44 .Nm memcpy
  45 .Nd copy byte string
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In string.h
  50 .Ft void *
  51 .Fn memcpy "void *dst" "const void *src" "size_t len"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn memcpy
  55 function
  56 copies
  57 .Fa len
  58 bytes from string
  59 .Fa src
  60 to string
  61 .Fa dst .
  62 .Sh RETURN VALUES
  63 The
  64 .Fn memcpy
  65 function
  66 returns the original value of
  67 .Fa dst .
  68 .Sh SEE ALSO
  69 .Xr bcopy 3 ,
  70 .Xr memccpy 3 ,
  71 .Xr memmove 3 ,
  72 .Xr strcpy 3
  73 .Sh STANDARDS
  74 The
  75 .Fn memcpy
  76 function
  77 conforms to
  78 .St -isoC .
  79 .Sh BUGS
  80 In this implementation
  81 .Fn memcpy
  82 is implemented using
  83 .Xr bcopy 3 ,
  84 and therefore the strings may overlap.
  85 On other systems, copying overlapping strings may produce surprises.
  86 Programs intended to be portable should use
  87 .Xr memmove 3
  88 when
  89 .Fa src
  90 and
  91 .Fa dst
  92 may overlap.