lib/libc/string/bcmp.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.
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)bcmp.3      8.1 (Berkeley) 6/4/93
  31 .\" $FreeBSD: src/lib/libc/string/bcmp.3,v 1.11 2007/01/09 00:28:11 imp Exp $
  32 .\" $DragonFly: src/lib/libc/string/bcmp.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  33 .\"
  34 .Dd June 4, 1993
  35 .Dt BCMP 3
  36 .Os
  37 .Sh NAME
  38 .Nm bcmp
  39 .Nd compare byte string
  40 .Sh LIBRARY
  41 .Lb libc
  42 .Sh SYNOPSIS
  43 .In strings.h
  44 .Ft int
  45 .Fn bcmp "const void *b1" "const void *b2" "size_t len"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn bcmp
  49 function
  50 compares byte string
  51 .Fa b1
  52 against byte string
  53 .Fa b2 ,
  54 returning zero if they are identical, non-zero otherwise.
  55 Both strings are assumed to be
  56 .Fa len
  57 bytes long.
  58 Zero-length strings are always identical.
  59 .Pp
  60 The strings may overlap.
  61 .Sh SEE ALSO
  62 .Xr memcmp 3 ,
  63 .Xr strcasecmp 3 ,
  64 .Xr strcmp 3 ,
  65 .Xr strcoll 3 ,
  66 .Xr strxfrm 3
  67 .Sh HISTORY
  68 A
  69 .Fn bcmp
  70 function first appeared in
  71 .Bx 4.2 .
  72 Its prototype existed previously in
  73 .In string.h
  74 before it was moved to
  75 .In strings.h
  76 for
  77 .St -p1003.1-2001
  78 compliance.