lib/libcr/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.4.2.4 2001/12/14 18:33:59 ru Exp $
  38 .\" $DragonFly: src/lib/libcr/string/Attic/strchr.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  39 .\"
  40 .Dd April 19, 1994
  41 .Dt STRCHR 3
  42 .Os
  43 .Sh NAME
  44 .Nm strchr
  45 .Nd locate character in string
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In string.h
  50 .Ft char *
  51 .Fn strchr "const char *s" "int c"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn strchr
  55 function locates the first occurrence of
  56 .Ar c
  57 in the string pointed to by
  58 .Ar s .
  59 The terminating
  60 .Dv NUL
  61 character is considered part of the string.
  62 If
  63 .Fa c
  64 is
  65 .Ql \e0 ,
  66 .Fn strchr
  67 locates the terminating
  68 .Ql \e0 .
  69 .Sh RETURN VALUES
  70 The function
  71 .Fn strchr
  72 returns a pointer to the located character, or
  73 .Dv NULL
  74 if the character does not appear in the string.
  75 .Sh SEE ALSO
  76 .Xr memchr 3 ,
  77 .Xr strcspn 3 ,
  78 .Xr strpbrk 3 ,
  79 .Xr strrchr 3 ,
  80 .Xr strsep 3 ,
  81 .Xr strspn 3 ,
  82 .Xr strstr 3 ,
  83 .Xr strtok 3
  84 .Sh STANDARDS
  85 The
  86 .Fn strchr
  87 function
  88 conforms to
  89 .St -isoC .