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

124 lines
4.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>wcwidth</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="wcwidth"></a> <a name="tag_03_858"></a><!-- wcwidth -->
<!--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_858_01"></a>NAME</h4>
<blockquote>wcwidth - number of column positions of a wide-character code</blockquote>
<h4><a name="tag_03_858_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;<a href="../basedefs/wchar.h.html">wchar.h</a>&gt;<br>
<br>
int wcwidth(wchar_t</tt> <i>wc</i><tt>); <img src="../images/opt-end.gif" alt="[Option End]" border="0"></tt></code></div>
<tt><br>
</tt></blockquote>
<h4><a name="tag_03_858_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>wcwidth</i>() function shall determine the number of column positions required for the wide character <i>wc</i>. The
application shall ensure that the value of <i>wc</i> is a character representable as a <b>wchar_t</b>, and is a wide-character code
corresponding to a valid character in the current locale.</p>
</blockquote>
<h4><a name="tag_03_858_04"></a>RETURN VALUE</h4>
<blockquote>
<p>The <i>wcwidth</i>() function shall either return 0 (if <i>wc</i> is a null wide-character code), or return the number of column
positions to be occupied by the wide-character code <i>wc</i>, or return -1 (if <i>wc</i> does not correspond to a printable
wide-character code).</p>
</blockquote>
<h4><a name="tag_03_858_05"></a>ERRORS</h4>
<blockquote>
<p>No errors are defined.</p>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_858_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_858_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>This function was removed from the final ISO/IEC&nbsp;9899:1990/Amendment 1:1995 (E), and the return value for a non-printable
wide character is not specified.</p>
</blockquote>
<h4><a name="tag_03_858_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_858_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_858_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="wcswidth.html"><i>wcswidth</i>()</a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/wchar.h.html"><i>&lt;wchar.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_858_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released as a World-wide Portability Interface in Issue 4. Derived from the MSE working draft.</p>
</blockquote>
<h4><a name="tag_03_858_12"></a>Issue 6</h4>
<blockquote>
<p>The Open Group Corrigendum U021/12 is applied. This function is marked as an extension.</p>
<p>The DESCRIPTION is updated to avoid use of the term &quot;must&quot; for application requirements.</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>