git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

Commit	Line	Data
	1	.\" Copyright (c) 1990, 1991, 1993
	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" Chris Torek and the American National Standards Committee X3,
	6	.\" on Information Processing Systems.
	7	.\"
	8	.\" Redistribution and use in source and binary forms, with or without
	9	.\" modification, are permitted provided that the following conditions
	10	.\" are met:
	11	.\" 1. Redistributions of source code must retain the above copyright
	12	.\" notice, this list of conditions and the following disclaimer.
	13	.\" 2. Redistributions in binary form must reproduce the above copyright
	14	.\" notice, this list of conditions and the following disclaimer in the
	15	.\" documentation and/or other materials provided with the distribution.
	16	.\" 4. Neither the name of the University nor the names of its contributors
	17	.\" may be used to endorse or promote products derived from this software
	18	.\" without specific prior written permission.
	19	.\"
	20	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	.\" SUCH DAMAGE.
	31	.\"
	32	.\" @(#)memchr.3 8.1 (Berkeley) 6/4/93
	33	.\" $FreeBSD: src/lib/libc/string/memchr.3,v 1.12 2009/04/23 08:37:56 brueffer Exp $
	34	.\"
	35	.Dd April 9, 2008
	36	.Dt MEMCHR 3
	37	.Os
	38	.Sh NAME
	39	.Nm memchr
	40	.Nd locate byte in byte string
	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
	44	.In string.h
	45	.Ft void *
	46	.Fn memchr "const void *b" "int c" "size_t len"
	47	.Ft void *
	48	.Fn memrchr "const void *b" "int c" "size_t len"
	49	.Sh DESCRIPTION
	50	The
	51	.Fn memchr
	52	function
	53	locates the first occurrence of
	54	.Fa c
	55	(converted to an unsigned char)
	56	in string
	57	.Fa b .
	58	.Pp
	59	The
	60	.Fn memrchr
	61	function behaves like
	62	.Fn memchr ,
	63	except that it locates the last occurrence of
	64	.Fa c
	65	in string
	66	.Fa b .
	67	.Sh RETURN VALUES
	68	The
	69	.Fn memchr
	70	and
	71	.Fn memrchr
	72	functions
	73	return a pointer to the byte located,
	74	or NULL if no such byte exists within
	75	.Fa len
	76	bytes.
	77	.Sh SEE ALSO
	78	.Xr memmem 3 ,
	79	.Xr strchr 3 ,
	80	.Xr strcspn 3 ,
	81	.Xr strpbrk 3 ,
	82	.Xr strrchr 3 ,
	83	.Xr strsep 3 ,
	84	.Xr strspn 3 ,
	85	.Xr strstr 3 ,
	86	.Xr strtok 3 ,
	87	.Xr wmemchr 3
	88	.Sh STANDARDS
	89	The
	90	.Fn memchr
	91	function
	92	conforms to
	93	.St -isoC .
	94	.Pp
	95	The
	96	.Fn memrchr
	97	function is a GNU extension and conforms to no standard.
	98	.Sh HISTORY
	99	The
	100	.Fn memrchr
	101	function first appeared in GNU libc 2.1.91, this implementation
	102	first appeared in
	103	.Fx 6.4 ,
	104	coming from
	105	.Ox 4.3 .