original/man3/memmem.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     386BSD man pages
  28 .\" Modified Sat Jul 24 18:50:48 1993 by Rik Faith (faith@cs.unc.edu)
  29 .\" Interchanged 'needle' and 'haystack'; added history, aeb, 980113.
  30 .TH MEMMEM 3  2008-12-05 "GNU" "Linux Programmer's Manual"
  31 .SH NAME
  32 memmem \- locate a substring
  33 .SH SYNOPSIS
  34 .nf
  35 .BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
  36 .B #include <string.h>
  37 .sp
  38 .BI "void *memmem(const void *" haystack ", size_t " haystacklen ,
  39 .BI "             const void *" needle ", size_t " needlelen  );
  40 .fi
  41 .SH DESCRIPTION
  42 The
  43 .BR memmem ()
  44 function finds the start of the first occurrence
  45 of the substring \fIneedle\fP of length \fIneedlelen\fP in the memory
  46 area \fIhaystack\fP of length \fIhaystacklen\fP.
  47 .SH RETURN VALUE
  48 The
  49 .BR memmem ()
  50 function returns a pointer to the beginning of the
  51 substring, or NULL if the substring is not found.
  52 .SH CONFORMING TO
  53 This function is a GNU extension.
  54 .SH BUGS
  55 This function was broken in Linux libraries up to and including libc 5.0.9;
  56 there the \fIneedle\fP and \fIhaystack\fP arguments were interchanged,
  57 and a pointer to the end of the first occurrence of \fIneedle\fP
  58 was returned.
  59
  60 Both old and new libc's have the bug that if \fIneedle\fP is empty,
  61 \fIhaystack\-1\fP (instead of \fIhaystack\fP) is returned.
  62 And glibc 2.0 makes it worse, returning a pointer to the
  63 last byte of \fIhaystack\fP.
  64 This is fixed in glibc 2.1.
  65 .SH SEE ALSO
  66 .BR strstr (3)