[apple/libc.git] / string / FreeBSD / memmove.3

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)memmove.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/string/memmove.3,v 1.8 2009/04/07 13:42:53 trasz Exp $
.\"
.Dd June 4, 1993
.Dt MEMMOVE 3
.Os
.Sh NAME
.Nm memmove
.Nd copy byte string
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In string.h
.Ft void *
.Fn memmove "void *dst" "const void *src" "size_t len"
.Sh DESCRIPTION
The
.Fn memmove
function
copies
.Fa len
bytes from string
.Fa src
to string
.Fa dst .
The two strings may overlap;
the copy is always done in a non-destructive manner.
.Sh RETURN VALUES
The
.Fn memmove
function returns the original value of
.Fa dst .
.Sh SEE ALSO
.Xr bcopy 3 ,
.Xr memccpy 3 ,
.Xr memcpy 3 ,
.Xr strcpy 3 ,
.Xr wmemmove 3
.Sh STANDARDS
The
.Fn memmove
function
conforms to
.St -isoC .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1990, 1991, 1993
e9ce8d39 A	2	.\" The Regents of the University of California. All rights reserved.
e9ce8d39 A	3	.\"
5b2abdfb A	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" Chris Torek and the American National Standards Committee X3,
	6	.\" on Information Processing Systems.
	7	.\"
e9ce8d39 A	8	.\" Redistribution and use in source and binary forms, with or without
	9	.\" modification, are permitted provided that the following conditions
	10	.\" are met:
	11	.\" 1. Redistributions of source code must retain the above copyright
	12	.\" notice, this list of conditions and the following disclaimer.
	13	.\" 2. Redistributions in binary form must reproduce the above copyright
	14	.\" notice, this list of conditions and the following disclaimer in the
	15	.\" documentation and/or other materials provided with the distribution.
e9ce8d39 A	16	.\" 4. Neither the name of the University nor the names of its contributors
	17	.\" may be used to endorse or promote products derived from this software
	18	.\" without specific prior written permission.
	19	.\"
	20	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	.\" SUCH DAMAGE.
	31	.\"
5b2abdfb	32	.\" @(#)memmove.3 8.1 (Berkeley) 6/4/93
1f2f436a	33	.\" $FreeBSD: src/lib/libc/string/memmove.3,v 1.8 2009/04/07 13:42:53 trasz Exp $
e9ce8d39	34	.\"
5b2abdfb A	35	.Dd June 4, 1993
5b2abdfb A	36	.Dt MEMMOVE 3
e9ce8d39 A	37	.Os
e9ce8d39 A	38	.Sh NAME
5b2abdfb A	39	.Nm memmove
5b2abdfb A	40	.Nd copy byte string
e9ce8d39 A	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
5b2abdfb A	44	.In string.h
5b2abdfb A	45	.Ft void *
6465356a	46	.Fn memmove "void dst" "const void src" "size_t len"
e9ce8d39 A	47	.Sh DESCRIPTION
e9ce8d39 A	48	The
5b2abdfb A	49	.Fn memmove
	50	function
	51	copies
6465356a	52	.Fa len
5b2abdfb	53	bytes from string
6465356a	54	.Fa src
5b2abdfb	55	to string
6465356a	56	.Fa dst .
5b2abdfb A	57	The two strings may overlap;
5b2abdfb A	58	the copy is always done in a non-destructive manner.
e9ce8d39	59	.Sh RETURN VALUES
5b2abdfb A	60	The
	61	.Fn memmove
	62	function returns the original value of
6465356a	63	.Fa dst .
e9ce8d39	64	.Sh SEE ALSO
5b2abdfb A	65	.Xr bcopy 3 ,
	66	.Xr memccpy 3 ,
	67	.Xr memcpy 3 ,
1f2f436a A	68	.Xr strcpy 3 ,
1f2f436a A	69	.Xr wmemmove 3
5b2abdfb	70	.Sh STANDARDS
e9ce8d39	71	The
5b2abdfb A	72	.Fn memmove
	73	function
	74	conforms to
	75	.St -isoC .