Go to main content

man pages section 3: Basic Library Functions

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wctrans_l(3C)

Name

wctrans, wctrans_l - define character mapping

Synopsis

#include <wctype.h>

wctrans_t wctrans(const char *charclass);
wctrans_t wctrans_l(const char *charclass, locale_t locale);

Description

The wctrans() function is defined for valid character mapping names identified in the current locale. The charclass is a string identifying a generic character mapping name for which codeset-specific information is required. The following character mapping names are defined in all locales − "tolower" and "toupper".

The function returns a value of type wctrans_t, which can be used as the second argument to subsequent calls of towctrans(3C) and towctrans_l(3C). The wctrans() function determines values of wctrans_t according to the rules of the coded character set defined by character mapping information in the current locale (category LC_CTYPE).

The wctrans_l() function is equivalent to the wctrans() function, except that the locale data used is from the locale represented by locale.

The values returned by wctrans() are valid until a call to setlocale(3C) that modifies the category LC_CTYPE.

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

Return Values

The wctrans() and wctrans_l() functions returns 0 if the given character mapping name is not valid for the current locale (category LC_CTYPE), otherwise it returns a non-zero object of type wctrans_t that can be used in calls to towctrans(3C) and towctrans_l(3C).

Errors

These functions may fail if:

EINVAL

The character mapping name pointed to by charclass is not valid in the current locale or in the locale represented by locale.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
CSI
Enabled
Interface Stability
Committed
MT-Level
MT-Safe
Standard

See Also

duplocale(3C), freelocale(3C), newlocale(3C), setlocale(3C), towctrans(3C), uselocale(3C), attributes(7), standards(7)