OSWaitAlarm

Syntax

#include <cafe/os.h>

BOOL OSWaitAlarm(OSAlarm* alarm);

Parameters

alarm OSAlarm structure to wait for.

Return Values

If the alarm is expired, returns TRUE. If the alarm is canceled, returns FALSE.

Description

Waits either for the specified OSAlarm to expire or for the alarm to be canceled.

Do Not Call From

Callbacks Do not call this function from any callback function.

See Also

OSSetAlarm
OSSetPeriodicAlarm
OSCancelAlarm
OSCancelAlarms

Revision History

2013/05/08 Automated cleanup pass.
2012/07/25 Cleanup pass.
2010/12/15 Initial version.


CONFIDENTIAL