NAME

towctrans - wide-character transliteration

SYNOPSIS

#include <wctype.h>

wint_t towctrans(wint_t wc, wctrans_t desc);


DESCRIPTION

^[CX] The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of IEEE Std 1003.1-2001 defers to the ISO C standard.

The towctrans() function shall transliterate the wide-character code wc using the mapping described by desc. The current setting of the LC_CTYPE category should be the same as during the call to wctrans() that returned the value desc. ^[CX]  If the value of desc is invalid (that is, not obtained by a call to wctrans() or desc is invalidated by a subsequent call to setlocale() that has affected category LC_CTYPE ), the result is unspecified.

An application wishing to check for error situations should set errno to 0 before calling towctrans(). If errno is non-zero on return, an error has occurred.

RETURN VALUE

If successful, the towctrans() function shall return the mapped value of wc using the mapping described by desc. Otherwise, it shall return wc unchanged.

ERRORS

The towctrans() function may fail if:

[EINVAL]

^[CX] desc contains an invalid transliteration descriptor.

EXAMPLES

None.

APPLICATION USAGE

The strings "tolower" and "toupper" are reserved for the standard mapping names. In the table below, the functions in the left column are equivalent to the functions in the right column.

towlower(wc)    towctrans(wc, wctrans("tolower"))
towupper(wc)    towctrans(wc, wctrans("toupper"))

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

towlower() , towupper() , wctrans() , the Base Definitions volume of IEEE Std 1003.1-2001, <wctype.h>

CHANGE HISTORY

First released in Issue 5. Derived from ISO/IEC 9899:1990/Amendment 1:1995 (E).

Issue 6

Extensions beyond the ISO C standard are marked.