Carbon


PurgeSpace

Header: MacMemory.h Carbon status: Supported

Determines the total amount of free memory and the size of the largest allocatable block in the current heap zone if it were purged.

void PurgeSpace (
    SInt32 *total, 
    SInt32 *contig
);
total

On return, the total amount of free memory, in bytes, in the current heap zone if it were purged. This amount includes space that is already free.

contig

On return, the size of the largest contiguous block of free memory in the current heap zone if it were purged.

DISCUSSION

The PurgeSpace function does not actually purge the current heap zone.

Call the function MemError to get the result code. See “Result Codes”.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/6/2000)