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 WCPNCPY 3 2003-11-01 "GNU" "Linux Programmer's Manual"
|
|
|
|
.SH NAME
|
2007-04-12 22:42:49 +00:00
|
|
|
wcpncpy \- copy a fixed-size string of wide characters,
|
2006-12-27 03:54:41 +00:00
|
|
|
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 *wcpncpy(wchar_t *" dest ", const wchar_t *" src ", size_t " n );
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2007-04-12 22:42:49 +00:00
|
|
|
The \fBwcpncpy\fP() function is the wide-character equivalent
|
|
|
|
of the \fBstpncpy\fP() function.
|
|
|
|
It copies at most \fIn\fP wide characters from the wide-character
|
2004-11-03 13:51:07 +00:00
|
|
|
string pointed to by \fIsrc\fP, including the terminating L'\\0' character,
|
2007-04-12 22:42:49 +00:00
|
|
|
to the array pointed to by \fIdest\fP.
|
|
|
|
Exactly \fIn\fP wide characters are
|
|
|
|
written at \fIdest\fP.
|
|
|
|
If the length \fIwcslen(src)\fP is smaller than \fIn\fP,
|
|
|
|
the remaining wide characters in the array pointed to
|
|
|
|
by \fIdest\fP are filled with L'\\0' characters.
|
|
|
|
If the length \fIwcslen(src)\fP is greater or equal
|
|
|
|
to \fIn\fP, the string pointed to by \fIdest\fP will
|
|
|
|
not be L'\\0' terminated.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
|
|
|
The strings may not overlap.
|
|
|
|
.PP
|
|
|
|
The programmer must ensure that there is room for at least \fIn\fP wide
|
|
|
|
characters at \fIdest\fP.
|
|
|
|
.SH "RETURN VALUE"
|
2005-10-19 06:54:38 +00:00
|
|
|
\fBwcpncpy\fP() returns a pointer to the last wide character written, i.e.
|
2005-07-06 08:00:30 +00:00
|
|
|
\fIdest + n \- 1\fP.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
|
|
|
This function is a GNU extension.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR stpncpy (3),
|
2007-01-28 20:00:24 +00:00
|
|
|
.BR wcsncpy (3),
|
|
|
|
.BR feature_test_macros (7)
|