ISideShowContentManager::RemoveAll Method

Article
11/02/2006

Removes all items of content from the caches of the Windows SideShow devices associated with this Windows SideShow gadget.

Declaration

[C++]

HRESULT RemoveAll();

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 no Windows SideShow devices are associated with this Windows SideShow gadget, or content removal failed for at least one connected device.
E_FAIL	The Windows SideShow platform is not properly initialized.

Remarks

Calling this method removes all content associated with this Windows SideShow gadget from the caches of the associated devices, if any.

Example

This example demonstrates how Windows SideShow gadgets can remove all previously added content.

[C++]

HRESULT hr;

//
// Call RemoveAll using a previously established pointer to the
// ContentManager object. Also, check for failure.
//
hr = pISideShowContentManager->RemoveAll();

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

Applies To

ISideShowContentManager