man-pages/man3/memchr.3.html
2021-03-31 01:06:50 +01:00

240 lines
5.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of MEMCHR</TITLE>
</HEAD><BODY>
<H1>MEMCHR</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2019-03-06<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
memchr, memrchr, rawmemchr - scan memory for a character
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/string.h">string.h</A>&gt;</B>
<B>void *memchr(const void *</B><I>s</I><B>, int </B><I>c</I><B>, size_t </B><I>n</I><B>);</B>
<B>void *memrchr(const void *</B><I>s</I><B>, int </B><I>c</I><B>, size_t </B><I>n</I><B>);</B>
<B>void *rawmemchr(const void *</B><I>s</I><B>, int </B><I>c</I><B>);</B>
</PRE>
<P>
Feature Test Macro Requirements for glibc (see
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
<P>
<B>memrchr</B>(),
<B>rawmemchr</B>():
_GNU_SOURCE
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The
<B>memchr</B>()
function scans the initial
<I>n</I>
bytes of the memory
area pointed to by
<I>s</I>
for the first instance of
<I>c</I>.
Both
<I>c</I>
and the bytes of the memory area pointed to by
<I>s</I>
are interpreted as
<I>unsigned char</I>.
<P>
The
<B>memrchr</B>()
function is like the
<B>memchr</B>()
function,
except that it searches backward from the end of the
<I>n</I>
bytes pointed to by
<I>s</I>
instead of forward from the beginning.
<P>
The
<B>rawmemchr</B>()
function is similar to
<B>memchr</B>():
it assumes (i.e., the programmer knows for certain)
that an instance of
<I>c</I>
lies somewhere in the memory area starting at the location pointed to by
<I>s</I>,
and so performs an optimized search for
<I>c</I>
(i.e., no use of a count argument to limit the range of the search).
If an instance of
<I>c</I>
is not found, the results are unpredictable.
The following call is a fast means of locating a string's
terminating null byte:
<P>
char *p = rawmemchr(s,&nbsp;'\0');
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
The
<B>memchr</B>()
and
<B>memrchr</B>()
functions return a pointer
to the matching byte or NULL if the character does not occur in
the given memory area.
<P>
The
<B>rawmemchr</B>()
function returns a pointer to the matching byte, if one is found.
If no matching byte is found, the result is unspecified.
<A NAME="lbAF">&nbsp;</A>
<H2>VERSIONS</H2>
<B>rawmemchr</B>()
first appeared in glibc in version 2.1.
<P>
<B>memrchr</B>()
first appeared in glibc in version 2.2.
<A NAME="lbAG">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>memchr</B>(),
<B>memrchr</B>(),
<B>rawmemchr</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAH">&nbsp;</A>
<H2>CONFORMING TO</H2>
<B>memchr</B>():
POSIX.1-2001, POSIX.1-2008, C89, C99, SVr4, 4.3BSD.
<P>
The
<B>memrchr</B>()
function is a GNU extension, available since glibc 2.1.91.
<P>
The
<B>rawmemchr</B>()
function is a GNU extension, available since glibc 2.1.
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+bstring">bstring</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+ffs">ffs</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+index">index</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+memmem">memmem</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+rindex">rindex</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+strchr">strchr</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+strpbrk">strpbrk</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+strrchr">strrchr</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+strsep">strsep</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+strspn">strspn</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+strstr">strstr</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+wmemchr">wmemchr</A></B>(3)
<A NAME="lbAJ">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="4"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="5"><A HREF="#lbAF">VERSIONS</A><DD>
<DT id="6"><A HREF="#lbAG">ATTRIBUTES</A><DD>
<DT id="7"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="8"><A HREF="#lbAI">SEE ALSO</A><DD>
<DT id="9"><A HREF="#lbAJ">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:48 GMT, March 31, 2021
</BODY>
</HTML>