man-pages/man3/wcpcpy.3

49 lines
1.5 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" 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 1999-07-25 "GNU" "Linux Programmer's Manual"
.SH NAME
wcpcpy \- copy a wide-character string, returning a pointer to its end
2004-11-03 13:51:07 +00:00
.SH SYNOPSIS
.nf
.B #define _GNU_SOURCE
.br
.B #include <wchar.h>
.sp
.BI "wchar_t *wcpcpy(wchar_t *" dest ", const wchar_t *" src );
.fi
.SH DESCRIPTION
The
.BR wcpcpy ()
function is the wide-character equivalent of the
2007-05-21 22:14:09 +00:00
.BR stpcpy (3)
function.
It copies the wide-character string pointed to by \fIsrc\fP,
2008-06-09 15:49:35 +00:00
including the terminating L\(aq\\0\(aq character, to the array pointed to by
2004-11-03 13:51:07 +00:00
\fIdest\fP.
.PP
The strings may not overlap.
.PP
2008-06-09 15:49:35 +00:00
The programmer must ensure that there
is room for at least \fIwcslen(src)+1\fP
2004-11-03 13:51:07 +00:00
wide characters at \fIdest\fP.
.SH "RETURN VALUE"
.BR wcpcpy ()
returns a pointer to the end of the wide-character string
2008-06-09 15:49:35 +00:00
\fIdest\fP, that is, a pointer to the terminating L\(aq\\0\(aq character.
2004-11-03 13:51:07 +00:00
.SH "CONFORMING TO"
This function is a GNU extension.
.SH "SEE ALSO"
.BR strcpy (3),
2007-01-28 20:00:24 +00:00
.BR wcscpy (3),
.BR feature_test_macros (7)