ISideShowNotificationManager::RevokeAll Method

Article
11/02/2006

Revokes all active notifications.

Declaration

[C++]

HRESULT RevokeAll();

Parameters

None.

Return Values

Possible values include, but are not limited to, those in the following table.

HRESULT value	Description
S_OK	Success.
S_FALSE	Either there are no Windows SideShow-compatible devices associated with this gadget, or notification revocation failed for at least one connected device.
E_FAIL	The Windows SideShow platform is not properly initialized.

Remarks

Some Windows SideShow-compatible devices may not support notifications. Calling this method does not affect such devices.

Example

This example demonstrates how Windows SideShow gadgets can revoke all previously shown notifications.

[C++]

HRESULT hr;

//
// Call RevokeAll using a previously established pointer to the
// NotificationManager object. Also, check for failure.
//
hr = pISideShowNotificationManager->RevokeAll();

if (FAILED(hr))
{
    //
    // Handling of failures will be application-specific.
    //
    HandleFailure("RevokeAll", hr);
}

Applies To

ISideShowNotificationManager