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  2009-12-04 "" "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 first \fIn\fP bytes of the memory
  56 area pointed to by \fIs\fP for the character \fIc\fP.
  57 The first byte to
  58 match \fIc\fP (interpreted as an unsigned character) stops the operation.
  59 .PP
  60 The
  61 .BR memrchr ()
  62 function is like the
  63 .BR memchr ()
  64 function,
  65 except that it searches backward from the end of the \fIn\fP bytes
  66 pointed to by \fIs\fP instead of forward from the beginning.
  67
  68 The
  69 .BR rawmemchr ()
  70 function is similar to
  71 .BR memchr ():
  72 it assumes (i.e., the programmer knows for certain)
  73 that the character
  74 .I c
  75 lies somewhere in the string
  76 .IR s ,
  77 and so performs an optimized search
  78 for the character
  79 .IR c
  80 (i.e., no checking for the terminating null byte, or use of an argument,
  81 .IR n ,
  82 to limit the range of the search).
  83 If the character
  84 .I c
  85 is not in the string
  86 .IR s ,
  87 then
  88 .BR rawmemchr ()
  89 may proceed to search beyond the end of the string,
  90 and the result is unspecified.
  91 The following call is a fast means of locating a string's
  92 terminating null byte:
  93 .in +4n
  94 .nf
  95
  96 char *p = rawmemchr(s,\ \(aq\\0\(aq);
  97 .fi
  98 .in
  99 .SH "RETURN VALUE"
 100 The
 101 .BR memchr ()
 102 and
 103 .BR memrchr ()
 104 functions return a pointer
 105 to the matching byte or NULL if the character does not occur in
 106 the given memory area.
 107
 108 The
 109 .BR rawmemchr ()
 110 function returns a pointer to the matching byte, if one is found.
 111 If no matching byte is found, the result is unspecified.
 112 .SH VERSIONS
 113 .BR rawmemchr ()
 114 first appeared in glibc in version 2.1.
 115
 116 .BR memrchr ()
 117 first appeared in glibc in version 2.2.
 118 .SH "CONFORMING TO"
 119 The
 120 .BR memchr ()
 121 function conforms to SVr4, 4.3BSD, C89, C99, POSIX.1-2001.
 122
 123 The
 124 .BR memrchr ()
 125 function is a GNU extension, available since glibc 2.1.91.
 126
 127 The
 128 .BR rawmemchr ()
 129 function is a GNU extension, available since glibc 2.1.
 130 .SH "SEE ALSO"
 131 .BR ffs (3),
 132 .BR index (3),
 133 .BR rindex (3),
 134 .BR strchr (3),
 135 .BR strpbrk (3),
 136 .BR strrchr (3),
 137 .BR strsep (3),
 138 .BR strspn (3),
 139 .BR strstr (3),
 140 .BR wmemchr (3)