summaryrefslogtreecommitdiffstats
path: root/man3/wcpcpy.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--man3/wcpcpy.380
1 files changed, 80 insertions, 0 deletions
diff --git a/man3/wcpcpy.3 b/man3/wcpcpy.3
new file mode 100644
index 0000000..dfdc079
--- /dev/null
+++ b/man3/wcpcpy.3
@@ -0,0 +1,80 @@
+'\" t
+.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
+.\"
+.\" SPDX-License-Identifier: GPL-2.0-or-later
+.\"
+.\" References consulted:
+.\" GNU glibc-2 source code and manual
+.\" Dinkumware C library reference http://www.dinkumware.com/
+.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
+.\"
+.TH wcpcpy 3 2023-07-20 "Linux man-pages 6.05.01"
+.SH NAME
+wcpcpy \- copy a wide-character string, returning a pointer to its end
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
+.SH SYNOPSIS
+.nf
+.B #include <wchar.h>
+.PP
+.BI "wchar_t *wcpcpy(wchar_t *restrict " dest \
+", const wchar_t *restrict " src );
+.fi
+.PP
+.RS -4
+Feature Test Macro Requirements for glibc (see
+.BR feature_test_macros (7)):
+.RE
+.PP
+.BR wcpcpy ():
+.nf
+ Since glibc 2.10:
+ _POSIX_C_SOURCE >= 200809L
+ Before glibc 2.10:
+ _GNU_SOURCE
+.fi
+.SH DESCRIPTION
+The
+.BR wcpcpy ()
+function is the wide-character equivalent of the
+.BR stpcpy (3)
+function.
+It copies the wide-character string pointed to by
+.IR src ,
+including the terminating null wide character (L\[aq]\e0\[aq]),
+to the array pointed to by
+.IR dest .
+.PP
+The strings may not overlap.
+.PP
+The programmer must ensure that there
+is room for at least
+.I wcslen(src)+1
+wide characters at
+.IR dest .
+.SH RETURN VALUE
+.BR wcpcpy ()
+returns a pointer to the end of the wide-character string
+.IR dest ,
+that is, a pointer to the terminating null wide character.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface Attribute Value
+T{
+.na
+.nh
+.BR wcpcpy ()
+T} Thread safety MT-Safe
+.TE
+.sp 1
+.SH STANDARDS
+POSIX.1-2008.
+.SH SEE ALSO
+.BR strcpy (3),
+.BR wcscpy (3)