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  2021-03-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 .PP
  40 .BI "char *strstr(const char *" haystack ", const char *" needle );
  41 .PP
  42 .BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
  43 .B #include <string.h>
  44 .PP
  45 .BI "char *strcasestr(const char *" haystack ", const char *" needle );
  46 .fi
  47 .SH DESCRIPTION
  48 The
  49 .BR strstr ()
  50 function finds the first occurrence of the substring
  51 .I needle
  52 in the string
  53 .IR haystack .
  54 The terminating null bytes (\(aq\e0\(aq) are not compared.
  55 .PP
  56 The
  57 .BR strcasestr ()
  58 function is like
  59 .BR strstr (),
  60 but ignores the case of both arguments.
  61 .SH RETURN VALUE
  62 These functions return a pointer to the beginning of the
  63 located substring, or NULL if the substring is not found.
  64 .PP
  65 If
  66 .I needle
  67 is the empty string,
  68 the return value is always
  69 .I haystack
  70 itself.
  71 .SH ATTRIBUTES
  72 For an explanation of the terms used in this section, see
  73 .BR attributes (7).
  74 .ad l
  75 .nh
  76 .TS
  77 allbox;
  78 lbx lb lb
  79 l l l.
  80 Interface       Attribute       Value
  81 T{
  82 .BR strstr ()
  83 T}      Thread safety   MT-Safe
  84 T{
  85 .BR strcasestr ()
  86 T}      Thread safety   MT-Safe locale
  87 .TE
  88 .hy
  89 .ad
  90 .sp 1
  91 .SH CONFORMING TO
  92 .BR strstr ():
  93 POSIX.1-2001, POSIX.1-2008, C89, C99.
  94 .PP
  95 The
  96 .BR strcasestr ()
  97 function is a nonstandard extension.
  98 .SH SEE ALSO
  99 .BR index (3),
 100 .BR memchr (3),
 101 .BR memmem (3),
 102 .BR rindex (3),
 103 .BR strcasecmp (3),
 104 .BR strchr (3),
 105 .BR string (3),
 106 .BR strpbrk (3),
 107 .BR strsep (3),
 108 .BR strspn (3),
 109 .BR strtok (3),
 110 .BR wcsstr (3)