OS_DestroyHeap

構文

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

引数

id ヒープを破棄するアリーナ
heap 破棄するヒープのハンドル

返り値

なし。

説明

ヒープ領域を破棄します。

アリーナ id はアリーナID で指定します。この値については OS_InitArena() を参照してください。

OS_CreateHeap() で作成したヒープはもちろん、OS_CreateExtraHeap() で作成した特殊ヒープも本関数で破棄することが可能です。

本関数で破棄したヒープに対して OS_AllocFromHeap() 等で領域を確保しようとすると、DEBUG ビルドの場合はアサートで停止します。RELEASE/FINALROM ビルドの場合は NULL を返します。

参照

OS_CreateHeap, OS_AllocFromHeap
OS_CreateExtraHeap

履歴

2009/04/03 特殊ヒープに対しても使用できることを追記
2004/01/06 初版