ncurses 6.0 - patch 20170401
[ncurses.git] / doc / html / man / wresize.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2010,2015 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   * Author: Thomas E. Dickey 1996
30   * @Id: wresize.3x,v 1.14 2015/09/26 19:57:24 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 http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>wresize 3x</TITLE>
38 <link rev=made 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">wresize 3x</H1>
43 <PRE>
44 <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>                                                 <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>wresize</STRONG> - resize a curses window
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>int</STRONG> <STRONG>wresize(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60        This  is  an  extension to the curses library.  It reallo-
61        cates storage for an <STRONG>ncurses</STRONG> window to adjust  its  dimen-
62        sions  to  the  specified  values.  If either dimension is
63        larger than the  current  values,  the  window's  data  is
64        filled with blanks that have the current background rendi-
65        tion (as set by <STRONG>wbkgdset</STRONG>) merged into them.
66
67
68 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
69        The function returns the integer <STRONG>ERR</STRONG> upon failure  and  <STRONG>OK</STRONG>
70        on success.  It will fail if either of the dimensions less
71        than or equal  to  zero,  or  if  an  error  occurs  while
72        (re)allocating memory for the window.
73
74
75 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
76        The only restriction placed on the dimensions is that they
77        be greater than zero.  The dimensions are not compared  to
78        <STRONG>curses</STRONG>   screen   dimensions  to  simplify  the  logic  of
79        <STRONG>resizeterm</STRONG>.  The caller  must  ensure  that  the  window's
80        dimensions fit within the actual screen dimensions.
81
82
83 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
84        It is not possible to resize windows with SVr4 curses.
85
86        This  extension of ncurses was introduced in mid-1995.  It
87        was adopted in NetBSD curses (2001) and PDCurses (2003).
88
89
90 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
91        <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>.
92
93
94 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
95        Thomas Dickey (from an equivalent function written in 1988
96        for BSD curses).
97
98
99
100                                                             <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>
101 </PRE>
102 <div class="nav">
103 <ul>
104 <li><a href="#h2-NAME">NAME</a></li>
105 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
106 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
107 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
108 <li><a href="#h2-NOTES">NOTES</a></li>
109 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
110 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
111 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
112 </ul>
113 </div>
114 </BODY>
115 </HTML>