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  2021-03-22 "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 .PP
  23 .BI "wchar_t *wmemcpy(wchar_t *restrict " dest \
  24 ", const wchar_t *restrict " src ,
  25 .BI "                 size_t " n );
  26 .fi
  27 .SH DESCRIPTION
  28 The
  29 .BR wmemcpy ()
  30 function is the wide-character equivalent of the
  31 .BR memcpy (3)
  32 function.
  33 It copies
  34 .I n
  35 wide characters from the array starting at
  36 .I src
  37 to the array starting at
  38 .IR dest .
  39 .PP
  40 The arrays may not overlap; use
  41 .BR wmemmove (3)
  42 to copy between overlapping
  43 arrays.
  44 .PP
  45 The programmer must ensure that there is room for at least
  46 .I n
  47 wide
  48 characters at
  49 .IR dest .
  50 .SH RETURN VALUE
  51 .BR wmemcpy ()
  52 returns
  53 .IR dest .
  54 .SH ATTRIBUTES
  55 For an explanation of the terms used in this section, see
  56 .BR attributes (7).
  57 .ad l
  58 .nh
  59 .TS
  60 allbox;
  61 lbx lb lb
  62 l l l.
  63 Interface       Attribute       Value
  64 T{
  65 .BR wmemcpy ()
  66 T}      Thread safety   MT-Safe
  67 .TE
  68 .hy
  69 .ad
  70 .sp 1
  71 .SH CONFORMING TO
  72 POSIX.1-2001, POSIX.1-2008, C99.
  73 .SH SEE ALSO
  74 .BR memcpy (3),
  75 .BR wcscpy (3),
  76 .BR wmemmove (3),
  77 .BR wmempcpy (3)