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

Developer

API Reference

ISHELL_NOTIFY()

Brew Release
Brew MP 1.0.2
See Also
AEEEvent Error Codes Events IShell ISHELL_RegisterNotify()
Description
This function is called by an object when it detects an event that may be associated with a notification requested by another class of object. For example, the INetMgr Interface calls this function when INetMgr-related events occur. The result is that any applets that have requested notification, whether actively loaded or not, are sent the EVT_NOTIFY with data about the specific event. The notification mask indicates which event occurred. The data pointer provided is specific to the mask of the event that occurred and is defined by the class that triggered the notification. All registered applets for a specific type of notification are called. If the applet is not currently active, it is loaded and the event is sent to it. It is not sent the EVT_APP_START or EVT_APP_STOP events under these conditions. If the applet is to start based on the event, it must call ISHELL_StartApplet().
Params
pIShell
[]:
Pointer to the IShell interface object.
clsType
[]:
The class that issued the notification.
dwMask
[]:
A mask of events in which typically only 1 bit is set for any given event.
pData
[]:
Context-sensitive data.
Interface
  • ISHELL
Prototype
  •     int ISHELL_Notify
        (
        IShell * pIShell,
        AEECLSID clsType,
        uint32 dwMask,
        void * pData
        );
    
Return
  • AEE_SUCCESS: If successful.
    AEE_EBADCLASS: Invalid ClassID.
    AEE_EBADPARM: Invalid parameter.
    AEE_EREENTERED: An attempt to re-enter ISHELL_Notify(). If a call to ISHELL_Notify() is made from within a current notification (for example, calling ISHELL_Notify() from within the EVT_NOTIFY event handler of the applet), this problem will occur.
    AEE_EBADTASK: Invalid task issuing notify.
    AEE_EFAILED: The operation failed.
Side Effect
  • Any applets that have requested notification, whether actively loaded or not, are sent the EVT_NOTIFY with data about the specific event.
Comments
None