2013-05-19 08:22:02 +08:00
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
|
2002-10-13 11:35:53 +08:00
|
|
|
<!--
|
|
|
|
****************************************************************************
|
2013-03-10 08:35:23 +08:00
|
|
|
* Copyright (c) 2001-2010,2012 Free Software Foundation, Inc. *
|
2002-10-13 11:35:53 +08:00
|
|
|
* *
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a *
|
|
|
|
* copy of this software and associated documentation files (the *
|
|
|
|
* "Software"), to deal in the Software without restriction, including *
|
|
|
|
* without limitation the rights to use, copy, modify, merge, publish, *
|
|
|
|
* distribute, distribute with modifications, sublicense, and/or sell *
|
|
|
|
* copies of the Software, and to permit persons to whom the Software is *
|
|
|
|
* furnished to do so, subject to the following conditions: *
|
|
|
|
* *
|
|
|
|
* The above copyright notice and this permission notice shall be included *
|
|
|
|
* in all copies or substantial portions of the Software. *
|
|
|
|
* *
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
|
|
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
|
|
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
|
|
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
|
|
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
|
|
* *
|
|
|
|
* Except as contained in this notice, the name(s) of the above copyright *
|
|
|
|
* holders shall not be used in advertising or otherwise to promote the *
|
|
|
|
* sale, use or other dealings in this Software without prior written *
|
|
|
|
* authorization. *
|
|
|
|
****************************************************************************
|
2013-03-10 08:35:23 +08:00
|
|
|
* @Id: curs_getcchar.3x,v 1.16 2012/11/03 23:03:59 tom Exp @
|
2002-10-13 11:35:53 +08:00
|
|
|
-->
|
|
|
|
<HTML>
|
|
|
|
<HEAD>
|
|
|
|
<TITLE>curs_getcchar 3x</TITLE>
|
|
|
|
<link rev=made href="mailto:bug-ncurses@gnu.org">
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
|
|
</HEAD>
|
|
|
|
<BODY>
|
|
|
|
<H1>curs_getcchar 3x</H1>
|
|
|
|
<HR>
|
|
|
|
<PRE>
|
|
|
|
<!-- Manpage converted by man2html 3.0.1 -->
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG>
|
2004-02-09 10:15:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
|
|
|
|
</PRE>
|
|
|
|
<H2>NAME</H2><PRE>
|
|
|
|
<STRONG>getcchar</STRONG>, <STRONG>setcchar</STRONG> - Get a wide character string and ren-
|
|
|
|
dition from a <STRONG>cchar_t</STRONG> or set a <STRONG>cchar_t</STRONG> from a wide-charac-
|
|
|
|
ter string
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
<H2>SYNOPSIS</H2><PRE>
|
|
|
|
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
|
|
|
|
|
|
|
<STRONG>int</STRONG> <STRONG>getcchar(</STRONG>
|
|
|
|
<STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>,</STRONG>
|
|
|
|
<STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG>
|
|
|
|
<STRONG>attr_t</STRONG> <STRONG>*</STRONG><EM>attrs</EM><STRONG>,</STRONG>
|
|
|
|
<STRONG>short</STRONG> <STRONG>*</STRONG><EM>color</EM><STRONG>_</STRONG><EM>pair</EM><STRONG>,</STRONG>
|
|
|
|
<STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM> <STRONG>);</STRONG>
|
|
|
|
|
|
|
|
<STRONG>int</STRONG> <STRONG>setcchar(</STRONG>
|
|
|
|
<STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>,</STRONG>
|
|
|
|
<STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG>
|
|
|
|
<STRONG>const</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG>
|
|
|
|
<STRONG>short</STRONG> <EM>color</EM><STRONG>_</STRONG><EM>pair</EM><STRONG>,</STRONG>
|
|
|
|
<STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM> <STRONG>);</STRONG>
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
<H2>DESCRIPTION</H2><PRE>
|
|
|
|
The <STRONG>getcchar</STRONG> function gets a wide-character string and
|
|
|
|
rendition from a <STRONG>cchar_t</STRONG> argument. When <EM>wch</EM> is not a null
|
|
|
|
pointer, the <STRONG>getcchar</STRONG> function does the following:
|
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
<STRONG>o</STRONG> Extracts information from a <STRONG>cchar_t</STRONG> value <EM>wcval</EM>
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
<STRONG>o</STRONG> Stores the character attributes in the location
|
|
|
|
pointed to by <EM>attrs</EM>
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
<STRONG>o</STRONG> Stores the color-pair in the location pointed to by
|
|
|
|
<EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
<STRONG>o</STRONG> Stores the wide-character string, characters refer-
|
|
|
|
enced by <EM>wcval</EM>, into the array pointed to by <EM>wch</EM>.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
|
|
|
When <EM>wch</EM> is a null pointer, the <STRONG>getcchar</STRONG> function does the
|
|
|
|
following:
|
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
<STRONG>o</STRONG> Obtains the number of wide characters pointed to by
|
|
|
|
<EM>wcval</EM>
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
<STRONG>o</STRONG> Does not change the data referenced by <EM>attrs</EM> or
|
|
|
|
<EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
|
2002-10-13 11:35:53 +08:00
|
|
|
|
|
|
|
The <STRONG>setcchar</STRONG> function initializes the location pointed to
|
|
|
|
by <EM>wcval</EM> by using:
|
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
<STRONG>o</STRONG> The character attributes in <EM>attrs</EM>
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
<STRONG>o</STRONG> The color pair in <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
<STRONG>o</STRONG> The wide-character string pointed to by <EM>wch</EM>. The
|
|
|
|
string must be L'\0' terminated, contain at most one
|
|
|
|
spacing character, which must be the first.
|
2008-06-22 08:16:39 +08:00
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
Up to <STRONG>CCHARW_MAX</STRONG>-1 nonspacing characters may follow.
|
|
|
|
Additional nonspacing characters are ignored.
|
2008-06-22 08:16:39 +08:00
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
The string may contain a single control character
|
|
|
|
instead. In that case, no nonspacing characters are
|
|
|
|
allowed.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
<H2>NOTES</H2><PRE>
|
2008-06-22 08:16:39 +08:00
|
|
|
The <EM>opts</EM> argument is reserved for future use. Currently,
|
2002-10-13 11:35:53 +08:00
|
|
|
an application must provide a null pointer as <EM>opts</EM>.
|
|
|
|
|
2008-06-22 08:16:39 +08:00
|
|
|
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
|
2002-10-13 11:35:53 +08:00
|
|
|
effect is unspecified.
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2013-03-10 08:35:23 +08:00
|
|
|
<H2>RETURN VALUE</H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
When <EM>wch</EM> is a null pointer, <STRONG>getcchar</STRONG> returns the number of
|
2010-01-10 09:50:23 +08:00
|
|
|
wide characters referenced by <EM>wcval</EM>, including one for a
|
|
|
|
trailing null.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2010-01-10 09:50:23 +08:00
|
|
|
When <EM>wch</EM> is not a null pointer, <STRONG>getcchar</STRONG> returns <STRONG>OK</STRONG> upon
|
2002-10-13 11:35:53 +08:00
|
|
|
successful completion, and <STRONG>ERR</STRONG> otherwise.
|
|
|
|
|
2010-01-10 09:50:23 +08:00
|
|
|
Upon successful completion, <STRONG>setcchar</STRONG> returns <STRONG>OK</STRONG>. Other-
|
2002-10-13 11:35:53 +08:00
|
|
|
wise, it returns <STRONG>ERR</STRONG>.
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
<H2>SEE ALSO</H2><PRE>
|
2010-01-10 09:50:23 +08:00
|
|
|
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>,
|
2013-12-22 07:12:46 +08:00
|
|
|
<STRONG>wcwidth(3)</STRONG>.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG>
|
2002-10-13 11:35:53 +08:00
|
|
|
</PRE>
|
|
|
|
<HR>
|
2014-12-21 10:25:56 +08:00
|
|
|
Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a>
|
2002-10-13 11:35:53 +08:00
|
|
|
</BODY>
|
|
|
|
</HTML>
|