mirror of
https://github.com/freebsd/freebsd-src
synced 2024-07-23 03:06:48 +00:00
e0d4f419ac
POSIX.1-2004 and the upcoming C23 agree that memccpy()'s arguments
are restrict qualified and must not overlap. In 2002, restrict
qualifiers were added to <string.h>'s declaration of the function.
Make things official and document that the arguments must not
overlap.
See also: 61b60edfd3
Approved by: kib
MFC after: 1 month
MFC to: stable/14
99 lines
2.7 KiB
Groff
99 lines
2.7 KiB
Groff
.\" Copyright (c) 1990, 1991, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" 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 December 5, 2023
|
|
.Dt MEMCCPY 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm memccpy
|
|
.Nd copy string until character found
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In string.h
|
|
.Ft void *
|
|
.Fo memccpy
|
|
.Fa "void * restrict dst"
|
|
.Fa "const void * restrict src"
|
|
.Fa "int c"
|
|
.Fa "size_t len"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn memccpy
|
|
function
|
|
copies bytes from string
|
|
.Fa src
|
|
to string
|
|
.Fa dst .
|
|
If the character
|
|
.Fa c
|
|
(as converted to an
|
|
.Vt "unsigned char" )
|
|
occurs in the string
|
|
.Fa src ,
|
|
the copy stops and a pointer to the byte after the copy of
|
|
.Fa c
|
|
in the string
|
|
.Fa dst
|
|
is returned.
|
|
Otherwise,
|
|
.Fa len
|
|
bytes are copied, and a NULL pointer is returned.
|
|
If
|
|
.Fa src
|
|
and
|
|
.Fa dst
|
|
overlap, behavior is undefined.
|
|
.Sh SEE ALSO
|
|
.Xr bcopy 3 ,
|
|
.Xr memcpy 3 ,
|
|
.Xr memmove 3 ,
|
|
.Xr strcpy 3
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn memccpy
|
|
function conforms to
|
|
.St -p1003.1-2004
|
|
and
|
|
.\" St -isoC-2024 .
|
|
ISO/IEC 9899:2024 (\(lqISO\~C23\(rq).
|
|
.Sh HISTORY
|
|
The
|
|
.Fn memccpy
|
|
function first appeared in
|
|
.Bx 4.4
|
|
and was first specified in the
|
|
.\" St -svid1 .
|
|
System\~V Interface Definition, First Edition (\(lqSVID1\(rq).
|
|
The
|
|
.Ft restrict
|
|
keyword was added to the prototype in
|
|
.Fx 5.0.0
|
|
in accordance with the updated specification of
|
|
.St -p1003.1-2004 .
|