ncurses 5.7 - patch 20100918
[ncurses.git] / doc / html / man / wresize.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998-2006,2010 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 1996
31   * @Id: wresize.3x,v 1.12 2010/08/14 23:12:04 Tim.van.der.Molen 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 <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>
50 <H2>NAME</H2><PRE>
51        <STRONG>wresize</STRONG> - resize a curses window
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>int</STRONG> <STRONG>wresize(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
59
60
61 </PRE>
62 <H2>DESCRIPTION</H2><PRE>
63        This  is  an  extension to the curses library.  It reallo-
64        cates storage for an <STRONG>ncurses</STRONG> window to adjust  its  dimen-
65        sions  to  the  specified  values.  If either dimension is
66        larger than the  current  values,  the  window's  data  is
67        filled with blanks that have the current background rendi-
68        tion (as set by <STRONG>wbkgdset</STRONG>) merged into them.
69
70
71 </PRE>
72 <H2>RETURN VALUE</H2><PRE>
73        The function returns the integer <STRONG>ERR</STRONG> upon failure  and  <STRONG>OK</STRONG>
74        on success.  It will fail if either of the dimensions less
75        than or equal  to  zero,  or  if  an  error  occurs  while
76        (re)allocating memory for the window.
77
78
79 </PRE>
80 <H2>NOTES</H2><PRE>
81        The only restriction placed on the dimensions is that they
82        be greater than zero.  The dimensions are not compared  to
83        <STRONG>curses</STRONG>   screen   dimensions  to  simplify  the  logic  of
84        <STRONG>resizeterm</STRONG>.  The caller  must  ensure  that  the  window's
85        dimensions fit within the actual screen dimensions.
86
87
88 </PRE>
89 <H2>SEE ALSO</H2><PRE>
90        <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>.
91
92
93 </PRE>
94 <H2>AUTHOR</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 <HR>
103 <ADDRESS>
104 Man(1) output converted with
105 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
106 </ADDRESS>
107 </BODY>
108 </HTML>