summaryrefslogtreecommitdiff
path: root/man3/mempcpy.3
blob: 0203f4757dce34c1b90791ea3adbe00c26344e29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
.\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
.\" Distributed under GPL
.\" based on glibc infopages
.\"
.\" aeb, 2003, polished a little
.TH mempcpy 3 2003-11-11 "GNU" "Linux Programmer's Manual"
.SH NAME
mempcpy, wmempcpy  \- copy memory area
.SH SYNOPSIS
.nf
.B #define _GNU_SOURCE
.br
.B #include <string.h>
.sp
.BI "void *mempcpy(void *" dest ", const void *" src ", size_t " n );
.sp
.B #define _GNU_SOURCE
.br
.B #include <wchar.h>
.sp
.BI "wchar_t *wmempcpy(wchar_t *" dest ", const wchar_t *" src ", size_t " n );
.fi
.SH DESCRIPTION
The 
.B mempcpy() 
function is nearly identical to the
.B memcpy()
function.  It copies 
.I n 
bytes from the object beginning at
.I src 
into the object pointed to by 
.I dest.  
But instead of returning the value of 
.I dest
it returns a pointer to the byte following the last written byte.
.PP
This function is useful in situations where a number of objects
shall be copied to consecutive memory positions.
.PP
The
.B wmempcpy()
function is identical but takes
.I wchar_t
type arguments and copies
.I n
wide characters.
.SH "RETURN VALUE"
\fIdest\fP + \fIn\fP .
.SH "EXAMPLE"
.nf
void *
combine (void *o1, size_t s1, void *o2, size_t s2) {
     void *result = malloc(s1 + s2);
     if (result != NULL)
          mempcpy(mempcpy(result, o1, s1), o2, s2);
     return result;
}
.fi
.SH "CONFORMING TO"
This function is a GNU extension.
.SH "SEE ALSO"
.BR memccpy (3),
.BR memcpy (3),
.BR memmove (3),
.BR wmemcpy (3)