ioctl_tty.2: Update DTR example
[man-pages.git] / man3 / wmemmove.3
blobb83a476ec07a057ff285644eb2ed45e6d6a90a3f
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 WMEMMOVE 3  2021-03-22 "GNU" "Linux Programmer's Manual"
17 .SH NAME
18 wmemmove \- copy an array of wide-characters
19 .SH SYNOPSIS
20 .nf
21 .B #include <wchar.h>
22 .PP
23 .BI "wchar_t *wmemmove(wchar_t *" dest ", const wchar_t *" src ", size_t " n );
24 .fi
25 .SH DESCRIPTION
26 The
27 .BR wmemmove ()
28 function is the wide-character equivalent of the
29 .BR memmove (3)
30 function.
31 It copies
32 .I n
33 wide characters from the array
34 starting at
35 .I src
36 to the array starting at
37 .IR dest .
38 The arrays may
39 overlap.
40 .PP
41 The programmer must ensure that there is room for at least
42 .I n
43 wide
44 characters at
45 .IR dest .
46 .SH RETURN VALUE
47 .BR wmemmove ()
48 returns
49 .IR dest .
50 .SH ATTRIBUTES
51 For an explanation of the terms used in this section, see
52 .BR attributes (7).
53 .ad l
54 .nh
55 .TS
56 allbox;
57 lbx lb lb
58 l l l.
59 Interface       Attribute       Value
61 .BR wmemmove ()
62 T}      Thread safety   MT-Safe
63 .TE
64 .hy
65 .ad
66 .sp 1
67 .SH CONFORMING TO
68 POSIX.1-2001, POSIX.1-2008, C99.
69 .SH SEE ALSO
70 .BR memmove (3),
71 .BR wmemcpy (3)