ncurses 5.9 - patch 20150214
[ncurses.git] / doc / html / man / curs_in_wch.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 2002-2006,2010 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_in_wch.3x,v 1.5 2010/12/04 18:36:44 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_in_wch 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_in_wch 3x</H1>
42 <HR>
43 <PRE>
44 <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>                                         <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>in_wch</STRONG>,  <STRONG>mvin_wch</STRONG>,  <STRONG>mvwin_wch</STRONG>, <STRONG>win_wch</STRONG> - extract a complex
52        character and rendition from a window
53
54
55 </PRE>
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
59        <STRONG>int</STRONG> <STRONG>in_wch(cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG>
60        <STRONG>int</STRONG> <STRONG>mvin_wch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG>
61        <STRONG>int</STRONG> <STRONG>mvwin_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG>
62        <STRONG>int</STRONG> <STRONG>win_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG>
63
64
65 </PRE>
66 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67        These functions extract the complex character  and  rendi-
68        tion  from  the  current position in the named window into
69        the <STRONG>cchar_t</STRONG> object referenced by wcval.
70
71
72 </PRE>
73 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
74        No errors are defined in the XSI  Curses  standard.   This
75        implementation  checks  for  null pointers, returns ERR in
76        that case.  Also, the <EM>mv</EM> routines check for  error  moving
77        the  cursor,  returning  ERR in that case.  Otherwise they
78        return OK
79
80        Functions with a "mv" prefix first perform a cursor  move-
81        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
82        outside the window, or if the window pointer is null.
83
84
85 </PRE>
86 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
87        Note that all of these routines may be macros.
88
89
90 </PRE>
91 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
92        These functions are described in the XSI Curses  standard,
93        Issue 4.
94
95
96 </PRE>
97 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
98        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>.
99
100
101
102                                                         <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
103 </PRE>
104 <div class="nav">
105 <ul>
106 <li><a href="#h2-NAME">NAME</a></li>
107 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
108 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
109 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
110 <li><a href="#h2-NOTES">NOTES</a></li>
111 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
112 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
113 </ul>
114 </div>
115 </BODY>
116 </HTML>