OSDestroyHeap

C Specification

#include <revolution/os.h>
void* OSDestroyHeap (OSHeapHandle heap);

Arguments

heap The operating heap handle previously created with the OSCreateHeap function.

Return Values

None.

Description

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

Frees the descriptor for the heap region heap. Subsequent allocation requests from this heap will fail unless another heap with the same handle is created.

See Also

Memory Allocation Functions, OSCreateHeap

Revision History

2006/03/01 Initial version.

CONFIDENTIAL