summaryrefslogtreecommitdiff
path: root/src/lib/libc/string/wcscpy.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libc/string/wcscpy.3')
-rw-r--r--src/lib/libc/string/wcscpy.397
1 files changed, 97 insertions, 0 deletions
diff --git a/src/lib/libc/string/wcscpy.3 b/src/lib/libc/string/wcscpy.3
new file mode 100644
index 0000000000..a71d54f886
--- /dev/null
+++ b/src/lib/libc/string/wcscpy.3
@@ -0,0 +1,97 @@
1.\" Copyright (c) 1990, 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek and the American National Standards Committee X3,
6.\" on Information Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in the
15.\" documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\" $OpenBSD: wcscpy.3,v 1.1 2011/07/09 16:32:11 nicm Exp $
33.\"
34.Dd $Mdocdate: July 9 2011 $
35.Dt WCSCPY 3
36.Os
37.Sh NAME
38.Nm wcscpy ,
39.Nm wcsncpy
40.Nd copy wide strings
41.Sh SYNOPSIS
42.Fd #include <wchar.h>
43.Ft wchar_t *
44.Fn wcscpy "wchar_t * restrict dst" "const wchar_t * restrict src"
45.Ft wchar_t *
46.Fo wcsncpy
47.Fa "wchar_t * restrict dst"
48.Fa "const wchar_t * restrict src"
49.Fa "size_t len"
50.Fc
51.Sh DESCRIPTION
52The
53.Fn wcscpy
54function copies the wide string
55.Fa src
56to
57.Fa dst
58(including the terminating null wide character).
59.Pp
60The
61.Fn wcsncpy
62function copies not more than
63.Fa len
64wide characters to
65.Fa dst ,
66appending null wide characters if the length of
67.Fa src
68is less than
69.Fa len ,
70and
71.Em not
72terminating
73.Fa dst
74if the length of
75.Fa src
76is greater than or equal to
77.Fa len .
78.Sh RETURN VALUES
79The
80.Fn wcscpy
81and
82.Fn wcsncpy
83functions return
84.Fa dst .
85.Sh SEE ALSO
86.Xr wcslcpy 3 ,
87.Xr wmemcpy 3 ,
88.Xr wmemmove 3
89.Sh STANDARDS
90The
91.Fn wcscpy
92and
93.Fn wcsncpy
94functions conform to
95.St -isoC-99
96and were first introduced in
97.St -isoC-amd1 .