.\"	$OpenBSD: wmemcpy.3,v 1.3 2011/07/25 00:38:53 schwarze Exp $
.\"
.\" Copyright (c) 1990, 1991 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.
.\" 3. 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.
.\"
.Dd $Mdocdate: July 25 2011 $
.Dt WMEMCPY 3
.Os
.Sh NAME
.Nm wmemcpy
.Nd copy wide characters
.Sh SYNOPSIS
.Fd #include <wchar.h>
.Ft wchar_t *
.Fn wmemcpy "wchar_t * restrict dst" "const wchar_t * restrict src" "size_t len"
.Sh DESCRIPTION
The
.Fn wmemcpy
function copies
.Fa len
wide characters from buffer
.Fa src
to buffer
.Fa dst .
.Sh RETURN VALUES
The
.Fn wmemcpy
function returns the original value of
.Fa dst .
.Sh SEE ALSO
.Xr memcpy 3 ,
.Xr wcscpy 3 ,
.Xr wcslcpy 3 ,
.Xr wmemmove 3
.Sh STANDARDS
The
.Fn wmemcpy
function conforms to
.St -isoC-99
and was first introduced in
.St -isoC-amd1 .
.Sh HISTORY
The
.Fn wmemcpy
function was ported from
.Nx
and first appeared in
.Ox 3.8 .
.Sh CAVEATS
In this implementation
.Fn wmemcpy
is implemented using
.Xr bcopy 3 ,
and therefore the buffers may overlap.
On other systems, copying overlapping buffers may produce surprises.
A portable, safe solution is to use
.Xr wmemmove 3 .