OS_CancelAlarm

構文

#include <nitro/os.h>
void OS_CancelAlarm( OSAlarm* alarm );
  

引数

alarm キャンセルするアラーム構造体へのポインタ

返り値

なし。

説明

アラームを取り消します。
取り消したのち、そのアラーム構造体は別のアラームに使用することが出来ます。

OS_SetPeriodicAlarm() で起動された周期アラームが、アラームハンドルの中で自分自身をキャンセルすることも可能です。

参照

OS_InitAlarm, OS_CancelAlarms, OS_CancelAllAlarms, OS_SetPeriodicAlarm

履歴

2004/03/22 周期アラームが自身をキャンセルすることについて記述追加
2004/02/04 初版