man3/wcscasecmp.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" References consulted:
  11 .\"   GNU glibc-2 source code and manual
  12 .\"   Dinkumware C library reference http://www.dinkumware.com/
  13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  14 .\"
  15 .TH WCSCASECMP 3 2021-03-22 "GNU" "Linux Programmer's Manual"
  16 .SH NAME
  17 wcscasecmp \- compare two wide-character strings, ignoring case
  18 .SH SYNOPSIS
  19 .nf
  20 .B #include <wchar.h>
  21 .PP
  22 .BI "int wcscasecmp(const wchar_t *" s1 ", const wchar_t *" s2 );
  23 .fi
  24 .PP
  25 .RS -4
  26 Feature Test Macro Requirements for glibc (see
  27 .BR feature_test_macros (7)):
  28 .RE
  29 .PP
  30 .BR wcscasecmp ():
  31 .nf
  32     Since glibc 2.10:
  33         _POSIX_C_SOURCE >= 200809L
  34     Before glibc 2.10:
  35         _GNU_SOURCE
  36 .fi
  37 .SH DESCRIPTION
  38 The
  39 .BR wcscasecmp ()
  40 function is the wide-character equivalent of the
  41 .BR strcasecmp (3)
  42 function.
  43 It compares the wide-character string pointed to
  44 by
  45 .I s1
  46 and the wide-character string pointed to by
  47 .IR s2 ,
  48 ignoring
  49 case differences
  50 .RB ( towupper (3),
  51 .BR towlower (3)).
  52 .SH RETURN VALUE
  53 The
  54 .BR wcscasecmp ()
  55 function returns zero if the wide-character strings at
  56 .I s1
  57 and
  58 .I s2
  59 are equal except for case distinctions.
  60 It returns a
  61 positive integer if
  62 .I s1
  63 is greater than
  64 .IR s2 ,
  65 ignoring case.
  66 It
  67 returns a negative integer if
  68 .I s1
  69 is smaller
  70 than
  71 .IR s2 ,
  72 ignoring case.
  73 .SH VERSIONS
  74 The
  75 .BR wcscasecmp ()
  76 function is provided in glibc since version 2.1.
  77 .SH ATTRIBUTES
  78 For an explanation of the terms used in this section, see
  79 .BR attributes (7).
  80 .ad l
  81 .nh
  82 .TS
  83 allbox;
  84 lbx lb lb
  85 l l l.
  86 Interface       Attribute       Value
  87 T{
  88 .BR wcscasecmp ()
  89 T}      Thread safety   MT-Safe locale
  90 .TE
  91 .hy
  92 .ad
  93 .sp 1
  94 .SH CONFORMING TO
  95 POSIX.1-2008.
  96 This function is not specified in POSIX.1-2001,
  97 and is not widely available on other systems.
  98 .SH NOTES
  99 The behavior of
 100 .BR wcscasecmp ()
 101 depends on the
 102 .B LC_CTYPE
 103 category of the
 104 current locale.
 105 .SH SEE ALSO
 106 .BR strcasecmp (3),
 107 .BR wcscmp (3)