Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

towctrans(3) [osx man page]

WCTRANS(3)						   BSD Library Functions Manual 						WCTRANS(3)

towctrans, towctrans_l, wctrans, wctrans_l -- wide character mapping functions LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <wctype.h> wint_t towctrans(wint_t wc, wctrans_t desc); wctrans_t wctrans(const char *charclass); #include <wctype.h> #include <xlocale.h> wint_t towctrans_l(wint_t wc, wctrans_t desc, locale_t loc); wctrans_t wctrans_l(const char *charclass, locale_t loc); DESCRIPTION
The wctrans() function returns a value of type wctrans_t, which represents the requested wide character mapping operation and may be used as the second argument for calls to towctrans(). The following character mapping names are recognised: tolower toupper The towctrans() function transliterates the wide character wc, according to the mapping described by desc. While the towctrans() and wctrans() functions use the current locale, the towctrans_l() and wctrans_l() functions may be passed locales directly. See xlocale(3) for more information. RETURN VALUES
The towctrans() function returns the transliterated character if successful, otherwise it returns the character unchanged and sets errno. The wctrans() function returns non-zero if successful, otherwise it returns zero and sets errno. EXAMPLES
Reimplement towupper() in terms of towctrans() and wctrans(): wint_t mytowupper(wint_t wc) { return (towctrans(wc, wctrans("toupper"))); } ERRORS
The towctrans() function will fail if: [EINVAL] The supplied desc argument is invalid. The wctrans() function will fail if: [EINVAL] The requested mapping name is invalid. SEE ALSO
tolower(3), toupper(3), wctype(3), xlocale(3) STANDARDS
The towctrans() and wctrans() functions conform to IEEE Std 1003.1-2001 (``POSIX.1''). HISTORY
The towctrans() and wctrans() functions first appeared in FreeBSD 5.0. BSD
October 3, 2002 BSD

Check Out this Related Man Page

towctrans(3)						     Library Functions Manual						      towctrans(3)

towctrans - Converts a wide character according to a property defined in the current locale LIBRARY
Standard C Library (, libc.a) SYNOPSIS
#include <wctype.h> wint_t towctrans( wint_t wc, wctrans_t conversion_handle ); STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: towctrans(): ISO C Refer to the standards(5) reference page for more information about industry standards and associated tags. PARAMETERS
Specifies a wide-character value Calls the wctrans() function to return the wide character mapped to wc according to a valid property in the LC_CTYPE category of the current locale. DESCRIPTION
The towctrans() function maps a wide character to its counterpart value according to a specified property, for example, tolower or toupper. Before calling towctrans(), you must call wctrans() to determine if the property is valid for the current locale and to create a handle for the property map. You then call towctrans() to return the wide-character value that corresponds to the wide-character value specified by wc. The following example shows a call to towctrans() that returns the lowercase equivalent of wc: towctrans(wc, wctrans("tolower")); The preceding call is equivalent to the following call: towlower(wc); Unlike the towlower() and towupper() functions, which deal specifically with case mapping, the combination of wctrans() and towctrans() functions are designed to be used with other properties that can be defined in a locale. RESTRICTIONS
Currently, tolower and toupper are the only supported property values. Defining additional properties in locales requires an extension to the localedef utility. The rules for implementing this extension are not yet available in current issues of the industry standards that apply to this utility. EXAMPLES
The following example converts the value in from_wc to uppercase: wint_t from_wc, to_wc; wctrans_t conv_handle; . . . conv_handle=wctrans("toupper"); to_wc=towctrans(from_wc,conv_handle); RETURN VALUES
The towctrans() function returns the mapped value of wc according to the mapping described by conversion_handle. If EOF is encountered or conversion_handle cannot be used, the function returns 0 (zero). RELATED INFORMATION
Functions: iswctype(3), towlower(3), wctrans(3), wctype(3) Files: locale(4) delim off towctrans(3)
Man Page

Featured Tech Videos