original/man3/wmemcpy.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" References consulted:
  11 .\"   GNU glibc-2 source code and manual
  12 .\"   Dinkumware C library reference http://www.dinkumware.com/
  13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  14 .\"   ISO/IEC 9899:1999
  15 .\"
  16 .TH WMEMCPY 3  2013-11-11 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 wmemcpy \- copy an array of wide-characters
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <wchar.h>
  22 .sp
  23 .BI "wchar_t *wmemcpy(wchar_t *" dest ", const wchar_t *" src ", size_t " n );
  24 .fi
  25 .SH DESCRIPTION
  26 The
  27 .BR wmemcpy ()
  28 function is the wide-character equivalent of the
  29 .BR memcpy (3)
  30 function.
  31 It copies
  32 .I n
  33 wide characters from the array starting at
  34 .I src
  35 to the array starting at
  36 .IR dest .
  37 .PP
  38 The arrays may not overlap; use
  39 .BR wmemmove (3)
  40 to copy between overlapping
  41 arrays.
  42 .PP
  43 The programmer must ensure that there is room for at least
  44 .I n
  45 wide
  46 characters at
  47 .IR dest .
  48 .SH RETURN VALUE
  49 .BR wmemcpy ()
  50 returns
  51 .IR dest .
  52 .SH ATTRIBUTES
  53 .SS Multithreading (see pthreads(7))
  54 The
  55 .BR wmemcpy ()
  56 function is thread-safe.
  57 .SH CONFORMING TO
  58 C99.
  59 .SH SEE ALSO
  60 .BR memcpy (3),
  61 .BR wcscpy (3),
  62 .BR wmemmove (3),
  63 .BR wmempcpy (3)