man3/wmemcpy.3

   1 '\" t
   2 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   3 .\"
   4 .\" SPDX-License-Identifier: GPL-2.0-or-later
   5 .\"
   6 .\" References consulted:
   7 .\"   GNU glibc-2 source code and manual
   8 .\"   Dinkumware C library reference http://www.dinkumware.com/
   9 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  10 .\"   ISO/IEC 9899:1999
  11 .\"
  12 .TH wmemcpy 3 (date) "Linux man-pages (unreleased)"
  13 .SH NAME
  14 wmemcpy \- copy an array of wide-characters
  15 .SH LIBRARY
  16 Standard C library
  17 .RI ( libc ", " \-lc )
  18 .SH SYNOPSIS
  19 .nf
  20 .B #include <wchar.h>
  21 .PP
  22 .BI "wchar_t *wmemcpy(wchar_t " dest "[restrict ." n ],
  23 .BI "                 const wchar_t " src "[restrict ." n ],
  24 .BI "                 size_t " n );
  25 .fi
  26 .SH DESCRIPTION
  27 The
  28 .BR wmemcpy ()
  29 function is the wide-character equivalent of the
  30 .BR memcpy (3)
  31 function.
  32 It copies
  33 .I n
  34 wide characters from the array starting at
  35 .I src
  36 to the array starting at
  37 .IR dest .
  38 .PP
  39 The arrays may not overlap; use
  40 .BR wmemmove (3)
  41 to copy between overlapping
  42 arrays.
  43 .PP
  44 The programmer must ensure that there is room for at least
  45 .I n
  46 wide
  47 characters at
  48 .IR dest .
  49 .SH RETURN VALUE
  50 .BR wmemcpy ()
  51 returns
  52 .IR dest .
  53 .SH ATTRIBUTES
  54 For an explanation of the terms used in this section, see
  55 .BR attributes (7).
  56 .TS
  57 allbox;
  58 lbx lb lb
  59 l l l.
  60 Interface       Attribute       Value
  61 T{
  62 .na
  63 .nh
  64 .BR wmemcpy ()
  65 T}      Thread safety   MT-Safe
  66 .TE
  67 .sp 1
  68 .SH STANDARDS
  69 C11, POSIX.1-2008.
  70 .SH HISTORY
  71 POSIX.1-2001, C99.
  72 .SH SEE ALSO
  73 .BR memcpy (3),
  74 .BR wcscpy (3),
  75 .BR wmemmove (3),
  76 .BR wmempcpy (3)