SHNotificationRemove

  • Article

The SHNotificationRemove function removes a notification. This is usually in response to some action taken on the data that is outside of the notification system. For example, if a message is read or deleted and the notification becomes obsolete by means other than action taken from the notification bubble.

LRESULT SHNotificationRemove(
  const CLSID * pclsid, 
  DWORD dwID
);

Parameters

  • pclsid
    The class of the notification to remove.
  • dwID
    The unique identifier of the notification to remove. Do not set the value of this parameter to 0; that option is not implemented. If the value of this parameter is set to 0, the function will return an error.

Return Values

ERROR_SUCCESS indicates success.

Remarks

Notifications are normally removed when the user taps on a link in the notification bubble. This API only needs to be called when the notification needs to be removed because of external changes in state.

This function cannot be used for notifications that do not have a CLSID.

Requirements

Smartphone: Not Supported
Pocket PC: Windows Mobile 2002 and later
OS Versions: Windows CE 3.0 and later
Header: aygshell.h
Library: aygshell.lib

Send feedback on this topic to the authors.

© 2005 Microsoft Corporation. All rights reserved.