Developer

API Reference

IPROTEST_SetAlarm()

deprecated
Items marked as deprecated have been replaced by a more powerful, alternative feature. Deprecated interfaces include a reference to the replacement interface, which should be used for all new application development. Deprecated features are still supported for backward compatibility, but should be avoided when developing new applications.
Brew Release
Brew MP 1.0.2
See Also
IProtest IPROTEST_CancelAlarm()
Description
On release builds & by default on debug builds this call will be mapped directly onto ISHELL_SetAlarm, using the applet ID of the protest client. However if time is 'controlled' by the protest framework an alternative scheduler will be used instead.
Parameters
  • pIShell
    []:
    Pointer to the IShell Interface object.
  • nUserCode
    []:
    16-bit code passed to the applet.
  • nMins
    []:
    Number of minutes to set the alarm from the current time.
Interface
IPROTEST
Prototype
    int IPROTEST_SetAlarm
    (
    IShell * pIShell,
    uint16 nUserCode,
    uint32 nMins
    )
Return
    SUCCESS :   if successful.
    EBADPARM :  invalid parameter.
    ENOMEMORY : insufficient memory.
Comment
None
  • Follow