]> git.saurik.com Git - apple/libc.git/blame - string/FreeBSD/bcmp.3
Libc-1439.100.3.tar.gz
[apple/libc.git] / string / FreeBSD / bcmp.3
CommitLineData
5b2abdfb 1.\" Copyright (c) 1990, 1991, 1993
e9ce8d39
A
2.\" The Regents of the University of California. All rights reserved.
3.\"
5b2abdfb
A
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek.
e9ce8d39
A
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.
fc5ea90f 14.\" 3. Neither the name of the University nor the names of its contributors
e9ce8d39
A
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.\"
5b2abdfb 30.\" @(#)bcmp.3 8.1 (Berkeley) 6/4/93
fc5ea90f 31.\" $FreeBSD$
e9ce8d39 32.\"
fc5ea90f 33.Dd August 15, 2016
5b2abdfb 34.Dt BCMP 3
e9ce8d39
A
35.Os
36.Sh NAME
5b2abdfb
A
37.Nm bcmp
38.Nd compare byte string
e9ce8d39
A
39.Sh LIBRARY
40.Lb libc
41.Sh SYNOPSIS
9385eb3d 42.In strings.h
e9ce8d39 43.Ft int
fc5ea90f 44.Fn bcmp "const void *b1" "const void *b2" "size_t len"
e9ce8d39
A
45.Sh DESCRIPTION
46The
5b2abdfb
A
47.Fn bcmp
48function
49compares byte string
fc5ea90f 50.Fa b1
5b2abdfb 51against byte string
fc5ea90f 52.Fa b2 ,
5b2abdfb
A
53returning zero if they are identical, non-zero otherwise.
54Both strings are assumed to be
fc5ea90f 55.Fa len
5b2abdfb
A
56bytes long.
57Zero-length strings are always identical.
58.Pp
59The strings may overlap.
e9ce8d39 60.Sh SEE ALSO
5b2abdfb
A
61.Xr memcmp 3 ,
62.Xr strcasecmp 3 ,
63.Xr strcmp 3 ,
64.Xr strcoll 3 ,
fc5ea90f
A
65.Xr strxfrm 3 ,
66.Xr timingsafe_bcmp 3
e9ce8d39 67.Sh HISTORY
5b2abdfb
A
68A
69.Fn bcmp
e9ce8d39 70function first appeared in
5b2abdfb 71.Bx 4.2 .
9385eb3d 72Its prototype existed previously in
3d9156a7 73.In string.h
9385eb3d 74before it was moved to
3d9156a7 75.In strings.h
9385eb3d
A
76for
77.St -p1003.1-2001
78compliance.