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

134 lines
5.1 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>wctrans</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="wctrans"></a> <a name="tag_03_856"></a><!-- wctrans -->
<!--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_856_01"></a>NAME</h4>
<blockquote>wctrans - define character mapping</blockquote>
<h4><a name="tag_03_856_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<p><code><tt>#include &lt;<a href="../basedefs/wctype.h.html">wctype.h</a>&gt;<br>
<br>
wctrans_t wctrans(const char *</tt><i>charclass</i><tt>);<br>
</tt></code></p>
</blockquote>
<h4><a name="tag_03_856_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>wctrans</i>() function is defined for valid character mapping names identified in the current locale. The
<i>charclass</i> 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: <b>tolower</b> and <b>toupper</b>.</p>
<p>The function shall return a value of type <b>wctrans_t</b>, which can be used as the second argument to subsequent calls of <a
href="../functions/towctrans.html"><i>towctrans</i>()</a>. The <i>wctrans</i>() function shall determine values of <b>wctrans_t</b>
according to the rules of the coded character set defined by character mapping information in the program's locale (category
<i>LC_CTYPE ).</i> The values returned by <i>wctrans</i>() shall be valid until a call to <a href=
"../functions/setlocale.html"><i>setlocale</i>()</a> that modifies the category <i>LC_CTYPE .</i></p>
</blockquote>
<h4><a name="tag_03_856_04"></a>RETURN VALUE</h4>
<blockquote>
<p>The <i>wctrans</i>() function shall return 0 <sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src=
"../images/opt-start.gif" alt="[Option Start]" border="0"> &nbsp;and may set <i>errno</i> to indicate the error <img src=
"../images/opt-end.gif" alt="[Option End]" border="0"> &nbsp;if the given character mapping name is not valid for the current
locale (category <i>LC_CTYPE );</i> otherwise, it shall return a non-zero object of type <b>wctrans_t</b> that can be used in calls
to <a href="../functions/towctrans.html"><i>towctrans</i>()</a>.</p>
</blockquote>
<h4><a name="tag_03_856_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>wctrans</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">
The character mapping name pointed to by <i>charclass</i> is not valid in the current locale. <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_856_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_856_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_856_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_856_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_856_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="towctrans.html"><i>towctrans</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_856_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>
<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>