]> git.saurik.com Git - apple/libc.git/blame_incremental - string/bcmp.3
Libc-594.9.5.tar.gz
[apple/libc.git] / string / bcmp.3
... / ...
CommitLineData
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. All advertising materials mentioning features or use of this software
15.\" must display the following acknowledgement:
16.\" This product includes software developed by the University of
17.\" California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\" may be used to endorse or promote products derived from this software
20.\" without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" @(#)bcmp.3 8.1 (Berkeley) 6/4/93
35.\" $FreeBSD: src/lib/libc/string/bcmp.3,v 1.10 2003/09/08 19:57:15 ru Exp $
36.\"
37.Dd June 4, 1993
38.Dt BCMP 3
39.Os
40.Sh NAME
41.Nm bcmp
42.Nd compare byte string
43.Sh LIBRARY
44.Lb libc
45.Sh SYNOPSIS
46.In strings.h
47.Ft int
48.Fn bcmp "const void *s1" "const void *s2" "size_t n"
49.Sh DESCRIPTION
50The
51.Fn bcmp
52function
53compares byte string
54.Fa s1
55against byte string
56.Fa s2 ,
57returning zero if they are identical, non-zero otherwise.
58Both strings are assumed to be
59.Fa n
60bytes long.
61Zero-length strings are always identical.
62.Pp
63The strings may overlap.
64.Sh SEE ALSO
65.Xr memcmp 3 ,
66.Xr strcasecmp 3 ,
67.Xr strcmp 3 ,
68.Xr strcoll 3 ,
69.Xr strxfrm 3
70.Sh HISTORY
71A
72.Fn bcmp
73function first appeared in
74.Bx 4.2 .
75Its prototype existed previously in
76.In string.h
77before it was moved to
78.In strings.h
79for
80.St -p1003.1-2001
81compliance.