File: lbRegister.3

package info (click to toggle)
leakbug 0.1.5-3
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 1,120 kB
  • ctags: 80
  • sloc: sh: 6,935; ansic: 380; makefile: 137
file content (65 lines) | stat: -rw-r--r-- 1,862 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
.\"
.\" $Id: lbRegister.3,v 1.2 2001/12/31 09:16:07 chipx86 Exp $
.\"
.\" Copyright (C) 1999-2002 The GNUpdate Project.
.\"
.\" This library is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU Library General Public
.\" License as published by the Free Software Foundation; either
.\" version 2 of the License, or (at your option) any later version.
.\"
.\" This library is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
.\" Library General Public License for more details.
.\"
.\" You should have received a copy of the GNU Library General Public
.\" License along with this library; if not, write to the
.\" Free Software Foundation, Inc., 59 Temple Place - Suite 330,
.\" Boston, MA  02111-1307, USA.
.\"
.TH "lbRegister" 3 "12 Jul 2001" "leakbug"
.SH "NAME"
lbRegister \- Registers memory for leakbug to keep track of.
.SH "SYNOPSIS"
.ft B
#include <leakbug.h>
.sp
void *lbRegister(void *ptr, unsigned int dataSize, const char *filename, int line, int debug_level);
.ft R
.SH "PARAMETERS"
.TP
.B "ptr"
The pointer to register.
.TP
.B "dataSize"
The size of the data.
.TP
.B "filename"
The calling filename.
.TP
.B "line"
The calling line number.
.TP
.B "debug_level"
The debug level.
.SH "DESCRIPTION"
This is used to register any memory not automatically handled by
leakbug. This is useful when leakbug dumps "Freeing unknown memory"
warnings in your program.
.sp
.ft B
 #ifdef WITH_LEAKBUG
   #include <leakbug.h>
   #define LB_REGISTER(ptr, dataSize) \\
      lbRegister((ptr), (dataSize), __FILE__, __LINE__, \\
                 LEAKBUG_DEBUG_LEVEL)
 #else
   #define LB_REGISTER(ptr, dataSize)
 #endif
.ft R
.SH "RETURNS"
The pointer passed.
.SH "SEE ALSO"
lbRegisterArray(3)