string/FreeBSD/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 .Fn strchr "const char *s" "int c"
  51 .Ft "char *"
  52 .Fn strrchr "const char *s" "int c"
  53 .Sh DESCRIPTION
  54 The
  55 .Fn strchr
  56 function locates the first occurrence of
  57 .Fa c
  58 (converted to a
  59 .Vt char )
  60 in the string pointed to by
  61 .Fa s .
  62 The terminating null character is considered part of the string;
  63 therefore if
  64 .Fa c
  65 is
  66 .Ql \e0 ,
  67 the functions locate the terminating
  68 .Ql \e0 .
  69 .Pp
  70 The
  71 .Fn strrchr
  72 function is identical to
  73 .Fn strchr
  74 except it locates the last occurrence of
  75 .Fa c .
  76 .Sh RETURN VALUES
  77 The functions
  78 .Fn strchr
  79 and
  80 .Fn strrchr
  81 return a pointer to the located character, or
  82 .Dv NULL
  83 if the character does not appear in the string.
  84 .Sh SEE ALSO
  85 .Xr memchr 3 ,
  86 .Xr strcspn 3 ,
  87 .Xr strpbrk 3 ,
  88 .Xr strsep 3 ,
  89 .Xr strspn 3 ,
  90 .Xr strstr 3 ,
  91 .Xr strtok 3
  92 .Sh STANDARDS
  93 The functions
  94 .Fn strchr
  95 and
  96 .Fn strrchr
  97 conform to
  98 .St -isoC .