]> git.ipfire.org Git - thirdparty/man-pages.git/blob - man3/wcscpy.3
wcscpy.3: ATTRIBUTES: Note function that is thread-safe
[thirdparty/man-pages.git] / 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 2013-12-02 "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
33 .IR src ,
34 including the terminating null wide character (L\(aq\\0\(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 .SS Multithreading (see pthreads(7))
51 The
52 .BR wcscpy ()
53 function is thread-safe.
54 .SH CONFORMING TO
55 C99.
56 .SH SEE ALSO
57 .BR strcpy (3),
58 .BR wcpcpy (3),
59 .BR wcscat (3),
60 .BR wcsdup (3),
61 .BR wmemcpy (3)