xref: /netbsd/lib/libc/string/memchr.3 (revision 6550d01e)
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. 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.\"     from: @(#)memchr.3	8.1 (Berkeley) 6/4/93
33.\"	$NetBSD: memchr.3,v 1.11 2009/04/10 23:24:35 wiz Exp $
34.\"
35.Dd April 10, 2009
36.Dt MEMCHR 3
37.Os
38.Sh NAME
39.Nm memchr ,
40.Nm memrchr
41.Nd locate byte in byte string
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In string.h
46.Ft void *
47.Fn memchr "const void *b" "int c" "size_t len"
48.Ft void *
49.Fn memrchr "const void *b" "int c" "size_t len"
50.Sh DESCRIPTION
51The
52.Fn memchr
53function
54locates the first occurrence of
55.Fa c
56(converted to an unsigned char)
57in string
58.Fa b .
59The
60.Fn memrchr
61function
62locates the last occurrence of
63.Fa c
64(converted to an unsigned char)
65in string
66.Fa b .
67.Sh RETURN VALUES
68The
69.Fn memchr
70and
71.Fn memrchr
72functions
73return a pointer to the byte located, or
74.Dv NULL
75if no such byte exists within
76.Fa len
77bytes.
78.Sh SEE ALSO
79.Xr index 3 ,
80.Xr rindex 3 ,
81.Xr strchr 3 ,
82.Xr strcspn 3 ,
83.Xr strpbrk 3 ,
84.Xr strrchr 3 ,
85.Xr strsep 3 ,
86.Xr strspn 3 ,
87.Xr strstr 3 ,
88.Xr strtok 3
89.Sh STANDARDS
90The
91.Fn memchr
92function
93conforms to
94.St -ansiC .
95