string/FreeBSD/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 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)memcpy.3    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/string/memcpy.3,v 1.9 2009/04/07 13:42:53 trasz Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt MEMCPY 3
  37 .Os
  38 .Sh NAME
  39 .Nm memcpy
  40 .Nd copy memory area
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In string.h
  45 .Ft void *
  46 .Fo memcpy
  47 .Fa "void *restrict s1"
  48 .Fa "const void *restrict s2"
  49 .Fa "size_t n"
  50 .Fc
  51 .Sh DESCRIPTION
  52 The
  53 .Fn memcpy
  54 function
  55 copies
  56 .Fa n
  57 bytes from memory area
  58 .Fa s2
  59 to memory area
  60 .Fa s1 .
  61 If
  62 .Fa s1
  63 and
  64 .Fa s2
  65 overlap, behavior is undefined.
  66 Applications in which
  67 .Fa s1
  68 and
  69 .Fa s2
  70 might overlap should use
  71 .Xr memmove 3
  72 instead.
  73 .Sh RETURN VALUES
  74 The
  75 .Fn memcpy
  76 function
  77 returns the original value of
  78 .Fa s1 .
  79 .Sh SEE ALSO
  80 .Xr bcopy 3 ,
  81 .Xr memccpy 3 ,
  82 .Xr memmove 3 ,
  83 .Xr strcpy 3 ,
  84 .Xr wmemcpy 3
  85 .Sh STANDARDS
  86 The
  87 .Fn memcpy
  88 function
  89 conforms to
  90 .St -isoC .