man3/wcscpy.3

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