towctrans (3p) - Linux Manuals

towctrans: wide-character transliteration

PROLOG

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

NAME

towctrans - wide-character transliteration

SYNOPSIS

#include <wctype.h>

wint_t towctrans(wint_t wc, wctrans_t desc);

DESCRIPTION

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. 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

desc contains an invalid transliteration descriptor.

The following sections are informative.

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.

COPYRIGHT

Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .