Blame man3/memchr.3

Packit 7cfc04
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
Packit 7cfc04
.\" and Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
Packit 7cfc04
.\"     <mtk.manpages@gmail.com>
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.\" Modified Mon Apr 12 12:49:57 1993, David Metcalfe
Packit 7cfc04
.\" Modified Sat Jul 24 18:56:22 1993, Rik Faith (faith@cs.unc.edu)
Packit 7cfc04
.\" Modified Wed Feb 20 21:09:36 2002, Ian Redfern (redferni@logica.com)
Packit 7cfc04
.\" 2008-07-09, mtk, add rawmemchr()
Packit 7cfc04
.\"
Packit 7cfc04
.TH MEMCHR 3  2017-09-15 "" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
memchr, memrchr, rawmemchr \- scan memory for a character
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <string.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "void *memchr(const void *" s ", int " c ", size_t " n );
Packit 7cfc04
.PP
Packit 7cfc04
.BI "void *memrchr(const void *" s ", int " c ", size_t " n );
Packit 7cfc04
.PP
Packit 7cfc04
.BI "void *rawmemchr(const void *" s ", int " c );
Packit 7cfc04
.fi
Packit 7cfc04
.PP
Packit 7cfc04
.in -4n
Packit 7cfc04
Feature Test Macro Requirements for glibc (see
Packit 7cfc04
.BR feature_test_macros (7)):
Packit 7cfc04
.in
Packit 7cfc04
.PP
Packit 7cfc04
.BR memrchr (),
Packit 7cfc04
.BR rawmemchr ():
Packit 7cfc04
_GNU_SOURCE
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
.BR memchr ()
Packit 7cfc04
function scans the initial
Packit 7cfc04
.I n
Packit 7cfc04
bytes of the memory
Packit 7cfc04
area pointed to by
Packit 7cfc04
.I s
Packit 7cfc04
for the first instance of
Packit 7cfc04
.IR c .
Packit 7cfc04
Both
Packit 7cfc04
.I c
Packit 7cfc04
and the bytes of the memory area pointed to by
Packit 7cfc04
.I s
Packit 7cfc04
are interpreted as
Packit 7cfc04
.IR "unsigned char" .
Packit 7cfc04
.PP
Packit 7cfc04
The
Packit 7cfc04
.BR memrchr ()
Packit 7cfc04
function is like the
Packit 7cfc04
.BR memchr ()
Packit 7cfc04
function,
Packit 7cfc04
except that it searches backward from the end of the
Packit 7cfc04
.I n
Packit 7cfc04
bytes pointed to by
Packit 7cfc04
.I s
Packit 7cfc04
instead of forward from the beginning.
Packit 7cfc04
.PP
Packit 7cfc04
The
Packit 7cfc04
.BR rawmemchr ()
Packit 7cfc04
function is similar to
Packit 7cfc04
.BR memchr ():
Packit 7cfc04
it assumes (i.e., the programmer knows for certain)
Packit 7cfc04
that an instance of
Packit 7cfc04
.I c
Packit 7cfc04
lies somewhere in the memory area starting at the location pointed to by
Packit 7cfc04
.IR s ,
Packit 7cfc04
and so performs an optimized search for
Packit 7cfc04
.IR c
Packit 7cfc04
(i.e., no use of a count argument to limit the range of the search).
Packit 7cfc04
If an instance of
Packit 7cfc04
.I c
Packit 7cfc04
is not found, the results are unpredictable.
Packit 7cfc04
The following call is a fast means of locating a string's
Packit 7cfc04
terminating null byte:
Packit 7cfc04
.PP
Packit 7cfc04
.in +4n
Packit 7cfc04
.EX
Packit 7cfc04
char *p = rawmemchr(s,\ \(aq\\0\(aq);
Packit 7cfc04
.EE
Packit 7cfc04
.in
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
The
Packit 7cfc04
.BR memchr ()
Packit 7cfc04
and
Packit 7cfc04
.BR memrchr ()
Packit 7cfc04
functions return a pointer
Packit 7cfc04
to the matching byte or NULL if the character does not occur in
Packit 7cfc04
the given memory area.
Packit 7cfc04
.PP
Packit 7cfc04
The
Packit 7cfc04
.BR rawmemchr ()
Packit 7cfc04
function returns a pointer to the matching byte, if one is found.
Packit 7cfc04
If no matching byte is found, the result is unspecified.
Packit 7cfc04
.SH VERSIONS
Packit 7cfc04
.BR rawmemchr ()
Packit 7cfc04
first appeared in glibc in version 2.1.
Packit 7cfc04
.PP
Packit 7cfc04
.BR memrchr ()
Packit 7cfc04
first appeared in glibc in version 2.2.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lbw32 lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR memchr (),
Packit 7cfc04
.BR memrchr (),
Packit 7cfc04
.BR rawmemchr ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
.BR memchr ():
Packit 7cfc04
POSIX.1-2001, POSIX.1-2008, C89, C99, SVr4, 4.3BSD.
Packit 7cfc04
.PP
Packit 7cfc04
The
Packit 7cfc04
.BR memrchr ()
Packit 7cfc04
function is a GNU extension, available since glibc 2.1.91.
Packit 7cfc04
.PP
Packit 7cfc04
The
Packit 7cfc04
.BR rawmemchr ()
Packit 7cfc04
function is a GNU extension, available since glibc 2.1.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR bstring (3),
Packit 7cfc04
.BR ffs (3),
Packit 7cfc04
.BR index (3),
Packit 7cfc04
.BR memmem (3),
Packit 7cfc04
.BR rindex (3),
Packit 7cfc04
.BR strchr (3),
Packit 7cfc04
.BR strpbrk (3),
Packit 7cfc04
.BR strrchr (3),
Packit 7cfc04
.BR strsep (3),
Packit 7cfc04
.BR strspn (3),
Packit 7cfc04
.BR strstr (3),
Packit 7cfc04
.BR wmemchr (3)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.