ncurses 6.0 - patch 20170401
[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
50        checking
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>void</STRONG> <STRONG>_nc_freeall(void);</STRONG>
57        <STRONG>void</STRONG> <STRONG>_nc_free_and_exit(int);</STRONG>
58
59
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61        These functions are used to simplify  analysis  of  memory
62        leaks  in  the  ncurses  library.   They  are normally not
63        available; they must be configured  into  the  library  at
64        build  time  using  the <STRONG>--disable-leaks</STRONG> option.  That com-
65        piles-in code that frees memory that normally would not be
66        freed.
67
68        Any  implementation of curses must not free the memory as-
69        sociated with a screen, since (even after calling <STRONG>endwin</STRONG>),
70        it  must  be  available  for  use  in the next call to <STRONG>re-</STRONG>
71        <STRONG><A HREF="refresh.3x.html">fresh(3x)</A></STRONG>.  There are also chunks of memory held for  per-
72        formance  reasons.   That  makes it hard to analyze curses
73        applications for memory leaks.  To work around  this,  one
74        can build a debugging version of the ncurses library which
75        frees those chunks which it can, and provides these  func-
76        tions  to  free all of the memory allocated by the ncurses
77        library.
78
79        The _nc_free_and_exit function is the preferred one  since
80        some  of the memory which is freed may be required for the
81        application to continue running.   Its  parameter  is  the
82        code to pass to the exit routine.
83
84
85 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
86        These functions do not return a value.
87
88
89 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
90        These functions are not part of the XSI interface.
91
92
93 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
94        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
95
96
97
98                                                       <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>
99 </PRE>
100 <div class="nav">
101 <ul>
102 <li><a href="#h2-NAME">NAME</a></li>
103 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
104 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
105 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
106 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
107 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
108 </ul>
109 </div>
110 </BODY>
111 </HTML>