[apple/libc.git] / string / memccpy.3

.\" 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.
.\" 4. 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.
.\"
.\"     @(#)memccpy.3	8.1 (Berkeley) 6/9/93
.\" $FreeBSD: src/lib/libc/string/memccpy.3,v 1.7 2007/01/09 00:28:12 imp Exp $
.\"
.Dd June 9, 1993
.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 s1"
.Fa "const void *restrict s2"
.Fa "int c"
.Fa "size_t n"
.Fc
.Sh DESCRIPTION
The
.Fn memccpy
function
copies bytes from string
.Fa s2
to string
.Fa s1 .
If the character
.Fa c
(as converted to an unsigned char) occurs in the string
.Fa s2 ,
the copy stops and a pointer to the byte after the copy of
.Fa c
in the string
.Fa s1
is returned.
Otherwise,
.Fa n
bytes are copied, and a NULL pointer is returned.
.Pp
The source and destination strings should not overlap, as the
behavior is undefined.
.Sh SEE ALSO
.Xr bcopy 3 ,
.Xr memcpy 3 ,
.Xr memmove 3 ,
.Xr strcpy 3
.Sh HISTORY
The
.Fn memccpy
function first appeared in
.Bx 4.4 .
Commit	Line	Data
224c7076	1	.\" Copyright (c) 1990, 1991, 1993
e9ce8d39 A	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
e9ce8d39 A	12	.\" 4. Neither the name of the University nor the names of its contributors
	13	.\" may be used to endorse or promote products derived from this software
	14	.\" without specific prior written permission.
	15	.\"
	16	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	17	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	18	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	19	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	20	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	21	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	22	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	23	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	24	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	25	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	26	.\" SUCH DAMAGE.
	27	.\"
224c7076	28	.\" @(#)memccpy.3 8.1 (Berkeley) 6/9/93
1f2f436a	29	.\" $FreeBSD: src/lib/libc/string/memccpy.3,v 1.7 2007/01/09 00:28:12 imp Exp $
e9ce8d39	30	.\"
224c7076 A	31	.Dd June 9, 1993
224c7076 A	32	.Dt MEMCCPY 3
e9ce8d39 A	33	.Os
e9ce8d39 A	34	.Sh NAME
224c7076 A	35	.Nm memccpy
224c7076 A	36	.Nd copy string until character found
e9ce8d39 A	37	.Sh LIBRARY
	38	.Lb libc
	39	.Sh SYNOPSIS
224c7076	40	.In string.h
5b2abdfb	41	.Ft void *
224c7076 A	42	.Fo memccpy
	43	.Fa "void *restrict s1"
	44	.Fa "const void *restrict s2"
	45	.Fa "int c"
	46	.Fa "size_t n"
	47	.Fc
e9ce8d39 A	48	.Sh DESCRIPTION
e9ce8d39 A	49	The
224c7076	50	.Fn memccpy
5b2abdfb	51	function
224c7076 A	52	copies bytes from string
	53	.Fa s2
	54	to string
	55	.Fa s1 .
	56	If the character
	57	.Fa c
	58	(as converted to an unsigned char) occurs in the string
	59	.Fa s2 ,
	60	the copy stops and a pointer to the byte after the copy of
	61	.Fa c
	62	in the string
	63	.Fa s1
	64	is returned.
	65	Otherwise,
	66	.Fa n
	67	bytes are copied, and a NULL pointer is returned.
34e8f829 A	68	.Pp
	69	The source and destination strings should not overlap, as the
	70	behavior is undefined.
224c7076 A	71	.Sh SEE ALSO
	72	.Xr bcopy 3 ,
	73	.Xr memcpy 3 ,
	74	.Xr memmove 3 ,
	75	.Xr strcpy 3
e9ce8d39 A	76	.Sh HISTORY
e9ce8d39 A	77	The
224c7076 A	78	.Fn memccpy
	79	function first appeared in
	80	.Bx 4.4 .