<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 2001-2003,2006 Free Software Foundation, Inc. *
+ * Copyright (c) 2001-2006,2008 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_getcchar.3x,v 1.10 2006/12/24 16:00:02 tom Exp @
+ * @Id: curs_getcchar.3x,v 1.11 2008/05/17 19:37:05 tom Exp @
-->
<HTML>
<HEAD>
- The wide-character string pointed to by <EM>wch</EM>. The
string must be L'\0' terminated, contain at most one
- character with strictly positive width, which must be
- the first, and contain no characters of negative
- width.
+ spacing character, which must be the first.
+
+ Up to <STRONG>CCHARW_MAX</STRONG>-1 nonspacing characters may follow.
+ Additional nonspacing characters are ignored.
+
+ The string may contain a single control character
+ instead. In that case, no nonspacing characters are
+ allowed.
</PRE>
<H2>NOTES</H2><PRE>
- The <EM>opts</EM> argument is reserved for future use. Currently,
+ The <EM>opts</EM> argument is reserved for future use. Currently,
an application must provide a null pointer as <EM>opts</EM>.
- The <EM>wcval</EM> argument may be a value generated by a call to
- <STRONG>setcchar</STRONG> or by a function that has a <STRONG>cchar_t</STRONG> output argu-
- ment. If <EM>wcval</EM> is constructed by any other means, the
+ The <EM>wcval</EM> argument may be a value generated by a call to
+ <STRONG>setcchar</STRONG> or by a function that has a <STRONG>cchar_t</STRONG> output argu-
+ ment. If <EM>wcval</EM> is constructed by any other means, the
effect is unspecified.
When <EM>wch</EM> is a null pointer, <STRONG>getcchar</STRONG> returns the number of
wide characters referenced by <EM>wcval</EM>.
- When <EM>wch</EM> is not a null pointer, <STRONG>getcchar</STRONG> returns <STRONG>OK</STRONG> upon
+ When <EM>wch</EM> is not a null pointer, <STRONG>getcchar</STRONG> returns <STRONG>OK</STRONG> upon
successful completion, and <STRONG>ERR</STRONG> otherwise.
- Upon successful completion, <STRONG>setcchar</STRONG> returns <STRONG>OK</STRONG>. Other-
+ Upon successful completion, <STRONG>setcchar</STRONG> returns <STRONG>OK</STRONG>. Other-
wise, it returns <STRONG>ERR</STRONG>.
</PRE>
<H2>SEE ALSO</H2><PRE>
- Functions: <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,
+ Functions: <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,
<STRONG><A HREF="wcwidth.3.html">wcwidth(3)</A></STRONG>.