summaryrefslogtreecommitdiff
path: root/lib/libc/string/strchr.3
blob: d3194dffab6e125011c99e184218d8f12dbd9bed (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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
.\"	$OpenBSD: strchr.3,v 1.10 2011/07/25 00:38:53 schwarze Exp $
.\"
.\" Copyright (c) 1990, 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd $Mdocdate: July 25 2011 $
.Dt STRCHR 3
.Os
.Sh NAME
.Nm strchr ,
.Nm index
.Nd locate first occurrence of a character in a string
.Sh SYNOPSIS
.Fd #include <string.h>
.Ft char *
.Fn strchr "const char *s" "int c"
.Ft char *
.Fn index "const char *s" "int c"
.Sh DESCRIPTION
The
.Fn strchr
function locates the first occurrence of the character
.Fa c
in the string
.Fa s .
The terminating NUL character is considered part of the string.
If
.Fa c
is
.Ql \e0 ,
.Fn strchr
locates the terminating
.Ql \e0 .
.Pp
The
.Fn index
function is an old synonym for
.Fn strchr .
.Sh RETURN VALUES
The
.Fn strchr
function returns a pointer to the located character or
.Dv NULL
if the character does not appear in the string.
.Sh EXAMPLES
After the following call to
.Fn strchr ,
.Va p
will point to the string
.Qq oobar :
.Bd -literal -offset indent
char *p;
char *s = "foobar";

p = strchr(s, 'o');
.Ed
.Sh SEE ALSO
.Xr memchr 3 ,
.Xr strcspn 3 ,
.Xr strpbrk 3 ,
.Xr strrchr 3 ,
.Xr strsep 3 ,
.Xr strspn 3 ,
.Xr strstr 3 ,
.Xr strtok 3 ,
.Xr wcschr 3
.Sh STANDARDS
The
.Fn strchr
function conforms to
.St -ansiC .
.Pp
The
.Fn index
function is deprecated and shouldn't be used in new code.
.Sh HISTORY
The
.Fn index
function first appeared in
.At v7 .
The
.Fn strchr
function first appeared in
.At III
and was reimplemented for
.Bx 4.3 Tahoe .