50537aef348158a33c3ebfc2005e5e6a5d4a8fbe
[ncurses.git] / man / wresize.3x
1 .\"*****************************************************************************
2 .\" Copyright 1996 by Thomas E. Dickey <dickey@clark.net>                      *
3 .\" All Rights Reserved.                                                       *
4 .\"                                                                            *
5 .\" Permission to use, copy, modify, and distribute this software and its      *
6 .\" documentation for any purpose and without fee is hereby granted, provided  *
7 .\" that the above copyright notice appear in all copies and that both that    *
8 .\" copyright notice and this permission notice appear in supporting           *
9 .\" documentation, and that the name of the above listed copyright holder(s)   *
10 .\" not be used in advertising or publicity pertaining to distribution of the  *
11 .\" software without specific, written prior permission. THE ABOVE LISTED      *
12 .\" COPYRIGHT HOLDER(S) DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,  *
13 .\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO     *
14 .\" EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR ANY         *
15 .\" SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER       *
16 .\" RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF       *
17 .\" CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN        *
18 .\" CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.                   *
19 .\"*****************************************************************************
20 .\" $Id: wresize.3x,v 1.2 1996/09/07 14:51:04 tom Exp $
21 .TH wresize 3X ""
22 .
23 .SH NAME
24 \fBwresize\fR - resize a curses window
25 .
26 .SH SYNOPSIS
27 \fB#include <curses.h>\fR
28
29 \fBint wresize(WINDOW *win, int lines, int columns);\fR
30 .
31 .SH DESCRIPTION
32 The \fBwresize\fR function reallocates storage for an \fBncurses\fR
33 window to adjust its dimensions to the specified values.
34 If either dimension is larger than the current values, the
35 window's data is filled with blanks that have the current background rendition
36 (as set by \fBwbkgndset\fR) merged into them.
37 .
38 .SH RETURN VALUE
39 The function returns the integer \fBERR\fR upon failure and \fBOK\fR on success.
40 It will fail if either of the dimensions less than or equal to zero,
41 or if an error occurs while (re)allocating memory for the window.
42 .
43 .SH NOTES
44 The only restriction placed on the dimensions is that they be greater than zero.
45 The dimensions are not compared to \fBcurses\fR screen dimensions to
46 simplify the logic of \fBresizeterm\fR.
47 The caller must ensure that the window's dimensions fit within the
48 actual screen dimensions.
49 .
50 .SH SEE ALSO
51 \fBresizeterm\fR(3x).
52 .
53 .SH AUTHOR
54 Thomas Dickey (from an equivalent function written in 1988 for BSD curses).
55 .\"#
56 .\"# The following sets edit modes for GNU EMACS
57 .\"# Local Variables:
58 .\"# mode:nroff
59 .\"# fill-column:79
60 .\"# End: