diff options
| author | oehhar <harald.oehlmann@elmicron.de> | 2021-04-16 11:48:02 (GMT) |
|---|---|---|
| committer | oehhar <harald.oehlmann@elmicron.de> | 2021-04-16 11:48:02 (GMT) |
| commit | 8ba69750a3d5b3706fb03205f59a64e6c7539663 (patch) | |
| tree | c42db59de4d866450f8acb55223941914cbec599 /doc/Alloc.3 | |
| parent | a6a4abe085d5550416716aed452c318d35f9a2d3 (diff) | |
| download | tcl-8ba69750a3d5b3706fb03205f59a64e6c7539663.zip tcl-8ba69750a3d5b3706fb03205f59a64e6c7539663.tar.gz tcl-8ba69750a3d5b3706fb03205f59a64e6c7539663.tar.bz2 | |
TIP596: Document Tcl_MainEx, Tcl_MainExW, Tcl_GetMemoryInfo, Tcl_SetPreInitScript
Diffstat (limited to 'doc/Alloc.3')
| -rw-r--r-- | doc/Alloc.3 | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/Alloc.3 b/doc/Alloc.3 index 849f65e..c3c3f11 100644 --- a/doc/Alloc.3 +++ b/doc/Alloc.3 @@ -4,11 +4,11 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -.TH Tcl_Alloc 3 7.5 Tcl "Tcl Library Procedures" +.TH Tcl_Alloc 3 9.0 Tcl "Tcl Library Procedures" .so man.macros .BS .SH NAME -Tcl_Alloc, Tcl_Free, Tcl_Realloc, Tcl_AttemptAlloc, Tcl_AttemptRealloc \- allocate or free heap memory +Tcl_Alloc, Tcl_Free, Tcl_Realloc, Tcl_AttemptAlloc, Tcl_AttemptRealloc, Tcl_GetMemoryInfo \- allocate or free heap memory .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -27,12 +27,17 @@ void * .sp void * \fBTcl_AttemptRealloc\fR(\fIptr, size\fR) +.sp +void +\fBTcl_GetMemoryInfo\fR(\fIdsPtr\fR) .SH ARGUMENTS .AS char *size .AP "unsigned int" size in Size in bytes of the memory block to allocate. .AP char *ptr in Pointer to memory block to free or realloc. +.AP Tcl_DString *dsPtr in +Initialized DString pointer. .BE .SH DESCRIPTION @@ -69,5 +74,9 @@ the procedures \fBTcl_Alloc\fR, \fBTcl_Free\fR, \fBTcl_Realloc\fR, \fBTcl_AttemptAlloc\fR, and \fBTcl_AttempRealloc\fR are implemented as macros, redefined to be special debugging versions of these procedures. +\fBTcl_GetMemoryInfo\fR appends a list-of-lists of memory stats to the provided DString. +This procedure may be called when the TCL library is included within an embedded application. +The stubs table must be first initialized using one of \fBTcl_InitSubsystems\fR, \fBTcl_SetPanicProc\fR, \fBTcl_FindExecutable\fR or \fBTclZipfs_AppHook\fR. + .SH KEYWORDS alloc, allocation, free, malloc, memory, realloc, TCL_MEM_DEBUG |