1a64d82da5
when talking about characters/bytes, use "nul" and "nul-terminate" when talking about pointers, use "null pointer" or ".Dv NULL"
159 lines
3.8 KiB
Groff
159 lines
3.8 KiB
Groff
.\" 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.
|
|
.\" 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.
|
|
.\"
|
|
.\" from: @(#)strcpy.3 8.1 (Berkeley) 6/4/93
|
|
.\" $NetBSD: strcpy.3,v 1.17 2006/10/16 08:48:45 wiz Exp $
|
|
.\"
|
|
.Dd May 6, 2002
|
|
.Dt STRCPY 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm strcpy ,
|
|
.Nm strncpy
|
|
.Nd copy strings
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In string.h
|
|
.Ft char *
|
|
.Fn strcpy "char * restrict dst" "const char * restrict src"
|
|
.Ft char *
|
|
.Fn strncpy "char * restrict dst" "const char * restrict src" "size_t len"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn strcpy
|
|
and
|
|
.Fn strncpy
|
|
functions
|
|
copy the string
|
|
.Fa src
|
|
to
|
|
.Fa dst
|
|
(including the terminating
|
|
.Ql \e0
|
|
character).
|
|
.Pp
|
|
The
|
|
.Fn strncpy
|
|
function copies not more than
|
|
.Fa len
|
|
characters into
|
|
.Fa dst ,
|
|
appending
|
|
.Ql \e0
|
|
characters if
|
|
.Fa src
|
|
is less than
|
|
.Fa len
|
|
characters long, and
|
|
.Em not
|
|
terminating
|
|
.Fa dst
|
|
if
|
|
.Fa src
|
|
is
|
|
.Fa len
|
|
or more characters long.
|
|
.Sh RETURN VALUES
|
|
The
|
|
.Fn strcpy
|
|
and
|
|
.Fn strncpy
|
|
functions
|
|
return
|
|
.Fa dst .
|
|
.Sh EXAMPLES
|
|
The following sets
|
|
.Dq Li chararray
|
|
to
|
|
.Dq Li abc\e0\e0\e0 .
|
|
.Bd -literal -offset indent
|
|
(void)strncpy(chararray, "abc", 6);
|
|
.Ed
|
|
.Pp
|
|
The following sets
|
|
.Dq Li chararray
|
|
to
|
|
.Dq Li abcdef
|
|
and does
|
|
.Em not
|
|
nul-terminate
|
|
.Va chararray
|
|
because the source string is \*[Gt]= the length parameter.
|
|
.Fn strncpy
|
|
.Em only
|
|
nul-terminates the destination string when the length of the source
|
|
string is less than the length parameter.
|
|
.Bd -literal -offset indent
|
|
(void)strncpy(chararray, "abcdefgh", 6);
|
|
.Ed
|
|
.Pp
|
|
The following copies as many characters from
|
|
.Va input
|
|
to
|
|
.Va buf
|
|
as will fit and nul-terminates the result.
|
|
Because
|
|
.Fn strncpy
|
|
does
|
|
.Em not
|
|
guarantee to nul-terminate the string itself, we must do this by hand.
|
|
.Bd -literal -offset indent
|
|
char buf[BUFSIZ];
|
|
|
|
(void)strncpy(buf, input, sizeof(buf) - 1);
|
|
buf[sizeof(buf) - 1] = '\e0';
|
|
.Ed
|
|
.Pp
|
|
Note that
|
|
.Xr strlcpy 3
|
|
is a better choice for this kind of operation.
|
|
The equivalent using
|
|
.Xr strlcpy 3
|
|
is simply:
|
|
.Bd -literal -offset indent
|
|
(void)strlcpy(buf, input, sizeof(buf));
|
|
.Ed
|
|
.Sh SEE ALSO
|
|
.Xr bcopy 3 ,
|
|
.Xr memccpy 3 ,
|
|
.Xr memcpy 3 ,
|
|
.Xr memmove 3 ,
|
|
.Xr strlcpy 3
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn strcpy
|
|
and
|
|
.Fn strncpy
|
|
functions
|
|
conform to
|
|
.St -isoC-99 .
|