lib/libc/string/memcmp.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 .\"     @(#)memcmp.3    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/string/memcmp.3,v 1.9 2007/01/09 00:28:12 imp Exp $
  34 .\" $DragonFly: src/lib/libc/string/memcmp.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt MEMCMP 3
  38 .Os
  39 .Sh NAME
  40 .Nm memcmp
  41 .Nd compare byte string
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In string.h
  46 .Ft int
  47 .Fn memcmp "const void *b1" "const void *b2" "size_t len"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn memcmp
  51 function
  52 compares byte string
  53 .Fa b1
  54 against byte string
  55 .Fa b2 .
  56 Both strings are assumed to be
  57 .Fa len
  58 bytes long.
  59 .Sh RETURN VALUES
  60 The
  61 .Fn memcmp
  62 function
  63 returns zero if the two strings are identical,
  64 otherwise returns the difference between the first two differing bytes
  65 (treated as unsigned char values, so that
  66 .Sq Li \e200
  67 is greater than
  68 .Sq Li \&\e0 ,
  69 for example).
  70 Zero-length strings are always identical.
  71 .Sh SEE ALSO
  72 .Xr bcmp 3 ,
  73 .Xr strcasecmp 3 ,
  74 .Xr strcmp 3 ,
  75 .Xr strcoll 3 ,
  76 .Xr strxfrm 3
  77 .Sh STANDARDS
  78 The
  79 .Fn memcmp
  80 function
  81 conforms to
  82 .St -isoC .