xref: /netbsd-src/lib/libc/string/index.3 (revision cf2f172048b0ec98455634d1998367f568fafeac)

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek.
.\" 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.
.\"
.\"     from: @(#)index.3	8.1 (Berkeley) 6/4/93
.\"	$NetBSD: index.3,v 1.15 2012/05/05 21:18:43 dholland Exp $
.\"
.Dd May 5, 2012
.Dt INDEX 3
.Os
.Sh NAME
.Nm index
.Nd locate character in string
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In strings.h
.Ft char *
.Fn index "const char *s" "int c"
.Sh DESCRIPTION
The
.Fn index
function
locates the first character matching
.Fa c
(converted to a
.Em char )
in the nul-terminated string
.Fa s .
.Pp
This function is obsolete.
The equivalent function
.Xr strchr 3
should be used instead.
.Sh RETURN VALUES
A pointer to the character is returned if it is found; otherwise
.Dv NULL
is returned.
If
.Fa c
is '\e0',
.Fn index
locates the terminating '\e0'.
.Sh SEE ALSO
.Xr memchr 3 ,
.Xr rindex 3 ,
.Xr strchr 3 ,
.Xr strcspn 3 ,
.Xr strpbrk 3 ,
.Xr strrchr 3 ,
.Xr strsep 3 ,
.Xr strspn 3 ,
.Xr strstr 3 ,
.Xr strtok 3
.Sh STANDARDS
The
.Fn index
function conforms to
.St -p1003.1-2001 .
The
.St -p1003.1-2004
revision marked it as legacy and recommended the use of
.Xr strchr 3
instead.
The
.St -p1003.1-2008
revision removed
.Fn index
from the specification.
.Sh HISTORY
An
.Fn index
function appeared in
.At v6 .