# NNS_FndRecordStateForFrmHeap

## 構文

      #include <nnsys/fnd.h>

      BOOL NNS_FndRecordStateForFrmHeap(NNSFndHeapHandle heap, u32 tagName);

## 引数

heap | フレームヒープのハンドル
tagName | 状態記録に付けるタグ

## 返り値

状態を記録できた場合は TRUEを返します。状態出来なかった場合は FALSE を返します。

## 説明

フレームヒープの現在のメモリ使用状態を記録します。後でNNS_FndFreeByStateToFrmHeap()関数を呼び出すことで、記録したメモリ使用状況に戻すことができます。

状態の記録にはタグを付けることができます。タグを付ける場合はtagNameに0以外の値をセットします。tagNameが0の場合はタグは付加されません。また、既に存在する状態記録と同じタグ値を指定してもエラーにはなりません。NNS_FndFreeByStateToFrmHeap()関数を使用するときに引数で指定したタグ値が複数の状態記録で使われている場合は、同じタグ値を持つ状態記録の中で最も後に記録された状態記録が使われます。

状態を記録するために、空き領域の前方より数バイト使用します。記録する分のメモリを確保できなかった場合は、関数は失敗します。

## 参照

`NNS_FndFreeByStateToFrmHeap
`

## 履歴

2004/10/15 タグについての解説を追加した。
2004/04/01 初版