xref: /freebsd/lib/libc/string/bcmp.3 (revision 38c63bdc46252d4d8cd313dff4183ec4546d26d9)
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.Dd August 15, 2016
31.Dt BCMP 3
32.Os
33.Sh NAME
34.Nm bcmp
35.Nd compare byte string
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In strings.h
40.Ft int
41.Fn bcmp "const void *b1" "const void *b2" "size_t len"
42.Sh DESCRIPTION
43The
44.Fn bcmp
45function
46compares byte string
47.Fa b1
48against byte string
49.Fa b2 ,
50returning zero if they are identical, non-zero otherwise.
51Both strings are assumed to be
52.Fa len
53bytes long.
54Zero-length strings are always identical.
55.Pp
56The strings may overlap.
57.Sh SEE ALSO
58.Xr memcmp 3 ,
59.Xr strcasecmp 3 ,
60.Xr strcmp 3 ,
61.Xr strcoll 3 ,
62.Xr strxfrm 3 ,
63.Xr timingsafe_bcmp 3
64.Sh HISTORY
65A
66.Fn bcmp
67function first appeared in
68.Bx 4.2 .
69Its prototype existed previously in
70.In string.h
71before it was moved to
72.In strings.h
73for
74.St -p1003.1-2001
75compliance.
76