lib/libc/string/strcasecmp.3

   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 .\"     @(#)strcasecmp.3        8.1 (Berkeley) 6/9/93
  31 .\" $FreeBSD: head/lib/libc/string/strcasecmp.3 251069 2013-05-28 20:57:40Z emaste $
  32 .\"
  33 .Dd December 25, 2013
  34 .Dt STRCASECMP 3
  35 .Os
  36 .Sh NAME
  37 .Nm strcasecmp ,
  38 .Nm strncasecmp
  39 .Nd compare strings, ignoring case
  40 .Sh LIBRARY
  41 .Lb libc
  42 .Sh SYNOPSIS
  43 .In strings.h
  44 .Ft int
  45 .Fn strcasecmp "const char *s1" "const char *s2"
  46 .Ft int
  47 .Fn strncasecmp "const char *s1" "const char *s2" "size_t len"
  48 .Ft int
  49 .Fn strcasecmp_l "const char *s1" "const char *s2" "locale_t locale"
  50 .Ft int
  51 .Fn strncasecmp_l "const char *s1" "const char *s2" "size_t len" "locale_t locale"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn strcasecmp ,
  55 .Fn strcasecmp_l ,
  56 .Fn strncasecmp ,
  57 and
  58 .Fn strncasecmp_l
  59 functions
  60 compare the null-terminated strings
  61 .Fa s1
  62 and
  63 .Fa s2 .
  64 .Pp
  65 The
  66 .Fn strncasecmp
  67 function compares at most
  68 .Fa len
  69 characters.
  70 The
  71 .Fn strcasecmp_l
  72 and
  73 .Fn strncasecmp_l
  74 functions do the same as their non-locale versions above, but take an
  75 explicit
  76 .Fa locale
  77 rather than using the current locale.
  78 .Sh RETURN VALUES
  79 The functions
  80 .Fn strcasecmp
  81 and
  82 .Fn strncasecmp
  83 return an integer greater than, equal to, or less than 0,
  84 depending on whether
  85 .Fa s1
  86 is lexicographically greater than, equal to, or less than
  87 .Fa s2
  88 after translation of each corresponding character to lower-case.
  89 The strings themselves are not modified.
  90 The comparison is done using unsigned characters, so that
  91 .Sq Li \e200
  92 is greater than
  93 .Ql \e0 .
  94 The functions
  95 .Fn strcasecmp_l
  96 and
  97 .Fn strncasecmp_l
  98 do the same but take explicit locales.
  99 .Sh SEE ALSO
 100 .Xr memcmp 3 ,
 101 .Xr strcmp 3 ,
 102 .Xr strcoll 3 ,
 103 .Xr strxfrm 3 ,
 104 .Xr tolower 3 ,
 105 .Xr wcscasecmp 3
 106 .Sh HISTORY
 107 The
 108 .Fn strcasecmp
 109 and
 110 .Fn strncasecmp
 111 functions first appeared in
 112 .Bx 4.4 .
 113 Their prototypes existed previously in
 114 .In string.h
 115 before they were moved to
 116 .In strings.h
 117 for
 118 .St -p1003.1-2001
 119 compliance.
 120 .Pp
 121 The
 122 .Fn strcasecmp_l
 123 and
 124 .Fn strncasecmp_l
 125 functions conform to
 126 .St -p1003.1-2008 .