53 lines
1.5 KiB
Groff
53 lines
1.5 KiB
Groff
'\"
|
|
'\" Copyright (c) 1995-1996 Sun Microsystems, Inc.
|
|
'\"
|
|
'\" See the file "license.terms" for information on usage and redistribution
|
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
|
'\"
|
|
'\" SCCS: @(#) Alloc.3 1.2 96/06/05 18:00:19
|
|
'\"
|
|
.so man.macros
|
|
.TH Tcl_Alloc 3 7.5 Tcl "Tcl Library Procedures"
|
|
.BS
|
|
.SH NAME
|
|
Tcl_Alloc, Tcl_Free, Tcl_Realloc \- allocate or free heap memory
|
|
.SH SYNOPSIS
|
|
.nf
|
|
\fB#include <tcl.h>\fR
|
|
.sp
|
|
char *
|
|
\fBTcl_Alloc\fR(\fIsize\fR)
|
|
.sp
|
|
\fBTcl_Free\fR(\fIptr\fR)
|
|
.sp
|
|
char *
|
|
\fBTcl_Realloc\fR(\fIptr, size\fR)
|
|
.SH ARGUMENTS
|
|
.AS char *size
|
|
.AP int size in
|
|
Size in bytes of the memory block to allocate.
|
|
.AP char *ptr in
|
|
Pointer to memory block to free or realloc.
|
|
.BE
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
These procedures provide a platform and compiler independent interface
|
|
for memory allocation. Programs that need to transfer ownership of
|
|
memory blocks between Tcl and other modules should use these routines
|
|
rather than the native \fBmalloc()\fR and \fBfree()\fR routines
|
|
provided by the C run-time library.
|
|
.PP
|
|
\fBTcl_Alloc\fR returns a pointer to a block of at least \fIsize\fR
|
|
bytes suitably aligned for any use.
|
|
.PP
|
|
\fBTcl_Free\fR makes the space referred to by \fIptr\fR available for
|
|
further allocation.
|
|
.PP
|
|
\fBTcl_Realloc\fR changes the size of the block pointed to by
|
|
\fIptr\fR to \fIsize\fR bytes and returns a pointer to the new block.
|
|
The contents will be unchanged up to the lesser of the new and old
|
|
sizes. The returned location may be different from \fIptr\fR.
|
|
.SH KEYWORDS
|
|
alloc, allocation, free, malloc, memory, realloc
|