1.\" $OpenBSD: wcscpy.3,v 1.4 2013/09/25 21:49:31 millert Exp $ 2.\" 3.\" Copyright (c) 1990, 1991 The Regents of the University of California. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to Berkeley by 7.\" Chris Torek and the American National Standards Committee X3, 8.\" on Information Processing Systems. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.Dd $Mdocdate: September 25 2013 $ 35.Dt WCSCPY 3 36.Os 37.Sh NAME 38.Nm wcscpy , 39.Nm wcsncpy 40.Nd copy wide strings 41.Sh SYNOPSIS 42.In wchar.h 43.Ft wchar_t * 44.Fn wcscpy "wchar_t * restrict dst" "const wchar_t * restrict src" 45.Ft wchar_t * 46.Fo wcsncpy 47.Fa "wchar_t * restrict dst" 48.Fa "const wchar_t * restrict src" 49.Fa "size_t len" 50.Fc 51.Sh DESCRIPTION 52The 53.Fn wcscpy 54and 55.Fn wcsncpy 56functions copy the wide string 57.Fa src 58to 59.Fa dst 60(including the terminating null wide character). 61.Pp 62The 63.Fn wcsncpy 64function copies not more than 65.Fa len 66wide characters to 67.Fa dst , 68appending null wide characters if the length of 69.Fa src 70is less than 71.Fa len , 72and 73.Em not 74terminating 75.Fa dst 76if the length of 77.Fa src 78is greater than or equal to 79.Fa len . 80.Pp 81If the 82.Fa src 83and 84.Fa dst 85strings overlap, the behavior is undefined. 86.Sh RETURN VALUES 87The 88.Fn wcscpy 89and 90.Fn wcsncpy 91functions return 92.Fa dst . 93.Sh SEE ALSO 94.Xr strcpy 3 , 95.Xr strlcpy 3 , 96.Xr wcscat 3 , 97.Xr wcslcpy 3 , 98.Xr wmemcpy 3 , 99.Xr wmemmove 3 100.Sh STANDARDS 101The 102.Fn wcscpy 103and 104.Fn wcsncpy 105functions conform to 106.St -isoC-99 107and were first introduced in 108.St -isoC-amd1 . 109.Sh HISTORY 110The 111.Fn wcscpy 112and 113.Fn wcsncpy 114functions were ported from 115.Nx 116and first appeared in 117.Ox 3.8 . 118.Sh CAVEATS 119Using the functions 120.Fn wcscpy 121and 122.Fn wcsncpy 123is very error-prone with respect to buffer overflows; 124see the EXAMPLES section in 125.Xr strcpy 3 126for correct usage. 127Using 128.Xr wcslcpy 3 129is a better choice in most cases. 130