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 .\"     from: @(#)strcasecmp.3  8.1 (Berkeley) 6/9/93
  31 .\"     $NetBSD: strcasecmp.3,v 1.17 2006/10/16 08:48:45 wiz Exp $
  32 .\"
  33 .Dd June 9, 1993
  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 .Sh DESCRIPTION
  49 The
  50 .Fn strcasecmp
  51 and
  52 .Fn strncasecmp
  53 functions
  54 compare the nul-terminated strings
  55 .Fa s1
  56 and
  57 .Fa s2
  58 and return an integer greater than, equal to, or less than 0,
  59 according to whether
  60 .Fa s1
  61 is lexicographically greater than, equal to, or less than
  62 .Fa s2
  63 after translation of each corresponding character to lower-case.
  64 The strings themselves are not modified.
  65 The comparison is done using unsigned characters, so that
  66 .Sq Li \e200
  67 is greater than
  68 .Ql \e0 .
  69 .Pp
  70 The
  71 .Fn strncasecmp
  72 compares at most
  73 .Fa len
  74 characters.
  75 .Sh SEE ALSO
  76 .Xr bcmp 3 ,
  77 .Xr memcmp 3 ,
  78 .Xr strcmp 3 ,
  79 .Xr strcoll 3 ,
  80 .Xr strxfrm 3
  81 .Sh HISTORY
  82 The
  83 .Fn strcasecmp
  84 and
  85 .Fn strncasecmp
  86 functions first appeared in
  87 .Bx 4.4 .
  88 .Sh NOTES
  89 If
  90 .Fa len
  91 is zero
  92 .Fn strncasecmp
  93 returns always 0.