]> git.ipfire.org Git - thirdparty/man-pages.git/blob - man3/wcscpy.3
MB_CUR_MAX.3, MB_LEN_MAX.3, btowc.3, fgetwc.3, fgetws.3, fputwc.3, fputws.3, fwide...
[thirdparty/man-pages.git] / man3 / wcscpy.3
1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2 .\"
3 .\" %%%LICENSE_START(GPLv2+_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 2011-09-28 "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 .sp
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 \fIsrc\fP,
33 including the terminating null wide character (L\(aq\\0\(aq),
34 to the array pointed to by
35 \fIdest\fP.
36 .PP
37 The strings may not overlap.
38 .PP
39 The programmer must ensure that there is
40 room for at least \fIwcslen(src)+1\fP
41 wide characters at \fIdest\fP.
42 .SH RETURN VALUE
43 .BR wcscpy ()
44 returns \fIdest\fP.
45 .SH CONFORMING TO
46 C99.
47 .SH SEE ALSO
48 .BR strcpy (3),
49 .BR wcpcpy (3),
50 .BR wcscat (3),
51 .BR wcsdup (3),
52 .BR wmemcpy (3)