string/strchr.3

   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. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)strchr.3    8.2 (Berkeley) 4/19/94
  37 .\" $FreeBSD: src/lib/libc/string/strchr.3,v 1.11 2003/09/04 20:36:54 simon Exp $
  38 .\"
  39 .Dd April 19, 1994
  40 .Dt STRCHR 3
  41 .Os
  42 .Sh NAME
  43 .Nm strchr , strrchr
  44 .Nd locate character in string
  45 .Sh LIBRARY
  46 .Lb libc
  47 .Sh SYNOPSIS
  48 .In string.h
  49 .Ft "char *"
  50 .Fo strchr
  51 .Fa "const char *s"
  52 .Fa "int c"
  53 .Fc
  54 .Ft "char *"
  55 .Fo strrchr
  56 .Fa "const char *s"
  57 .Fa "int c"
  58 .Fc
  59 .Sh DESCRIPTION
  60 The
  61 .Fn strchr
  62 function locates the first occurrence of
  63 .Fa c
  64 (converted to a
  65 .Vt char )
  66 in the string pointed to by
  67 .Fa s .
  68 The terminating null character is considered to be part of the string;
  69 therefore if
  70 .Fa c
  71 is
  72 .Ql \e0 ,
  73 the functions locate the terminating
  74 .Ql \e0 .
  75 .Pp
  76 The
  77 .Fn strrchr
  78 function is identical to
  79 .Fn strchr ,
  80 except it locates the last occurrence of
  81 .Fa c .
  82 .Sh RETURN VALUES
  83 The functions
  84 .Fn strchr
  85 and
  86 .Fn strrchr
  87 return a pointer to the located character, or
  88 .Dv NULL
  89 if the character does not appear in the string.
  90 .Sh SEE ALSO
  91 .Xr memchr 3 ,
  92 .Xr strcspn 3 ,
  93 .Xr strpbrk 3 ,
  94 .Xr strsep 3 ,
  95 .Xr strspn 3 ,
  96 .Xr strstr 3 ,
  97 .Xr strtok 3
  98 .Sh STANDARDS
  99 The functions
 100 .Fn strchr
 101 and
 102 .Fn strrchr
 103 conform to
 104 .St -isoC .