Content-type: text/html Man page of towctrans

towctrans

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

towctrans - Converts a wide character according to a property defined in the current locale  

LIBRARY

Standard C Library (libc.so, 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


 

Index

NAME
LIBRARY
SYNOPSIS
STANDARDS
PARAMETERS
DESCRIPTION
RESTRICTIONS
EXAMPLES
RETURN VALUES
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:42:17 GMT, October 02, 2010