API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

ISHELL_CANCELTIMER()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IShell ISHELL_SetTimer, ISHELL_GetTimerExpiration PFNNOTIFY
Description
This function cancels a timer that has been set by ISHELL_SetTimer(). If pfn is non-NULL, the timer associated with pfn and pUser is canceled. If pfn is NULL, all timers associated with pUser are canceled. A call with pfn=NULL and pUser=NULL will cancel all timers set by the calling applet.
Params
pIShell
[]:
Pointer to the IShell interface object.
pfn
[]:
User callback.
pUser
[]:
User data.
Interface
  • ISHELL
Prototype
  •     int ISHELL_CancelTimer(IShell * pIShell, PFNNOTIFY pfn, void * pUser);
    
Return
  • AEE_SUCCESS : always.
Side Effect
  • None
Comments
Attempting to cancel timers that have not been set is harmless. Attemping to call ISHELL_CancelTimer with pfn=NULL and pUser=NULL in system context will result in no timers being canceled.