OS_SetOneTimeVAlarm

構文

#include <nitro/os.h>

void OS_SetOneTimeVAlarm(
             OSVAlarm*       alarm,
             s16             count,
             OSVAlarmHandler handler,
             void*           arg );

引数

alarm	Vカウントアラームを設定するVカウントアラーム構造体へのポインタ
count	Vカウントアラームが発動する(handler が呼ばれる)Vカウント値
handler	Vカウントアラームハンドラ
arg	Vカウントアラームハンドラが呼ばれるときの引数

返り値

なし。

説明

ワンショットのVカウントアラームを設定します。
この関数は、NITRO-SDK 2.0 RC1 以前の OS_SetVAlarm() と互換を取るための関数です。

旧形式の OS_SetVAlarm() はアラーム構造体ポインタ、Vカウント、ハンドラ、ハンドラ引数の 4引数を取る関数でしたが、現在はさらに delay 値を指定できるように 5引数関数になっています。そこで、旧形式の引数で Vアラーム設定を行ないたい場合のためにこの OS_SetOneTimeVAlarm() が用意されています。delay が引数になかったとはいっても、内部では delay=10 として扱っていましたので、

OS_SetOneTimeVAlarm( alarm, count, handler, arg );

は、

OS_SetVAlarm( alarm, count, 10, handler, arg );

の inline となっています。

詳細は OS_SetVAlarm() 、あるいは OS_InitVAlarm() を参照してください。

参照

OS_InitVAlarm, OS_SetVAlarm

履歴

2004/10/22 初版