xref: /netbsd/share/man/man9/bcmp.9 (revision 6550d01e)
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.\"     from: @(#)bcmp.3	8.1 (Berkeley) 6/4/93
31.\"	$NetBSD: bcmp.9,v 1.6 2003/08/07 10:31:29 agc Exp $
32.\"
33.Dd July 7, 2001
34.Dt BCMP 9
35.Os
36.Sh NAME
37.Nm bcmp
38.Nd compare byte string
39.Sh SYNOPSIS
40.In sys/systm.h
41.Ft int
42.Fn bcmp "const void *b1" "const void *b2" "size_t len"
43.Sh DESCRIPTION
44.Bf -symbolic
45The
46.Fn bcmp
47interface is obsolete.
48Do not add new code using it.
49It will soon be purged.
50Use
51.Xr memcmp 9
52instead.
53(The
54.Fn bcmp
55function is now a macro for
56.Xr memcmp 9 . )
57.Ef
58.Pp
59The
60.Fn bcmp
61function
62compares byte string
63.Fa b1
64against byte string
65.Fa b2 ,
66returning zero if they are identical, non-zero otherwise.
67Both strings are assumed to be
68.Fa len
69bytes long.
70Zero-length strings are always identical.
71.Pp
72The strings may overlap.
73.Sh SEE ALSO
74.Xr memcmp 9
75