LocalCompact

Syntax

WORD LocalCompact(wMinFree)

This function generates the number of free bytes of memory specified by the wMinFree parameter by compacting, if necessary, the module's local heap. The function checks the local heap for the specified number of contiguous free bytes. If the bytes do not exist, the LocalCompact function compacts local memory by first moving all unlocked move-able blocks into high memory. If this does not generate the requested amount of space, the function discards moveable and discardable blocks that are not locked down, until the requested amount of space is generated, whenever possible.

Parameter Type/Description  

wMinFree WORD Specifies the number of free bytes desired. If wMinFree is zero, the function returns a value but does not compact memory.  

Return Value

The return value specifies the number of bytes in the largest block of free local memory.