summaryrefslogtreecommitdiff
path: root/man3/strstr.3
blob: 37ac7f33ffa4568b4a787e85eb9df554c5b18eb8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\" 
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" References consulted:
.\"     Linux libc source code
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
.\"     386BSD man pages
.\" Modified Sat Jul 24 17:56:43 1993 by Rik Faith (faith@cs.unc.edu)
.\" Added history, aeb, 980113.
.\" 2005-05-05 mtk: added strcasestr()
.\"
.TH STRSTR 3  2005-04-05 "GNU" "Linux Programmer's Manual"
.SH NAME
strstr \- locate a substring
.SH SYNOPSIS
.nf
.B #include <string.h>
.sp
.BI "char *strstr(const char *" haystack ", const char *" needle );
.sp
.B #define _GNU_SOURCE
.sp
.B #include <string.h>
.sp
.BI "char *strcasestr(const char *" haystack ", const char *" needle );
.fi
.SH DESCRIPTION
The \fBstrstr\fP() function finds the first occurrence of the substring
\fIneedle\fP in the string \fIhaystack\fP.  The terminating \`\\0'
characters are not compared.

The \fBstrcasestr\fP() function is like \fBstrstr\fP(),
but ignores the case of both arguments.
.SH "RETURN VALUE"
These functions return a pointer to the beginning of the
substring, or NULL if the substring is not found.
.SH BUGS
Early versions of Linux libc (like 4.5.26) would not allow
an empty \fIneedle\fP argument for \fBstrstr\fP().
Later versions (like 4.6.27) work correctly,
and return \fIhaystack\fP when \fIneedle\fP is empty.
.SH "CONFORMING TO"
The \fBstrstr\fP() function conforms to ISO 9899.
The \fBstrcasestr\fP() function is a non-standard extension.
.SH "SEE ALSO"
.BR index (3),
.BR memchr (3),
.BR rindex (3),
.BR strchr (3),
.BR strcasecmp (3),
.BR strpbrk (3),
.BR strsep (3),
.BR strspn (3),
.BR strtok (3),
.BR wcsstr (3)