Changes.old: Add missing entry in 5.13 changelog
[man-pages.git] / man3 / wcsncpy.3
blob9fbd0ce87aff694d1b39d717245c8bde06d619fd
1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2 .\"
3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
4 .\" This is free documentation; you can redistribute it and/or
5 .\" modify it under the terms of the GNU General Public License as
6 .\" published by the Free Software Foundation; either version 2 of
7 .\" the License, or (at your option) any later version.
8 .\" %%%LICENSE_END
9 .\"
10 .\" References consulted:
11 .\"   GNU glibc-2 source code and manual
12 .\"   Dinkumware C library reference http://www.dinkumware.com/
13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
14 .\"   ISO/IEC 9899:1999
15 .\"
16 .TH WCSNCPY 3  2021-03-22 "GNU" "Linux Programmer's Manual"
17 .SH NAME
18 wcsncpy \- copy a fixed-size string of wide characters
19 .SH SYNOPSIS
20 .nf
21 .B #include <wchar.h>
22 .PP
23 .BI "wchar_t *wcsncpy(wchar_t *restrict " dest \
24 ", const wchar_t *restrict " src ,
25 .BI "                 size_t " n );
26 .fi
27 .SH DESCRIPTION
28 The
29 .BR wcsncpy ()
30 function is the wide-character equivalent of the
31 .BR strncpy (3)
32 function.
33 It copies at most
34 .I n
35 wide characters from the wide-character
36 string pointed to by
37 .IR src ,
38 including the terminating null wide character (L\(aq\e0\(aq),
39 to the array pointed to by
40 .IR dest .
41 Exactly
42 .I n
43 wide characters are
44 written at
45 .IR dest .
46 If the length \fIwcslen(src)\fP is smaller than
47 .IR n ,
48 the remaining wide characters in the array
49 pointed to by
50 .I dest
51 are filled
52 with null wide characters.
53 If the length \fIwcslen(src)\fP is greater than or equal
55 .IR n ,
56 the string pointed to by
57 .I dest
58 will not be terminated by a null wide character.
59 .PP
60 The strings may not overlap.
61 .PP
62 The programmer must ensure that there is room for at least
63 .I n
64 wide
65 characters at
66 .IR dest .
67 .SH RETURN VALUE
68 .BR wcsncpy ()
69 returns
70 .IR dest .
71 .SH ATTRIBUTES
72 For an explanation of the terms used in this section, see
73 .BR attributes (7).
74 .ad l
75 .nh
76 .TS
77 allbox;
78 lbx lb lb
79 l l l.
80 Interface       Attribute       Value
82 .BR wcsncpy ()
83 T}      Thread safety   MT-Safe
84 .TE
85 .hy
86 .ad
87 .sp 1
88 .SH CONFORMING TO
89 POSIX.1-2001, POSIX.1-2008, C99.
90 .SH SEE ALSO
91 .BR strncpy (3)