# OS_GetMaxFreeSize

## 構文

      #include <nitro/os.h>

      u32 OS_GetMaxFreeSize( OSArenaId id, OSHeapHandle heap );

## 引数

id | 最大サイズを取得するヒープが含まれるアリーナのアリーナID
heap | 最大サイズを取得するヒープのヒープハンドル

## 返り値

ヒープの中の最大フリーブロックのサイズ(バイト)です。

## 説明

ヒープの中のフリーブロックのうち、最大のもののサイズを取得します。

heap に OS_CURRENT_HEAP_HANDLE を指定すると、カレントヒープを指定したことになります。

フリーブロックのヘッダはサイズに含めません。フリーブロックのデータ領域のサイズとなります。

すべてのフリーブロックを辿って計算を行なうので、所要時間はメモリブロックの量に比例します。

## 参照

`OS_InitAlloc, OS_GetTotalAllocSize, OS_GetTotalFreeSize`

## 履歴

2004/11/05 初版