'\" et
.TH WCSNCPY "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
wcpncpy, wcsncpy
\(em copy a fixed-size wide-character string, returning a pointer
to its end
.SH SYNOPSIS
.LP
.nf
#include <wchar.h>
.P
wchar_t *wcpncpy(wchar_t restrict *\fIws1\fP, const wchar_t *restrict \fIws2\fP,
    size_t \fIn\fP);
wchar_t *wcsncpy(wchar_t *restrict \fIws1\fP, const wchar_t *restrict \fIws2\fP,
    size_t \fIn\fP);
.fi
.SH DESCRIPTION
For
\fIwcsncpy\fR():
The functionality described on this reference page is aligned with the
ISO\ C standard. Any conflict between the requirements described here and the
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
.P
The
\fIwcpncpy\fR()
and
\fIwcsncpy\fR()
functions shall copy not more than
.IR n
wide-character codes (wide-character codes that follow a null
wide-character code are not copied) from the array pointed to by
.IR ws2
to the array pointed to by
.IR ws1 .
If copying takes place between objects that overlap, the behavior is
undefined.
.P
If the array pointed to by
.IR ws2
is a wide-character string that is shorter than
.IR n
wide-character codes, null wide-character codes shall be appended to
the copy in the array pointed to by
.IR ws1 ,
until
.IR n
wide-character codes in all are written.
.SH "RETURN VALUE"
If any null wide-character codes were written into the
destination, the
\fIwcpncpy\fR()
function shall return the address of the first such null wide-character
code. Otherwise, it shall return
.IR &ws1 [ n ].
.P
The
\fIwcsncpy\fR()
function shall return
.IR ws1 .
.P
No return values are reserved to indicate an error.
.SH ERRORS
No errors are defined.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
If there is no null wide-character code in the first
.IR n
wide-character codes of the array pointed to by
.IR ws2 ,
the result is not null-terminated.
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIstrncpy\fR\^(\|)",
.IR "\fIwcscpy\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<wchar.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .