process_madvise.2: wfix
[man-pages.git] / man3 / wcscpy.3
blob8fa4a4e8bb4af3507cba28a8c839f28ccb4b1d7b
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  2019-03-06 "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 *" dest ", const wchar_t *" 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 .IR "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
60 .BR wcscpy ()
61 T}      Thread safety   MT-Safe
62 .TE
63 .hy
64 .ad
65 .sp 1
66 .SH CONFORMING TO
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)