man3/bcmp.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 21:36:50 1993 by Rik Faith <faith@cs.unc.edu>
  30 .\" Modified Tue Oct 22 23:47:36 1996 by Eric S. Raymond <esr@thyrsus.com>
  31 .TH BCMP 3  2021-03-22 "Linux" "Linux Programmer's Manual"
  32 .SH NAME
  33 bcmp \- compare byte sequences
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <strings.h>
  37 .PP
  38 .BI "int bcmp(const void *" s1 ", const void *" s2 ", size_t " n );
  39 .fi
  40 .SH DESCRIPTION
  41 The
  42 .BR bcmp ()
  43 function compares the two byte sequences
  44 .I s1
  45 and
  46 .I s2
  47 of length
  48 .I n
  49 each.
  50 If they are equal, and in particular if
  51 .I n
  52 is zero,
  53 .BR bcmp ()
  54 returns 0.
  55 Otherwise, it returns a nonzero result.
  56 .SH RETURN VALUE
  57 The
  58 .BR bcmp ()
  59 function returns 0 if the byte sequences are equal,
  60 otherwise a nonzero result is returned.
  61 .SH ATTRIBUTES
  62 For an explanation of the terms used in this section, see
  63 .BR attributes (7).
  64 .ad l
  65 .nh
  66 .TS
  67 allbox;
  68 lbx lb lb
  69 l l l.
  70 Interface       Attribute       Value
  71 T{
  72 .BR bcmp ()
  73 T}      Thread safety   MT-Safe
  74 .TE
  75 .hy
  76 .ad
  77 .sp 1
  78 .SH CONFORMING TO
  79 4.3BSD.
  80 This function is deprecated (marked as LEGACY in POSIX.1-2001): use
  81 .BR memcmp (3)
  82 in new programs.
  83 POSIX.1-2008 removes the specification of
  84 .BR bcmp ().
  85 .SH SEE ALSO
  86 .BR bstring (3),
  87 .BR memcmp (3),
  88 .BR strcasecmp (3),
  89 .BR strcmp (3),
  90 .BR strcoll (3),
  91 .BR strncasecmp (3),
  92 .BR strncmp (3)