# OS_GetLockID

## 構文

      #include <nitro/os.h>

      s32 OS_GetLockID( void );

## 引数

なし。

## 返り値

使用されていない ID です。
OS_LOCK_ID_ERROR ならばエラーです。
ID自体はu16 データですが、エラーを検出するために返り値は s32 型となっています。

## 説明

使用されていないID を取得します。
OS_Lock* 関数でIDが重ならないようにするためにこの関数でIDを取得します。

使用されていないIDがあれば、ARM9の環境では、0x40〜0x6F、ARM7では0x80〜0xAF の範囲で取得することが出来ます。いずれのプロセッサでも、IDの取得に失敗した場合(空きがない場合が考えられます)、OS_LOCK_ID_ERROR が返ります。なお、この値は負数です。

ID が不要になったら、`OS_ReleaseLockID()` で開放してください。開放するまでは`OS_GetLockID()`でそのID値を返すことはありません。

## 参照

`OS_ReleaseLockID
`

## 履歴

2008/11/06 ARM9で取得できる値の範囲を修正
2004/07/22 IDがu16であることを記述
2004/06/21 初版