man3/wcscpy.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 WCSCPY 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 wcscpy \- copy a wide-character string
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <wchar.h>
  22 .PP
  23 .BI "wchar_t *wcscpy(wchar_t *restrict " dest \
  24 ", const wchar_t *restrict " src );
  25 .fi
  26 .SH DESCRIPTION
  27 The
  28 .BR wcscpy ()
  29 function is the wide-character equivalent
  30 of the
  31 .BR strcpy (3)
  32 function.
  33 It copies the wide-character string pointed to by
  34 .IR src ,
  35 including the terminating null wide character (L\(aq\e0\(aq),
  36 to the array pointed to by
  37 .IR dest .
  38 .PP
  39 The strings may not overlap.
  40 .PP
  41 The programmer must ensure that there is
  42 room for at least
  43 .IR "wcslen(src)+1"
  44 wide characters at
  45 .IR dest .
  46 .SH RETURN VALUE
  47 .BR wcscpy ()
  48 returns
  49 .IR dest .
  50 .SH ATTRIBUTES
  51 For an explanation of the terms used in this section, see
  52 .BR attributes (7).
  53 .ad l
  54 .nh
  55 .TS
  56 allbox;
  57 lbx lb lb
  58 l l l.
  59 Interface       Attribute       Value
  60 T{
  61 .BR wcscpy ()
  62 T}      Thread safety   MT-Safe
  63 .TE
  64 .hy
  65 .ad
  66 .sp 1
  67 .SH CONFORMING TO
  68 POSIX.1-2001, POSIX.1-2008, C99.
  69 .SH SEE ALSO
  70 .BR strcpy (3),
  71 .BR wcpcpy (3),
  72 .BR wcscat (3),
  73 .BR wcsdup (3),
  74 .BR wmemcpy (3)