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. 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$
  34 .\"
  35 .Dd July 14, 2021
  36 .Dt MEMCPY 3
  37 .Os
  38 .Sh NAME
  39 .Nm memcpy
  40 .Nd copy byte string
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In string.h
  45 .Ft void *
  46 .Fn memcpy "void *dst" "const void *src" "size_t len"
  47 .Ft void *
  48 .Fn mempcpy "void *dst" "const void *src" "size_t len"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn memcpy
  52 and
  53 .Fn mempcpy
  54 functions
  55 copy
  56 .Fa len
  57 bytes from string
  58 .Fa src
  59 to string
  60 .Fa dst .
  61 If
  62 .Fa src
  63 and
  64 .Fa dst
  65 overlap, the results are not defined.
  66 .Sh RETURN VALUES
  67 The
  68 .Fn memcpy
  69 function
  70 returns the original value of
  71 .Fa dst .
  72 .Pp
  73 The
  74 .Fn mempcpy
  75 function returns a pointer to the byte after the last written byte.
  76 .Sh SEE ALSO
  77 .Xr bcopy 3 ,
  78 .Xr memccpy 3 ,
  79 .Xr memmove 3 ,
  80 .Xr strcpy 3 ,
  81 .Xr wmemcpy 3
  82 .Xr wmempcpy 3
  83 .Sh STANDARDS
  84 The
  85 .Fn memcpy
  86 function
  87 conforms to
  88 .St -isoC .