1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 2001,2002 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: curs_getcchar.3x,v 1.6 2002/03/24 01:08:55 tom Exp @
34 <TITLE>curs_getcchar 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 <H1>curs_getcchar 3x</H1>
42 <!-- Manpage converted by man2html 3.0.1 -->
46 <STRONG>getcchar</STRONG>, <STRONG>setcchar</STRONG> - Get a wide character string and ren-
47 dition from a <STRONG>cchar_t</STRONG> or set a <STRONG>cchar_t</STRONG> from a wide-charac-
52 <H2>SYNOPSIS</H2><PRE>
53 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
55 <STRONG>int</STRONG> <STRONG>getcchar(</STRONG>
56 <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>,</STRONG>
57 <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG>
58 <STRONG>attr_t</STRONG> <STRONG>*</STRONG><EM>attrs</EM><STRONG>,</STRONG>
59 <STRONG>short</STRONG> <STRONG>*</STRONG><EM>color</EM><STRONG>_</STRONG><EM>pair</EM><STRONG>,</STRONG>
60 <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM> <STRONG>);</STRONG>
62 <STRONG>int</STRONG> <STRONG>setcchar(</STRONG>
63 <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>,</STRONG>
64 <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG>
65 <STRONG>const</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG>
66 <STRONG>short</STRONG> <EM>color</EM><STRONG>_</STRONG><EM>pair</EM><STRONG>,</STRONG>
67 <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM> <STRONG>);</STRONG>
71 <H2>DESCRIPTION</H2><PRE>
72 The <STRONG>getcchar</STRONG> function gets a wide-character string and
73 rendition from a <STRONG>cchar_t</STRONG> argument. When <EM>wch</EM> is not a null
74 pointer, the <STRONG>getcchar</STRONG> function does the following:
76 - Extracts information from a <STRONG>cchar_t</STRONG> value <EM>wcval</EM>
78 - Stores the character attributes in the location
79 pointed to by <EM>attrs</EM>
81 - Stores the color-pair in the location pointed to by
82 <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
84 - Stores the wide-character string, characters refer-
85 enced by <EM>wcval</EM>, into the array pointed to by <EM>wch</EM>.
87 When <EM>wch</EM> is a null pointer, the <STRONG>getcchar</STRONG> function does the
90 - Obtains the number of wide characters pointed to by
93 - Does not change the data referenced by <EM>attrs</EM> or
94 <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
96 The <STRONG>setcchar</STRONG> function initializes the location pointed to
97 by <EM>wcval</EM> by using:
99 - The character attributes in <EM>attrs</EM>
101 - The color pair in <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
103 - The wide-character string pointed to by <EM>wch</EM>. The
104 string must be L'\0' terminated, contain at most one
105 character with strictly positive width, which must be
106 the first, and contain no characters of negative
112 The <EM>opts</EM> argument is reserved for future use. Currently,
113 an application must provide a null pointer as <EM>opts</EM>.
115 The <EM>wcval</EM> argument may be a value generated by a call to
116 <STRONG>setcchar</STRONG> or by a function that has a <STRONG>cchar_t</STRONG> output argu-
117 ment. If <EM>wcval</EM> is constructed by any other means, the
118 effect is unspecified.
122 <H2>RETURN VALUES</H2><PRE>
123 When <EM>wch</EM> is a null pointer, <STRONG>getcchar</STRONG> returns the number of
124 wide characters referenced by <EM>wcval</EM>, including the null
127 When <EM>wch</EM> is not a null pointer, <STRONG>getcchar</STRONG> returns <STRONG>OK</STRONG> upon
128 successful completion, and <STRONG>ERR</STRONG> otherwise.
130 Upon successful completion, <STRONG>setcchar</STRONG> returns <STRONG>OK</STRONG>. Other-
131 wise, it returns <STRONG>ERR</STRONG>.
135 <H2>SEE ALSO</H2><PRE>
136 Functions: <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="wcwidth.3x.html">wcwidth(3x)</A></STRONG>, <STRONG><A HREF="curs_attr_get.3x.html">curs_attr_get(3x)</A></STRONG>,
137 <STRONG><A HREF="can_change_color.3x.html">can_change_color(3x)</A></STRONG>.
166 Man(1) output converted with
167 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>