ncurses 5.3
[ncurses.git] / doc / html / man / wresize.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998,2002 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   * Author: Thomas E. Dickey &lt;dickey@clark.net&gt; 1996
31   * @Id: wresize.3x,v 1.7 2002/02/16 22:40:59 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>wresize 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>wresize 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>wresize</STRONG> - resize a curses window
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
53
54        <STRONG>int</STRONG> <STRONG>wresize(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
55
56
57 </PRE>
58 <H2>DESCRIPTION</H2><PRE>
59        The  <STRONG>wresize</STRONG>  function  reallocates storage for an <STRONG>ncurses</STRONG>
60        window to adjust its dimensions to the  specified  values.
61        If either dimension is larger than the current values, the
62        window's data is filled with blanks that have the  current
63        background  rendition  (as  set  by <STRONG>wbkgndset</STRONG>) merged into
64        them.
65
66
67 </PRE>
68 <H2>RETURN VALUE</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>
76 <H2>NOTES</H2><PRE>
77        The only restriction placed on the dimensions is that they
78        be greater than zero.  The dimensions are not compared  to
79        <STRONG>curses</STRONG>   screen   dimensions  to  simplify  the  logic  of
80        <STRONG>resizeterm</STRONG>.  The caller  must  ensure  that  the  window's
81        dimensions fit within the actual screen dimensions.
82
83
84 </PRE>
85 <H2>SEE ALSO</H2><PRE>
86        <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>.
87
88
89 </PRE>
90 <H2>AUTHOR</H2><PRE>
91        Thomas Dickey (from an equivalent function written in 1988
92        for BSD curses).
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112 </PRE>
113 <HR>
114 <ADDRESS>
115 Man(1) output converted with
116 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
117 </ADDRESS>
118 </BODY>
119 </HTML>