original/man3/memchr.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\" and Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" Modified Mon Apr 12 12:49:57 1993, David Metcalfe
  26 .\" Modified Sat Jul 24 18:56:22 1993, Rik Faith (faith@cs.unc.edu)
  27 .\" Modified Wed Feb 20 21:09:36 2002, Ian Redfern (redferni@logica.com)
  28 .\" 2008-07-09, mtk, add rawmemchr()
  29 .\"
  30 .TH MEMCHR 3  2012-04-23 "" "Linux Programmer's Manual"
  31 .SH NAME
  32 memchr, memrchr, rawmemchr \- scan memory for a character
  33 .SH SYNOPSIS
  34 .nf
  35 .B #include <string.h>
  36
  37 .BI "void *memchr(const void *" s ", int " c ", size_t " n );
  38
  39 .BI "void *memrchr(const void *" s ", int " c ", size_t " n );
  40
  41 .BI "void *rawmemchr(const void *" s ", int " c );
  42 .fi
  43 .sp
  44 .in -4n
  45 Feature Test Macro Requirements for glibc (see
  46 .BR feature_test_macros (7)):
  47 .in
  48 .sp
  49 .BR memrchr (),
  50 .BR rawmemchr ():
  51 _GNU_SOURCE
  52 .SH DESCRIPTION
  53 The
  54 .BR memchr ()
  55 function scans the initial
  56 .I n
  57 bytes of the memory
  58 area pointed to by
  59 .I s
  60 for the first instance of
  61 .IR c .
  62 Both
  63 .I c
  64 and the bytes of the memory area pointed to by
  65 .I s
  66 are interpreted as
  67 .IR "unsigned char" .
  68 .PP
  69 The
  70 .BR memrchr ()
  71 function is like the
  72 .BR memchr ()
  73 function,
  74 except that it searches backward from the end of the
  75 .I n
  76 bytes pointed to by
  77 .I s
  78 instead of forward from the beginning.
  79
  80 The
  81 .BR rawmemchr ()
  82 function is similar to
  83 .BR memchr ():
  84 it assumes (i.e., the programmer knows for certain)
  85 that an instance of
  86 .I c
  87 lies somewhere in the memory area starting at the location pointed to by
  88 .IR s ,
  89 and so performs an optimized search for
  90 .IR c
  91 (i.e., no use of a count argument argument to limit the range of the search).
  92 If an instance of
  93 .I c
  94 is not found, the results are unpredictable.
  95 The following call is a fast means of locating a string's
  96 terminating null byte:
  97 .in +4n
  98 .nf
  99
 100 char *p = rawmemchr(s,\ \(aq\\0\(aq);
 101 .fi
 102 .in
 103 .SH "RETURN VALUE"
 104 The
 105 .BR memchr ()
 106 and
 107 .BR memrchr ()
 108 functions return a pointer
 109 to the matching byte or NULL if the character does not occur in
 110 the given memory area.
 111
 112 The
 113 .BR rawmemchr ()
 114 function returns a pointer to the matching byte, if one is found.
 115 If no matching byte is found, the result is unspecified.
 116 .SH VERSIONS
 117 .BR rawmemchr ()
 118 first appeared in glibc in version 2.1.
 119
 120 .BR memrchr ()
 121 first appeared in glibc in version 2.2.
 122 .SH "CONFORMING TO"
 123 The
 124 .BR memchr ()
 125 function conforms to SVr4, 4.3BSD, C89, C99, POSIX.1-2001.
 126
 127 The
 128 .BR memrchr ()
 129 function is a GNU extension, available since glibc 2.1.91.
 130
 131 The
 132 .BR rawmemchr ()
 133 function is a GNU extension, available since glibc 2.1.
 134 .SH "SEE ALSO"
 135 .BR ffs (3),
 136 .BR index (3),
 137 .BR rindex (3),
 138 .BR strchr (3),
 139 .BR strpbrk (3),
 140 .BR strrchr (3),
 141 .BR strsep (3),
 142 .BR strspn (3),
 143 .BR strstr (3),
 144 .BR wmemchr (3)