xref: /minix3/lib/libc/string/strchr.3 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek and the American National Standards Committee X3,
6.\" on Information Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)strchr.3	8.2 (Berkeley) 4/19/94
33.\"	$NetBSD: strchr.3,v 1.11 2003/08/07 16:43:49 agc Exp $
34.\"
35.Dd August 11, 2002
36.Dt STRCHR 3
37.Os
38.Sh NAME
39.Nm strchr
40.Nd locate character in string
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In string.h
45.Ft char *
46.Fn strchr "const char *s" "int c"
47.Sh DESCRIPTION
48The
49.Fn strchr
50function locates the first occurrence of
51.Ar c
52in the string pointed to by
53.Ar s .
54The terminating
55.Dv NUL
56character is considered part of the string.
57If
58.Fa c
59is
60.Ql \e0 ,
61.Fn strchr
62locates the terminating
63.Ql \e0 .
64.Sh RETURN VALUES
65The function
66.Fn strchr
67returns a pointer to the located character, or
68.Dv NULL
69if the character does not appear in the string.
70.Sh EXAMPLES
71After the following call to
72.Fn strchr ,
73.Va p
74will point to the string
75.Qq oobar :
76.Bd -literal -offset indent
77char *p;
78char *s = "foobar";
79
80p = strchr(s, 'o');
81.Ed
82.Sh SEE ALSO
83.Xr index 3 ,
84.Xr memchr 3 ,
85.Xr rindex 3 ,
86.Xr strcspn 3 ,
87.Xr strpbrk 3 ,
88.Xr strrchr 3 ,
89.Xr strsep 3 ,
90.Xr strspn 3 ,
91.Xr strstr 3 ,
92.Xr strtok 3
93.Sh STANDARDS
94The
95.Fn strchr
96function
97conforms to
98.St -ansiC .
99