[apple/libc.git] / string / FreeBSD / 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 *
.Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
.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 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.
.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
5b2abdfb	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	.\"
5b2abdfb	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	.\"
5b2abdfb A	31	.Dd June 9, 1993
5b2abdfb A	32	.Dt MEMCCPY 3
e9ce8d39 A	33	.Os
e9ce8d39 A	34	.Sh NAME
5b2abdfb A	35	.Nm memccpy
5b2abdfb A	36	.Nd copy string until character found
e9ce8d39 A	37	.Sh LIBRARY
	38	.Lb libc
	39	.Sh SYNOPSIS
5b2abdfb A	40	.In string.h
	41	.Ft void *
	42	.Fn memccpy "void dst" "const void src" "int c" "size_t len"
e9ce8d39 A	43	.Sh DESCRIPTION
e9ce8d39 A	44	The
5b2abdfb A	45	.Fn memccpy
	46	function
	47	copies bytes from string
	48	.Fa src
	49	to string
	50	.Fa dst .
	51	If the character
	52	.Fa c
	53	(as converted to an unsigned char) occurs in the string
	54	.Fa src ,
	55	the copy stops and a pointer to the byte after the copy of
	56	.Fa c
	57	in the string
	58	.Fa dst
	59	is returned.
	60	Otherwise,
e9ce8d39	61	.Fa len
5b2abdfb	62	bytes are copied, and a NULL pointer is returned.
e9ce8d39	63	.Sh SEE ALSO
5b2abdfb A	64	.Xr bcopy 3 ,
	65	.Xr memcpy 3 ,
	66	.Xr memmove 3 ,
	67	.Xr strcpy 3
e9ce8d39 A	68	.Sh HISTORY
e9ce8d39 A	69	The
5b2abdfb	70	.Fn memccpy
e9ce8d39 A	71	function first appeared in
e9ce8d39 A	72	.Bx 4.4 .