The Open Group Base Specifications Issue 7, 2018 edition
IEEE Std 1003.1-2017 (Revision of IEEE Std 1003.1-2008)
Copyright © 2001-2018 IEEE and The Open Group

NAME

wcscasecmp, wcscasecmp_l, wcsncasecmp, wcsncasecmp_l - case-insensitive wide-character string comparison

SYNOPSIS

[CX] [Option Start] #include <wchar.h>

int wcscasecmp(const wchar_t *
ws1, const wchar_t *ws2);
int wcscasecmp_l(const wchar_t *
ws1, const wchar_t *ws2,
       locale_t
locale);
int wcsncasecmp(const wchar_t *
ws1, const wchar_t *ws2, size_t n);
int wcsncasecmp_l(const wchar_t *
ws1, const wchar_t *ws2,
       size_t
n, locale_t locale); [Option End]

DESCRIPTION

The wcscasecmp() and wcsncasecmp() functions are the wide-character equivalent of the strcasecmp() and strncasecmp() functions, respectively.

The wcscasecmp() and wcscasecmp_l() functions shall compare, while ignoring differences in case, the wide-character string pointed to by ws1 to the wide-character string pointed to by ws2.

The wcsncasecmp() and wcsncasecmp_l() functions shall compare, while ignoring differences in case, not more than n wide-characters from the wide-character string pointed to by ws1 to the wide-character string pointed to by ws2.

The wcscasecmp() and wcsncasecmp() functions use the current locale to determine the case of the wide characters.

The wcscasecmp_l() and wcsncasecmp_l() functions use the locale represented by locale to determine the case of the wide characters.

When the LC_CTYPE category of the locale being used is from the POSIX locale, these functions shall behave as if the wide-character strings had been converted to lowercase and then a comparison of wide-character codes performed. Otherwise, the results are unspecified.

The information for wcscasecmp_l() and wcsncasecmp_l() about the case of the characters comes from the locale represented by locale.

The behavior is undefined if the locale argument to wcscasecmp_l() or wcsncasecmp_l() is the special locale object LC_GLOBAL_LOCALE or is not a valid locale object handle.

RETURN VALUE

Upon completion, the wcscasecmp() and wcscasecmp_l() functions shall return an integer greater than, equal to, or less than 0 if the wide-character string pointed to by ws1 is, ignoring case, greater than, equal to, or less than the wide-character string pointed to by ws2, respectively.

Upon completion, the wcsncasecmp() and wcsncasecmp_l() functions shall return an integer greater than, equal to, or less than 0 if the possibly null wide-character terminated string pointed to by ws1 is, ignoring case, greater than, equal to, or less than the possibly null wide-character terminated string pointed to by ws2, respectively.

No return values are reserved to indicate an error.

ERRORS

No errors are defined.


The following sections are informative.

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

strcasecmp, wcscmp, wcsncmp

XBD <wchar.h>

CHANGE HISTORY

First released in Issue 7.

POSIX.1-2008, Technical Corrigendum 1, XSH/TC1-2008/0716 [294], XSH/TC1-2008/0717 [283], and XSH/TC1-2008/0718 [283] are applied.

End of informative text.

 

return to top of page

UNIX ® is a registered Trademark of The Open Group.
POSIX ® is a registered Trademark of The IEEE.
Copyright © 2001-2018 IEEE and The Open Group, All Rights Reserved
[ Main Index | XBD | XSH | XCU | XRAT ]