OS_SetCurrentHeap

Syntax

#include <nitro/os.h>
OSHeapHandle OS_SetCurrentHeap( OSArenaId id, OSHeapHandle heap );

Arguments

id The arena ID of the arena in which you will set a current heap.
heap The handle of the heap to set as the current heap.

Return Values

The handle of the heap that was the previous current heap.

Description

Sets the current heap.

A current heap exists in each arena. This function only sets the current heap in the specified arena. The arena is specified with the arena ID (id). To read more about this value, see OS_InitArena.

See Also

OS_InitArena, OS_InitAlloc, OS_CreateHeap

Revision History

2004/01/06 Initial version.

CONFIDENTIAL