6/lib/libc/string/memchr.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 .\"     @(#)memchr.3    8.1 (Berkeley) 6/4/93
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd April 9, 2008
  40 .Dt MEMCHR 3
  41 .Os
  42 .Sh NAME
  43 .Nm memchr
  44 .Nd locate byte in byte string
  45 .Sh LIBRARY
  46 .Lb libc
  47 .Sh SYNOPSIS
  48 .In string.h
  49 .Ft void *
  50 .Fn memchr "const void *b" "int c" "size_t len"
  51 .Ft void *
  52 .Fn memrchr "const void *b" "int c" "size_t len"
  53 .Sh DESCRIPTION
  54 The
  55 .Fn memchr
  56 function
  57 locates the first occurrence of
  58 .Fa c
  59 (converted to an unsigned char)
  60 in string
  61 .Fa b .
  62 .Pp
  63 The
  64 .Fn memrchr
  65 function behaves like
  66 .Fn memchr ,
  67 except that it locates the last occurrence of
  68 .Fa c
  69 in string
  70 .Fa b .
  71 .Sh RETURN VALUES
  72 The
  73 .Fn memchr
  74 and
  75 .Fn memrchr
  76 functions
  77 return a pointer to the byte located,
  78 or NULL if no such byte exists within
  79 .Fa len
  80 bytes.
  81 .Sh SEE ALSO
  82 .Xr memmem 3 ,
  83 .Xr strchr 3 ,
  84 .Xr strcspn 3 ,
  85 .Xr strpbrk 3 ,
  86 .Xr strrchr 3 ,
  87 .Xr strsep 3 ,
  88 .Xr strspn 3 ,
  89 .Xr strstr 3 ,
  90 .Xr strtok 3
  91 .Sh STANDARDS
  92 The
  93 .Fn memchr
  94 function
  95 conforms to
  96 .St -isoC .
  97 .Pp
  98 The
  99 .Fn memrchr
 100 function is a GNU extension and conforms to no standard.
 101 .Sh HISTORY
 102 The
 103 .Fn memrchr
 104 function first appeared in GNU libc 2.1.91, this implementation
 105 first appeared in
 106 .Fx 8.0 ,
 107 coming from
 108 .Ox 4.3 .