ncurses 5.1
[ncurses.git] / doc / html / man / wresize.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>wresize</B> - resize a curses window
9
10
11 </PRE>
12 <H2>SYNOPSIS</H2><PRE>
13        <B>#include</B> <B>&lt;curses.h&gt;</B>
14
15        <B>int</B> <B>wresize(WINDOW</B> <B>*win,</B> <B>int</B> <B>lines,</B> <B>int</B> <B>columns);</B>
16
17
18 </PRE>
19 <H2>DESCRIPTION</H2><PRE>
20        The  <B>wresize</B>  function  reallocates storage for an <B>ncurses</B>
21        window to adjust its dimensions to the  specified  values.
22        If either dimension is larger than the current values, the
23        window's data is filled with blanks that have the  current
24        background  rendition  (as  set  by <B>wbkgndset</B>) merged into
25        them.
26
27
28 </PRE>
29 <H2>RETURN VALUE</H2><PRE>
30        The function returns the integer <B>ERR</B> upon failure  and  <B>OK</B>
31        on success.  It will fail if either of the dimensions less
32        than or equal  to  zero,  or  if  an  error  occurs  while
33        (re)allocating memory for the window.
34
35
36 </PRE>
37 <H2>NOTES</H2><PRE>
38        The only restriction placed on the dimensions is that they
39        be greater than zero.  The dimensions are not compared  to
40        <B>curses</B>   screen   dimensions  to  simplify  the  logic  of
41        <B>resizeterm</B>.  The caller  must  ensure  that  the  window's
42        dimensions fit within the actual screen dimensions.
43
44
45 </PRE>
46 <H2>SEE ALSO</H2><PRE>
47        <B><A HREF="resizeterm.3x.html">resizeterm(3x)</A></B>.
48
49
50 </PRE>
51 <H2>AUTHOR</H2><PRE>
52        Thomas Dickey (from an equivalent function written in 1988
53        for BSD curses).
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73 </PRE>
74 <HR>
75 <ADDRESS>
76 Man(1) output converted with
77 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
78 </ADDRESS>
79 </BODY>
80 </HTML>