Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

wcsxfrm(3) [osx man page]

WCSXFRM(3)						   BSD Library Functions Manual 						WCSXFRM(3)

NAME
wcsxfrm, wcsxfrm_l -- transform a wide string under locale LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <wchar.h> size_t wcsxfrm(wchar_t *restrict ws1, const wchar_t *restrict ws2, size_t n); #include <wchar.h> #include <xlocale.h> size_t wcsxfrm_l(wchar_t *restrict ws1, const wchar_t *restrict ws2, size_t n, locale_t loc); DESCRIPTION
The wcsxfrm() function transforms a null-terminated wide character string pointed to by ws2, according to the current locale's collation order, then copies the transformed string into ws1. No more than n wide characters are copied into ws1, including the terminating null char- acter. If n is set to 0 (it helps to determine an actual size needed for transformation), ws1 is permitted to be a NULL pointer. Comparing two strings using wcscmp() after wcsxfrm() is equivalent to comparing two original strings with wcscoll(). Although the wcsxfrm() function uses the current locale, the wcsxfrm_l() function may be passed a locale directly. See xlocale(3) for more information. RETURN VALUES
Upon successful completion, wcsxfrm() returns the length of the transformed string not including the terminating null character. If this value is n or more, the contents of ws1 are indeterminate. SEE ALSO
setlocale(3), strxfrm(3), wcscmp(3), wcscoll(3), xlocale(3) STANDARDS
The wcsxfrm() function conforms to ISO/IEC 9899:1999 (``ISO C99''). BUGS
The current implementation of wcsxfrm() only works in single-byte LC_CTYPE locales, and falls back to using wcsncpy() in locales with extended character sets. Comparing two strings using wcscmp() after wcsxfrm() is not always equivalent to comparison with wcscoll(); wcsxfrm() only stores information about primary collation weights into ws1, whereas wcscoll() compares characters using both primary and secondary weights. BSD
October 4, 2002 BSD

Check Out this Related Man Page

wcsxfrm(3C)						   Standard C Library Functions 					       wcsxfrm(3C)

NAME
wcsxfrm, wsxfrm - wide character string transformation SYNOPSIS
#include <wchar.h> size_t wcsxfrm(wchar_t *ws1, const wchar_t *ws2, size_t n); size_t wsxfrm(wchar_t *ws1, const wchar_t *ws2, size_t n); DESCRIPTION
The wcsxfrm() and wcsxfrm() functions transform the wide character string pointed to by ws2 and place the resulting wide character string into the array pointed to by ws1. The transformation is such that if either the wcscmp(3C) or wscmp(3C) functions are applied to two trans- formed wide strings, they return a value greater than, equal to, or less than 0, corresponding to the result of the wcscoll(3C) or wscoll(3C) function applied to the same two original wide character strings. No more than n wide-character codes are placed into the resulting array pointed to by ws1, including the terminating null wide-character code. If n is 0, ws1 is permitted to be a null pointer. If copying takes place between objects that overlap, the behavior is undefined. The wcsxfrm() and wsxfrm() functions do not change the setting of errno if successful. Since no return value is reserved to indicate an error, an application wishing to check for error situations should set errno to 0, then call wcsxfrm() or wsxfrm(), then check errno. RETURN VALUES
The wcsxfrm() and wsxfrm() functions return the length of the transformed wide character string (not including the terminating null wide- character code). If the value returned is n or more, the contents of the array pointed to by ws1 are indeterminate. On error, wcsxfrm() and wsxfrm() may set errno but no return value is reserved to indicate an error. ERRORS
The wcsxfrm() and wsxfrm() functions may fail if: EINVAL The wide character string pointed to by ws2 contains wide-character codes outside the domain of the collating sequence. USAGE
The transformation function is such that two transformed wide character strings can be ordered by the wcscmp() or wscmp() functions as appropriate to collating sequence information in the program's locale (category LC_COLLATE). The fact that when n is 0, ws1 is permitted to be a null pointer, is useful to determine the size of the ws1 array prior to making the transformation. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |CSI |Enabled | +-----------------------------+-----------------------------+ |Interface Stability |wcsxfrm() is Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe with exceptions | +-----------------------------+-----------------------------+ The wcsxfrm() and wsxfrm() functions can be used safely in multithreaded applications as long as setlocale(3C) is not being called to change the locale. SEE ALSO
setlocale(3C), wcscmp(3C), wcscoll(3C), wscmp(3C), wscoll(3C), attributes(5), standards(5) SunOS 5.10 1 Nov 2003 wcsxfrm(3C)
Man Page