Home / Autodocs / icon.library
NAME
- FreeFree
-
free memory tracked by a free list (V44).
SYNOPSIS
found = FreeFree( free, memory )
BOOL FreeFree(struct FreeList *, APTR);
A0 A1
FUNCTION
This routine is the counterpart to FreeAlloc(). Unlike FreeFreeList(), which releases all the memory allocated in the tracking list, only a single entry is deallocated.
INPUTS
- free
-
a pointer to a FreeList structure
- memory
-
pointer to the memory chunk to be deallocated; it is safe to pass NULL or the address of a memory chunk which is not even part of the FreeList
RESULT
- found
-
TRUE if the memory chunk was found in the FreeList and could be released, FALSE otherwise. The result code was introduced in V46; older library implementations will not return any meaningful result
NOTES
This function was implemented in all icon.library versions starting with V44. However, it was never documented.
Deallocating single chunks is an expensive operation owing to the design of the FreeList data structure. It takes time to search for the right list entry to be deallocated, and when the deallocation is performed, an used memory tracking slot will remain that will be deallocated until FreeFreeList() is called.
Calling FreeFreeList() and calling FreeFree() for every memory chunk tracked is not equivalent! As part of the memory tracking process additional memory is allocated for every memory chunk which can be freed only by calling FreeFreeList().
Deallocating single chunks is an expensive operation owing to the design of the FreeList data structure. It takes time to search for the right list entry to be deallocated, and when the deallocation is performed, an used memory tracking slot will remain that will be deallocated until FreeFreeList() is called.
Calling FreeFreeList() and calling FreeFree() for every memory chunk tracked is not equivalent! As part of the memory tracking process additional memory is allocated for every memory chunk which can be freed only by calling FreeFreeList().
BUGS
This function name is not particularly meaningful...