xref: /freebsd/lib/libc/string/memchr.3 (revision 6050c8fe05cff5f6b5d0191db51223f86b7c04f0)
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.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)memchr.3	8.1 (Berkeley) 6/4/93
37.\" $FreeBSD$
38.\"
39.Dd June 4, 1993
40.Dt MEMCHR 3
41.Os
42.Sh NAME
43.Nm memchr
44.Nd locate byte in byte string
45.Sh LIBRARY
46.Lb libc
47.Sh SYNOPSIS
48.In string.h
49.Ft void *
50.Fn memchr "const void *b" "int c" "size_t len"
51.Sh DESCRIPTION
52The
53.Fn memchr
54function
55locates the first occurrence of
56.Fa c
57(converted to an unsigned char)
58in string
59.Fa b .
60.Sh RETURN VALUES
61The
62.Fn memchr
63function
64returns a pointer to the byte located,
65or NULL if no such byte exists within
66.Fa len
67bytes.
68.Sh SEE ALSO
69.Xr memmem 3 ,
70.Xr strchr 3 ,
71.Xr strcspn 3 ,
72.Xr strpbrk 3 ,
73.Xr strrchr 3 ,
74.Xr strsep 3 ,
75.Xr strspn 3 ,
76.Xr strstr 3 ,
77.Xr strtok 3
78.Sh STANDARDS
79The
80.Fn memchr
81function
82conforms to
83.St -isoC .
84