OSCheckHeap

Syntax

#include <revolution/os.h>

long OSCheckHeap(OSHeapHandle heap);

Arguments

heap Active heap handle.

Return Values

Returns -1 if the heap is inconsistent. Otherwise, the number of bytes that a free list can use.

Description

Although this function is provided for the sake of compatibility, we recommend using the MEM library.

Checks the heap region heap for validity for debugging.

See Also

Memory Allocation Functions, OSDumpHeap, OSInitAlloc

Revision History

2006/03/01 Initial version.


CONFIDENTIAL