original/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 2010-09-15 "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 .sp
  22 .BI "int wcscasecmp(const wchar_t *" s1 ", const wchar_t *" s2 );
  23 .fi
  24 .sp
  25 .in -4n
  26 Feature Test Macro Requirements for glibc (see
  27 .BR feature_test_macros (7)):
  28 .in
  29 .sp
  30 .BR wcscasecmp ():
  31 .PD 0
  32 .ad l
  33 .RS 4
  34 .TP 4
  35 Since glibc 2.10:
  36 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  37 .TP
  38 Before glibc 2.10:
  39 _GNU_SOURCE
  40 .RE
  41 .ad
  42 .PD
  43 .SH DESCRIPTION
  44 The
  45 .BR wcscasecmp ()
  46 function is the wide-character equivalent of the
  47 .BR strcasecmp (3)
  48 function.
  49 It compares the wide-character string pointed to
  50 by \fIs1\fP and the wide-character string pointed to by \fIs2\fP, ignoring
  51 case differences
  52 .RB ( towupper (3),
  53 .BR towlower (3)).
  54 .SH RETURN VALUE
  55 The
  56 .BR wcscasecmp ()
  57 function returns zero if the wide-character strings at
  58 \fIs1\fP and \fIs2\fP are equal except for case distinctions.
  59 It returns a
  60 positive integer if \fIs1\fP is greater than \fIs2\fP, ignoring case.
  61 It
  62 returns a negative integer if \fIs1\fP is smaller
  63 than \fIs2\fP, ignoring case.
  64 .SH VERSIONS
  65 The
  66 .BR wcscasecmp ()
  67 function is provided in glibc since version 2.1.
  68 .SH CONFORMING TO
  69 POSIX.1-2008.
  70 This function is not specified in POSIX.1-2001,
  71 and is not widely available on other systems.
  72 .SH NOTES
  73 The behavior of
  74 .BR wcscasecmp ()
  75 depends on the
  76 .B LC_CTYPE
  77 category of the
  78 current locale.
  79 .SH SEE ALSO
  80 .BR strcasecmp (3),
  81 .BR wcscmp (3)