ncurses 5.9 - patch 20150214
[ncurses.git] / doc / html / man / curs_getcchar.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 2001-2010,2012 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_getcchar.3x,v 1.16 2012/11/03 23:03:59 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_getcchar 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1>curs_getcchar 3x</H1>
42 <HR>
43 <PRE>
44 <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG>                                     <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>getcchar</STRONG>,  <STRONG>setcchar</STRONG> - Get a wide character string and ren-
52        dition from a <STRONG>cchar_t</STRONG> or set a <STRONG>cchar_t</STRONG> from a wide-charac-
53        ter string
54
55
56 </PRE>
57 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
58        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
59
60        <STRONG>int</STRONG> <STRONG>getcchar(</STRONG>
61                <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>,</STRONG>
62                <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG>
63                <STRONG>attr_t</STRONG> <STRONG>*</STRONG><EM>attrs</EM><STRONG>,</STRONG>
64                <STRONG>short</STRONG> <STRONG>*</STRONG><EM>color</EM><STRONG>_</STRONG><EM>pair</EM><STRONG>,</STRONG>
65                <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM> <STRONG>);</STRONG>
66
67        <STRONG>int</STRONG> <STRONG>setcchar(</STRONG>
68                <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>,</STRONG>
69                <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG>
70                <STRONG>const</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG>
71                <STRONG>short</STRONG> <EM>color</EM><STRONG>_</STRONG><EM>pair</EM><STRONG>,</STRONG>
72                <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM> <STRONG>);</STRONG>
73
74
75 </PRE>
76 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
77        The  <STRONG>getcchar</STRONG>  function  gets  a wide-character string and
78        rendition from a <STRONG>cchar_t</STRONG> argument.  When <EM>wch</EM> is not a null
79        pointer, the <STRONG>getcchar</STRONG> function does the following:
80
81        <STRONG>o</STRONG>   Extracts information from a <STRONG>cchar_t</STRONG> value <EM>wcval</EM>
82
83        <STRONG>o</STRONG>   Stores   the  character  attributes  in  the  location
84            pointed to by <EM>attrs</EM>
85
86        <STRONG>o</STRONG>   Stores the color-pair in the location  pointed  to  by
87            <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
88
89        <STRONG>o</STRONG>   Stores  the  wide-character  string, characters refer-
90            enced by <EM>wcval</EM>, into the array pointed to by <EM>wch</EM>.
91
92        When <EM>wch</EM> is a null pointer, the <STRONG>getcchar</STRONG> function does the
93        following:
94
95        <STRONG>o</STRONG>   Obtains  the  number  of wide characters pointed to by
96            <EM>wcval</EM>
97
98        <STRONG>o</STRONG>   Does not  change  the  data  referenced  by  <EM>attrs</EM>  or
99            <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
100
101        The  <STRONG>setcchar</STRONG> function initializes the location pointed to
102        by <EM>wcval</EM> by using:
103
104        <STRONG>o</STRONG>   The character attributes in <EM>attrs</EM>
105
106        <STRONG>o</STRONG>   The color pair in <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
107
108        <STRONG>o</STRONG>   The wide-character string  pointed  to  by  <EM>wch</EM>.   The
109            string  must  be L'\0' terminated, contain at most one
110            spacing character, which must be the first.
111
112            Up to <STRONG>CCHARW_MAX</STRONG>-1 nonspacing characters  may  follow.
113            Additional nonspacing characters are ignored.
114
115            The  string  may  contain  a  single control character
116            instead.  In that case, no nonspacing  characters  are
117            allowed.
118
119
120 </PRE>
121 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
122        The  <EM>opts</EM> argument is reserved for future use.  Currently,
123        an application must provide a null pointer as <EM>opts</EM>.
124
125        The <EM>wcval</EM> argument may be a value generated by a  call  to
126        <STRONG>setcchar</STRONG>  or by a function that has a <STRONG>cchar_t</STRONG> output argu-
127        ment.  If <EM>wcval</EM> is constructed by  any  other  means,  the
128        effect is unspecified.
129
130
131 </PRE>
132 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
133        When <EM>wch</EM> is a null pointer, <STRONG>getcchar</STRONG> returns the number of
134        wide characters referenced by <EM>wcval</EM>, including one  for  a
135        trailing null.
136
137        When  <EM>wch</EM>  is not a null pointer, <STRONG>getcchar</STRONG> returns <STRONG>OK</STRONG> upon
138        successful completion, and <STRONG>ERR</STRONG> otherwise.
139
140        Upon successful completion, <STRONG>setcchar</STRONG> returns  <STRONG>OK</STRONG>.   Other-
141        wise, it returns <STRONG>ERR</STRONG>.
142
143
144 </PRE>
145 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
146        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>,
147        <STRONG>wcwidth(3)</STRONG>.
148
149
150
151                                                       <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG>
152 </PRE>
153 <div class="nav">
154 <ul>
155 <li><a href="#h2-NAME">NAME</a></li>
156 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
157 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
158 <li><a href="#h2-NOTES">NOTES</a></li>
159 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
160 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
161 </ul>
162 </div>
163 </BODY>
164 </HTML>