Files
oldlinux-files/Ref-docs/POSIX/susv3/functions/towctrans.html
2024-02-19 00:21:47 -05:00

145 lines
5.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>towctrans</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="towctrans"></a> <a name="tag_03_786"></a><!-- towctrans -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_786_01"></a>NAME</h4>
<blockquote>towctrans - wide-character transliteration</blockquote>
<h4><a name="tag_03_786_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<p><code><tt>#include &lt;<a href="../basedefs/wctype.h.html">wctype.h</a>&gt;<br>
<br>
wint_t towctrans(wint_t</tt> <i>wc</i><tt>, wctrans_t</tt> <i>desc</i><tt>);<br>
</tt></code></p>
</blockquote>
<h4><a name="tag_03_786_03"></a>DESCRIPTION</h4>
<blockquote>
<div class="box"><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]"
border="0"> The functionality described on this reference page is aligned with the ISO&nbsp;C standard. Any conflict between the
requirements described here and the ISO&nbsp;C standard is unintentional. This volume of IEEE&nbsp;Std&nbsp;1003.1-2001 defers to
the ISO&nbsp;C standard. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></div>
<p>The <i>towctrans</i>() function shall transliterate the wide-character code <i>wc</i> using the mapping described by
<i>desc</i>. The current setting of the <i>LC_CTYPE</i> category should be the same as during the call to <a href=
"../functions/wctrans.html"><i>wctrans</i>()</a> that returned the value <i>desc</i>. <sup>[<a href=
"javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0"> &nbsp;If the value
of <i>desc</i> is invalid (that is, not obtained by a call to <a href="../functions/wctrans.html"><i>wctrans</i>()</a> or
<i>desc</i> is invalidated by a subsequent call to <a href="../functions/setlocale.html"><i>setlocale</i>()</a> that has affected
category <i>LC_CTYPE ),</i> the result is unspecified.</p>
<p>An application wishing to check for error situations should set <i>errno</i> to 0 before calling <i>towctrans</i>(). If
<i>errno</i> is non-zero on return, an error has occurred. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></p>
</blockquote>
<h4><a name="tag_03_786_04"></a>RETURN VALUE</h4>
<blockquote>
<p>If successful, the <i>towctrans</i>() function shall return the mapped value of <i>wc</i> using the mapping described by
<i>desc</i>. Otherwise, it shall return <i>wc</i> unchanged.</p>
</blockquote>
<h4><a name="tag_03_786_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>towctrans</i>() function may fail if:</p>
<dl compact>
<dt>[EINVAL]</dt>
<dd><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
<i>desc</i> contains an invalid transliteration descriptor. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_786_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_786_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>The strings <tt>"tolower"</tt> and <tt>"toupper"</tt> 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.</p>
<pre>
<tt>towlower(</tt><i>wc</i><tt>) towctrans(</tt><i>wc</i><tt>, wctrans("tolower"))
towupper(</tt><i>wc</i><tt>) towctrans(</tt><i>wc</i><tt>, wctrans("toupper"))
</tt>
</pre>
</blockquote>
<h4><a name="tag_03_786_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_786_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_786_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="towlower.html"><i>towlower</i>()</a> , <a href="towupper.html"><i>towupper</i>()</a> , <a href=
"wctrans.html"><i>wctrans</i>()</a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/wctype.h.html"><i>&lt;wctype.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_786_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 5. Derived from ISO/IEC&nbsp;9899:1990/Amendment 1:1995 (E).</p>
</blockquote>
<h4><a name="tag_03_786_12"></a>Issue 6</h4>
<blockquote>
<p>Extensions beyond the ISO&nbsp;C standard are marked.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>