.\"	$OpenBSD: wcscpy.3,v 1.2 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 WCSCPY 3
.Os
.Sh NAME
.Nm wcscpy ,
.Nm wcsncpy
.Nd copy wide strings
.Sh SYNOPSIS
.Fd #include <wchar.h>
.Ft wchar_t *
.Fn wcscpy "wchar_t * restrict dst" "const wchar_t * restrict src"
.Ft wchar_t *
.Fo wcsncpy
.Fa "wchar_t * restrict dst"
.Fa "const wchar_t * restrict src"
.Fa "size_t len"
.Fc
.Sh DESCRIPTION
The
.Fn wcscpy
and
.Fn wcsncpy
functions copy the wide string
.Fa src
to
.Fa dst
(including the terminating null wide character).
.Pp
The
.Fn wcsncpy
function copies not more than
.Fa len
wide characters to
.Fa dst ,
appending null wide characters if the length of
.Fa src
is less than
.Fa len ,
and
.Em not
terminating
.Fa dst
if the length of
.Fa src
is greater than or equal to
.Fa len .
.Sh RETURN VALUES
The
.Fn wcscpy
and
.Fn wcsncpy
functions return
.Fa dst .
.Sh SEE ALSO
.Xr strcpy 3 ,
.Xr strlcpy 3 ,
.Xr wcscat 3 ,
.Xr wcslcpy 3 ,
.Xr wmemcpy 3 ,
.Xr wmemmove 3
.Sh STANDARDS
The
.Fn wcscpy
and
.Fn wcsncpy
functions conform to
.St -isoC-99
and were first introduced in
.St -isoC-amd1 .
.Sh HISTORY
The
.Fn wcscpy
and
.Fn wcsncpy
functions were ported from
.Nx
and first appeared in
.Ox 3.8 .
.Sh CAVEATS
Using the functions
.Fn wcscpy
and
.Fn wcsncpy
is very error-prone with respect to buffer overflows;
see the EXAMPLES section in
.Xr strcpy 3
for correct usage.
Using
.Xr wcslcpy 3
is a better choice in most cases.