ncurses 5.7 - patch 20100109
[ncurses.git] / doc / html / man / curs_memleaks.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 2008 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   * @Id: curs_memleaks.3x,v 1.1 2008/10/25 23:38:13 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_memleaks 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>curs_memleaks 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
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>
49 <H2>NAME</H2><PRE>
50        <STRONG>_nc_freeall</STRONG> <STRONG>_nc_free_and_exit</STRONG> - <STRONG>curses</STRONG> memory-leak
51        checking
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>void</STRONG> <STRONG>_nc_freeall(void);</STRONG>
59        <STRONG>void</STRONG> <STRONG>_nc_free_and_exit(int);</STRONG>
60
61
62 </PRE>
63 <H2>DESCRIPTION</H2><PRE>
64        These functions are used to simplify  analysis  of  memory
65        leaks  in  the  ncurses  library.   They  are normally not
66        available; they must be configured  into  the  library  at
67        build  time  using  the <STRONG>--disable-leaks</STRONG> option.  That com-
68        piles-in code that frees memory that normally would not be
69        freed.
70
71        Any  implementation of curses must not free the memory as-
72        sociated with a screen, since (even after calling <STRONG>endwin</STRONG>),
73        it  must be available for use in the next call to <STRONG>refresh</STRONG>.
74        There are also chunks of memory held for performance  rea-
75        sons.   That  makes it hard to analyze curses applications
76        for memory leaks.  To work around this, one  can  build  a
77        debugging version of the ncurses library which frees those
78        chunks which it can, and provides these functions to  free
79        all of the memory allocated by the ncurses library.
80
81        The  _nc_free_and_exit function is the preferred one since
82        some of the memory which is freed may be required for  the
83        application  to  continue  running.   Its parameter is the
84        code to pass to the exit routine.
85
86
87 </PRE>
88 <H2>RETURN VALUE</H2><PRE>
89        These functions do not return a value.
90
91
92 </PRE>
93 <H2>PORTABILITY</H2><PRE>
94        These functions are not part of the XSI interface.
95
96
97 </PRE>
98 <H2>SEE ALSO</H2><PRE>
99        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
100
101
102
103                                                       <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>
104 </PRE>
105 <HR>
106 <ADDRESS>
107 Man(1) output converted with
108 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
109 </ADDRESS>
110 </BODY>
111 </HTML>