ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / curs_in_wchstr.3x.html
1 <!--
2   ****************************************************************************
3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
4   * Copyright 2002-2012,2017 Free Software Foundation, Inc.                  *
5   *                                                                          *
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:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
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.                               *
24   *                                                                          *
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       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: curs_in_wchstr.3x,v 1.14 2020/10/17 23:19:44 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_in_wchstr 3X</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_in_wchstr 3X</H1>
43 <PRE>
44 <B><A HREF="curs_in_wchstr.3X.html">curs_in_wchstr(3X)</A></B>                                          <B><A HREF="curs_in_wchstr.3X.html">curs_in_wchstr(3X)</A></B>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <B>in_wchstr</B>, <B>in_wchnstr</B>, <B>win_wchstr</B>, <B>win_wchnstr</B>, <B>mvin_wchstr</B>,
51        <B>mvin_wchnstr</B>, <B>mvwin_wchstr</B>, <B>mvwin_wchnstr</B> - get an array of complex
52        characters and renditions from a curses window
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <B>#include</B> <B>&lt;curses.h&gt;</B>
57
58        <B>int</B> <B>in_wchstr(cchar_t</B> <B>*</B><I>wchstr</I><B>);</B>
59        <B>int</B> <B>in_wchnstr(cchar_t</B> <B>*</B><I>wchstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
60        <B>int</B> <B>win_wchstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>cchar_t</B> <B>*</B><I>wchstr</I><B>);</B>
61        <B>int</B> <B>win_wchnstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>cchar_t</B> <B>*</B><I>wchstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
62
63        <B>int</B> <B>mvin_wchstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>cchar_t</B> <B>*</B><I>wchstr</I><B>);</B>
64        <B>int</B> <B>mvin_wchnstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>cchar_t</B> <B>*</B><I>wchstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
65        <B>int</B> <B>mvwin_wchstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>cchar_t</B> <B>*</B><I>wchstr</I><B>);</B>
66        <B>int</B> <B>mvwin_wchnstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>cchar_t</B> <B>*</B><I>wchstr</I>, int <I>n</I><B>);</B>
67
68
69 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
70        These functions return an array of complex characters in <I>wchstr</I>, start-
71        ing at the current cursor position in  the  named  window.   Attributes
72        (rendition) are stored with the characters.
73
74        The  <B>in_wchnstr</B>,  <B>mvin_wchnstr</B>,  <B>mvwin_wchnstr</B> and <B>win_wchnstr</B> fill the
75        array with at most <I>n</I> <B>cchar_t</B> elements.
76
77
78 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
79        Note that all routines except <B>win_wchnstr</B> may be macros.
80
81        Reading a line that overflows the  array  pointed  to  by  <I>wchstr</I>  with
82        <B>in_wchstr</B>, <B>mvin_wchstr</B>, <B>mvwin_wchstr</B> or <B>win_wchstr</B> causes undefined re-
83        sults.  Therefore, the use of <B>in_wchnstr</B>, <B>mvin_wchnstr</B>,  <B>mvwin_wchnstr</B>,
84        or <B>win_wchnstr</B> is recommended.
85
86
87 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
88        Upon successful completion, these functions return <B>OK</B>.  Otherwise, they
89        return <B>ERR</B>.
90
91        Functions with a "mv" prefix first  perform  a  cursor  movement  using
92        <B>wmove</B>, and return an error if the position is outside the window, or if
93        the window pointer is null.
94
95
96 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
97        The XSI Curses defines no error conditions.  This implementation checks
98        for null pointers, returning <B>ERR</B> in that case.
99
100
101 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
102        Functions: <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_in_wch.3X.html">curs_in_wch(3X)</A></B>, <B><A HREF="curs_instr.3X.html">curs_instr(3X)</A></B>, <B><A HREF="curs_inwstr.3X.html">curs_inwstr(3X)</A></B>
103        <B><A HREF="curs_inchstr.3X.html">curs_inchstr(3X)</A></B>
104
105
106
107                                                             <B><A HREF="curs_in_wchstr.3X.html">curs_in_wchstr(3X)</A></B>
108 </PRE>
109 <div class="nav">
110 <ul>
111 <li><a href="#h2-NAME">NAME</a></li>
112 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
113 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
114 <li><a href="#h2-NOTES">NOTES</a></li>
115 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
116 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
117 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
118 </ul>
119 </div>
120 </BODY>
121 </HTML>