ncurses 6.0 - patch 20170506
[ncurses.git] / doc / html / man / curs_memleaks.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 2008-2010,2017 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   * @Id: curs_memleaks.3x,v 1.4 2017/01/07 19:25:15 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_memleaks 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_memleaks 3x</H1>
42 <PRE>
43 <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>                                            <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>_nc_freeall</STRONG> <STRONG>_nc_free_and_exit</STRONG> - <STRONG>curses</STRONG> memory-leak checking
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
54
55        <STRONG>void</STRONG> <STRONG>_nc_freeall(void);</STRONG>
56        <STRONG>void</STRONG> <STRONG>_nc_free_and_exit(int);</STRONG>
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60        These  functions  are  used to simplify analysis of memory leaks in the
61        ncurses library.  They are normally not available; they must be config-
62        ured  into  the library at build time using the <STRONG>--disable-leaks</STRONG> option.
63        That compiles-in code that frees memory  that  normally  would  not  be
64        freed.
65
66        Any implementation of curses must not free the memory associated with a
67        screen, since (even after calling <STRONG>endwin</STRONG>), it must be available for use
68        in  the next call to <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG>.  There are also chunks of memory held
69        for performance reasons.  That makes it hard to analyze curses applica-
70        tions for memory leaks.  To work around this, one can build a debugging
71        version of the ncurses library which frees those chunks which  it  can,
72        and provides these functions to free all of the memory allocated by the
73        ncurses library.
74
75        The _nc_free_and_exit function is the preferred one since some  of  the
76        memory  which  is freed may be required for the application to continue
77        running.  Its parameter is the code to pass to the exit routine.
78
79
80 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
81        These functions do not return a value.
82
83
84 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
85        These functions are not part of the XSI interface.
86
87
88 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
89        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
90
91
92
93                                                              <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>
94 </PRE>
95 <div class="nav">
96 <ul>
97 <li><a href="#h2-NAME">NAME</a></li>
98 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
99 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
100 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
101 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
102 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
103 </ul>
104 </div>
105 </BODY>
106 </HTML>