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