man3/strcasecmp.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 18:12:45 1993 by Rik Faith (faith@cs.unc.edu)
  30 .TH STRCASECMP 3  2021-03-22 "" "Linux Programmer's Manual"
  31 .SH NAME
  32 strcasecmp, strncasecmp \- compare two strings ignoring case
  33 .SH SYNOPSIS
  34 .nf
  35 .B #include <strings.h>
  36 .PP
  37 .BI "int strcasecmp(const char *" s1 ", const char *" s2 );
  38 .BI "int strncasecmp(const char *" s1 ", const char *" s2 ", size_t " n );
  39 .fi
  40 .SH DESCRIPTION
  41 The
  42 .BR strcasecmp ()
  43 function performs a byte-by-byte comparison of the strings
  44 .I s1
  45 and
  46 .IR s2 ,
  47 ignoring the case of the characters.
  48 It returns an integer
  49 less than, equal to, or greater than zero if
  50 .I s1
  51 is found,
  52 respectively, to be less than, to match, or be greater than
  53 .IR s2 .
  54 .PP
  55 The
  56 .BR strncasecmp ()
  57 function is similar, except that it compares
  58 no more than
  59 .I n
  60 bytes of
  61 .IR s1
  62 and
  63 .IR s2 .
  64 .SH RETURN VALUE
  65 The
  66 .BR strcasecmp ()
  67 and
  68 .BR strncasecmp ()
  69 functions return
  70 an integer less than, equal to, or greater than zero if
  71 .I s1
  72 is, after ignoring case, found to be
  73 less than, to match, or be greater than
  74 .IR s2 ,
  75 respectively.
  76 .SH ATTRIBUTES
  77 For an explanation of the terms used in this section, see
  78 .BR attributes (7).
  79 .ad l
  80 .nh
  81 .TS
  82 allbox;
  83 lbx lb lb
  84 l l l.
  85 Interface       Attribute       Value
  86 T{
  87 .BR strcasecmp (),
  88 .BR strncasecmp ()
  89 T}      Thread safety   MT-Safe locale
  90 .TE
  91 .hy
  92 .ad
  93 .sp 1
  94 .SH CONFORMING TO
  95 4.4BSD, POSIX.1-2001, POSIX.1-2008.
  96 .SH NOTES
  97 The
  98 .BR strcasecmp ()
  99 and
 100 .BR strncasecmp ()
 101 functions first appeared in 4.4BSD, where they were declared in
 102 .IR <string.h> .
 103 Thus, for reasons of historical compatibility, the glibc
 104 .I <string.h>
 105 header file also declares these functions, if the
 106 .B _DEFAULT_SOURCE
 107 (or, in glibc 2.19 and earlier,
 108 .BR _BSD_SOURCE )
 109 feature test macro is defined.
 110 .PP
 111 The POSIX.1-2008 standard says of these functions:
 112 .PP
 113 .RS
 114 When the
 115 .B LC_CTYPE
 116 category of the locale being used is from the POSIX locale,
 117 these functions shall behave as if the strings had been converted
 118 to lowercase and then a byte comparison performed.
 119 Otherwise, the results are unspecified.
 120 .RE
 121 .SH SEE ALSO
 122 .BR bcmp (3),
 123 .BR memcmp (3),
 124 .BR strcmp (3),
 125 .BR strcoll (3),
 126 .BR string (3),
 127 .BR strncmp (3),
 128 .BR wcscasecmp (3),
 129 .BR wcsncasecmp (3)