locale.1, localedef.1, _exit.2, accept.2, access.2, acct.2, adjtimex.2, bdflush.2...

[thirdparty/man-pages.git] / man3 / wcpncpy.3

diff --git a/man3/wcpncpy.3 b/man3/wcpncpy.3
index 839b43d295c905a9cbfa603e6dc9875e938aa27f..b516b2e610103ae6ce0aa09224ad620c973c73ea 100644 (file)
--- a/man3/wcpncpy.3
+++ b/man3/wcpncpy.3
@@ -1,27 +1,46 @@
 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
 .\"
+.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
 .\" 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.
+.\" %%%LICENSE_END
 .\"
 .\" 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
+.\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
 .\"
-.TH WCPNCPY 3 2003-11-01 "GNU" "Linux Programmer's Manual"
+.TH WCPNCPY 3 2016-03-15 "GNU" "Linux Programmer's Manual"
 .SH NAME
 wcpncpy \- copy a fixed-size string of wide characters,
 returning a pointer to its end
 .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
+.sp
+.in -4n
+Feature Test Macro Requirements for glibc (see
+.BR feature_test_macros (7)):
+.in
+.sp
+.BR wcpncpy ():
+.PD 0
+.ad l
+.RS 4
+.TP 4
+Since glibc 2.10:
+_POSIX_C_SOURCE\ >=\ 200809L
+.TP
+Before glibc 2.10:
+_GNU_SOURCE
+.RE
+.ad
+.PD
 .SH DESCRIPTION
 The
 .BR wcpncpy ()
@@ -29,29 +48,62 @@ function is the wide-character equivalent
 of the
 .BR stpncpy (3)
 function.
-It copies at most \fIn\fP wide characters from the wide-character
-string pointed to by \fIsrc\fP, including the terminating L'\\0' character,
-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,
+It copies at most
+.I n
+wide characters from the wide-character
+string pointed to by
+.IR src ,
+including the terminating null wide (L\(aq\\0\(aq),
+to the array pointed to by
+.IR dest .
+Exactly
+.I n
+wide characters are
+written at
+.IR dest .
+If the length
+.IR wcslen(src)
+is smaller than
+.IR n ,
 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.
+by
+.I dest
+are filled with L\(aq\\0\(aq characters.
+If the length
+.IR wcslen(src)
+is greater than or equal
+to
+.IR n ,
+the string pointed to by
+.I dest
+will
+not be L\(aq\\0\(aq terminated.
 .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"
+The programmer must ensure that there is room for at least
+.I n
+wide
+characters at
+.IR dest .
+.SH RETURN VALUE
+.BR wcpncpy ()
+returns a pointer to the last wide character written, that is,
+.IR dest + n \-1.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface      Attribute       Value
+T{
 .BR wcpncpy ()
-returns a pointer to the last wide character written, i.e.
-\fIdest + n \- 1\fP.
-.SH "CONFORMING TO"
-This function is a GNU extension.
-.SH "SEE ALSO"
+T}     Thread safety   MT-Safe
+.TE
+.SH CONFORMING TO
+POSIX.1-2008.
+.SH SEE ALSO
 .BR stpncpy (3),
-.BR wcsncpy (3),
-.BR feature_test_macros (7)
+.BR wcsncpy (3)