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