OS_SetOneTimeVAlarm

C Specification

#include <nitro/os.h>
void OS_SetOneTimeVAlarm(
OSVAlarm*           alarm ,
s16                 count ,
OSVAlarmHandler     handler ,
void*           arg );
  

Arguments

alarm Pointer to the V count alarm structure for setting V count alarm
count The V Count value at which the V Count alarm is actuated (the handler is called)
handler The V count alarm handler
arg The argument when calling the V count alarm handler

Return Values

None.

Description

This function configures a one-shot V count alarm. It is meant to give compatibility with OS_SetVAlarm() prior to NITRO-SDK 2.0 RC1.

In the old format of OS_SetVAlarm(), the function took four arguments (the pointer to the alarm structure, the V count, the handler, and the handler's argument). Now that the delay value can be specified, the function has five arguments. For this reason, the OS_SetOneTimeVAlarm() function has been prepared for times when you want to configure the V alarm with the old-format arguments. Although this function does not have the delay argument, it operates internally as if delay = 10.

OS_SetOneTimeVAlarm( alarm, count, handler, arg );

is the inline version of

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

 

For more details, see OS_SetVAlarm() or OS_InitVAlarm().

See Also

OS_InitVAlarm, OS_SetVAlarm

Revision History

10/22/2004 Initial Version