original/man3/strstr.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 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 17:56:43 1993 by Rik Faith (faith@cs.unc.edu)
  30 .\" Added history, aeb, 980113.
  31 .\" 2005-05-05 mtk: added strcasestr()
  32 .\"
  33 .TH STRSTR 3  2014-01-22 "GNU" "Linux Programmer's Manual"
  34 .SH NAME
  35 strstr, strcasestr \- locate a substring
  36 .SH SYNOPSIS
  37 .nf
  38 .B #include <string.h>
  39 .sp
  40 .BI "char *strstr(const char *" haystack ", const char *" needle );
  41 .sp
  42 .BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
  43 .sp
  44 .B #include <string.h>
  45 .sp
  46 .BI "char *strcasestr(const char *" haystack ", const char *" needle );
  47 .fi
  48 .SH DESCRIPTION
  49 The
  50 .BR strstr ()
  51 function finds the first occurrence of the substring
  52 .I needle
  53 in the string
  54 .IR haystack .
  55 The terminating null bytes (\(aq\\0\(aq) are not compared.
  56
  57 The
  58 .BR strcasestr ()
  59 function is like
  60 .BR strstr (),
  61 but ignores the case of both arguments.
  62 .SH RETURN VALUE
  63 These functions return a pointer to the beginning of the
  64 located substring, or NULL if the substring is not found.
  65 .SH ATTRIBUTES
  66 .SS Multithreading (see pthreads(7))
  67 The
  68 .BR strstr ()
  69 function is thread-safe.
  70 .LP
  71 The
  72 .BR strcasestr ()
  73 function is thread-safe with exceptions.
  74 It can be safely used in multithreaded applications, as long as
  75 .BR setlocale (3)
  76 is not called to change the locale during its execution.
  77 .SH CONFORMING TO
  78 The
  79 .BR strstr ()
  80 function conforms to C89 and C99.
  81 The
  82 .BR strcasestr ()
  83 function is a nonstandard extension.
  84 .SH BUGS
  85 Early versions of Linux libc (like 4.5.26) would not allow
  86 an empty
  87 .I needle
  88 argument for
  89 .BR strstr ().
  90 Later versions (like 4.6.27) work correctly,
  91 and return
  92 .IR haystack
  93 when
  94 .I needle
  95 is empty.
  96 .SH SEE ALSO
  97 .BR index (3),
  98 .BR memchr (3),
  99 .BR rindex (3),
 100 .BR strcasecmp (3),
 101 .BR strchr (3),
 102 .BR string (3),
 103 .BR strpbrk (3),
 104 .BR strsep (3),
 105 .BR strspn (3),
 106 .BR strtok (3),
 107 .BR wcsstr (3)
 108 .SH COLOPHON
 109 This page is part of release 3.68 of the Linux
 110 .I man-pages
 111 project.
 112 A description of the project,
 113 information about reporting bugs,
 114 and the latest version of this page,
 115 can be found at
 116 \%http://www.kernel.org/doc/man\-pages/.