MEMFreeToDefaultHeap

Syntax

#include <cafe/mem.h>

typedef void (*pfMEMFreeToDefaultHeap)(void* memBlock);

extern pfMEMFreeToDefaultHeap  MEMFreeToDefaultHeap;

Parameters

memBlock Pointer to the memory block to deallocate.

Return Values

None.

Description

MEMFreeToDefaultHeap points to a function that frees a block of memory back to the default heap, performing nothing if memBlock is NULL.

Cafe OS provides a default implementation of the underlying function and initializes MEMFreeToDefaultHeap to point to it. An alternate implementation can be provided, as described in Customize Memory Management.

Do Not Call From

Callbacks Do not call this function from any callback function.

See Also

MEMAllocFromDefaultHeap
MEMAllocFromDefaultHeapEx
MEMCreateUserHeapHandle

Revision History

2014/02/28 Remove unused MEMInitDefaultHeap.
2013/06/20 Correctly describe how substitute an alternate implementation.
2013/05/08 Automated cleanup pass.
2010/11/01 Initial version.


CONFIDENTIAL