mbrtowc.3: SYNOPSIS: Use 'restrict' in prototypes
[man-pages.git] / man3 / wcsncat.3
blob0d88bb999885b9d5383ff2cbafb6fd4c5ea920a0
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 WCSNCAT 3  2019-03-06 "GNU" "Linux Programmer's Manual"
17 .SH NAME
18 wcsncat \- concatenate two wide-character strings
19 .SH SYNOPSIS
20 .nf
21 .B #include <wchar.h>
22 .PP
23 .BI "wchar_t *wcsncat(wchar_t *" dest ", const wchar_t *" src ", size_t " n );
24 .fi
25 .SH DESCRIPTION
26 The
27 .BR wcsncat ()
28 function is the wide-character equivalent of the
29 .BR strncat (3)
30 function.
31 It copies at most
32 .I n
33 wide characters from the wide-character
34 string pointed to by
35 .I src
36 to the end of the wide-character string pointed
37 to by
38 .IR dest ,
39 and adds a terminating null wide character (L\(aq\e0\(aq).
40 .PP
41 The strings may not overlap.
42 .PP
43 The programmer must ensure that there is room for at least
44 .IR wcslen(dest) + n +1
45 wide characters at
46 .IR dest .
47 .SH RETURN VALUE
48 .BR wcsncat ()
49 returns
50 .IR dest .
51 .SH ATTRIBUTES
52 For an explanation of the terms used in this section, see
53 .BR attributes (7).
54 .ad l
55 .nh
56 .TS
57 allbox;
58 lbx lb lb
59 l l l.
60 Interface       Attribute       Value
62 .BR wcsncat ()
63 T}      Thread safety   MT-Safe
64 .TE
65 .hy
66 .ad
67 .sp 1
68 .SH CONFORMING TO
69 POSIX.1-2001, POSIX.1-2008, C99.
70 .SH SEE ALSO
71 .BR strncat (3),
72 .BR wcscat (3)